d7d003a3061c93ab3677d42297c033a08a0fa99e
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into 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.83"
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 &%-MCD%&
3815 .oindex "&%-MCD%&"
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
3818 remote host supports the ESMTP &_DSN_& extension.
3819
3820 .vitem &%-MCP%&
3821 .oindex "&%-MCP%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3824 which Exim is connected supports pipelining.
3825
3826 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3827 .oindex "&%-MCQ%&"
3828 This option is not intended for use by external callers. It is used internally
3829 by Exim in conjunction with the &%-MC%& option when the original delivery was
3830 started by a queue runner. It passes on the process id of the queue runner,
3831 together with the file descriptor number of an open pipe. Closure of the pipe
3832 signals the final completion of the sequence of processes that are passing
3833 messages through the same SMTP connection.
3834
3835 .vitem &%-MCS%&
3836 .oindex "&%-MCS%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3839 SMTP SIZE option should be used on messages delivered down the existing
3840 connection.
3841
3842 .vitem &%-MCT%&
3843 .oindex "&%-MCT%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3846 host to which Exim is connected supports TLS encryption.
3847
3848 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3849 .oindex "&%-Mc%&"
3850 .cindex "hints database" "not overridden by &%-Mc%&"
3851 .cindex "delivery" "manually started &-- not forced"
3852 This option requests Exim to run a delivery attempt on each message in turn,
3853 but unlike the &%-M%& option, it does check for retry hints, and respects any
3854 that are found. This option is not very useful to external callers. It is
3855 provided mainly for internal use by Exim when it needs to re-invoke itself in
3856 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3857 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3858 respects retry times and other options such as &%hold_domains%& that are
3859 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3860 If you want to run a specific delivery as if in a queue run, you should use
3861 &%-q%& with a message id argument. A distinction between queue run deliveries
3862 and other deliveries is made in one or two places.
3863
3864 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3865 .oindex "&%-Mes%&"
3866 .cindex "message" "changing sender"
3867 .cindex "sender" "changing"
3868 This option requests Exim to change the sender address in the message to the
3869 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3870 &"edit sender"&). There must be exactly two arguments. The first argument must
3871 be a message id, and the second one an email address. However, if the message
3872 is active (in the middle of a delivery attempt), its status is not altered.
3873 This option can be used only by an admin user.
3874
3875 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3876 .oindex "&%-Mf%&"
3877 .cindex "freezing messages"
3878 .cindex "message" "manually freezing"
3879 This option requests Exim to mark each listed message as &"frozen"&. This
3880 prevents any delivery attempts taking place until the message is &"thawed"&,
3881 either manually or as a result of the &%auto_thaw%& configuration option.
3882 However, if any of the messages are active (in the middle of a delivery
3883 attempt), their status is not altered. This option can be used only by an admin
3884 user.
3885
3886 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3887 .oindex "&%-Mg%&"
3888 .cindex "giving up on messages"
3889 .cindex "message" "abandoning delivery attempts"
3890 .cindex "delivery" "abandoning further attempts"
3891 This option requests Exim to give up trying to deliver the listed messages,
3892 including any that are frozen. However, if any of the messages are active,
3893 their status is not altered. For non-bounce messages, a delivery error message
3894 is sent to the sender, containing the text &"cancelled by administrator"&.
3895 Bounce messages are just discarded. This option can be used only by an admin
3896 user.
3897
3898 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3899 .oindex "&%-Mmad%&"
3900 .cindex "delivery" "cancelling all"
3901 This option requests Exim to mark all the recipient addresses in the messages
3902 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3903 message is active (in the middle of a delivery attempt), its status is not
3904 altered. This option can be used only by an admin user.
3905
3906 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3907 .oindex "&%-Mmd%&"
3908 .cindex "delivery" "cancelling by address"
3909 .cindex "recipient" "removing"
3910 .cindex "removing recipients"
3911 This option requests Exim to mark the given addresses as already delivered
3912 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3913 the remaining ones must be email addresses. These are matched to recipient
3914 addresses in the message in a case-sensitive manner. If the message is active
3915 (in the middle of a delivery attempt), its status is not altered. This option
3916 can be used only by an admin user.
3917
3918 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3919 .oindex "&%-Mrm%&"
3920 .cindex "removing messages"
3921 .cindex "abandoning mail"
3922 .cindex "message" "manually discarding"
3923 This option requests Exim to remove the given messages from the queue. No
3924 bounce messages are sent; each message is simply forgotten. However, if any of
3925 the messages are active, their status is not altered. This option can be used
3926 only by an admin user or by the user who originally caused the message to be
3927 placed on the queue.
3928
3929 .vitem &%-Mset%&&~<&'message&~id'&>
3930 .oindex "&%-Mset%&
3931 .cindex "testing" "string expansion"
3932 .cindex "expansion" "testing"
3933 This option is useful only in conjunction with &%-be%& (that is, when testing
3934 string expansions). Exim loads the given message from its spool before doing
3935 the test expansions, thus setting message-specific variables such as
3936 &$message_size$& and the header variables. The &$recipients$& variable is made
3937 available. This feature is provided to make it easier to test expansions that
3938 make use of these variables. However, this option can be used only by an admin
3939 user. See also &%-bem%&.
3940
3941 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3942 .oindex "&%-Mt%&"
3943 .cindex "thawing messages"
3944 .cindex "unfreezing messages"
3945 .cindex "frozen messages" "thawing"
3946 .cindex "message" "thawing frozen"
3947 This option requests Exim to &"thaw"& any of the listed messages that are
3948 &"frozen"&, so that delivery attempts can resume. However, if any of the
3949 messages are active, their status is not altered. This option can be used only
3950 by an admin user.
3951
3952 .vitem &%-Mvb%&&~<&'message&~id'&>
3953 .oindex "&%-Mvb%&"
3954 .cindex "listing" "message body"
3955 .cindex "message" "listing body of"
3956 This option causes the contents of the message body (-D) spool file to be
3957 written to the standard output. This option can be used only by an admin user.
3958
3959 .vitem &%-Mvc%&&~<&'message&~id'&>
3960 .oindex "&%-Mvc%&"
3961 .cindex "message" "listing in RFC 2822 format"
3962 .cindex "listing" "message in RFC 2822 format"
3963 This option causes a copy of the complete message (header lines plus body) to
3964 be written to the standard output in RFC 2822 format. This option can be used
3965 only by an admin user.
3966
3967 .vitem &%-Mvh%&&~<&'message&~id'&>
3968 .oindex "&%-Mvh%&"
3969 .cindex "listing" "message headers"
3970 .cindex "header lines" "listing"
3971 .cindex "message" "listing header lines"
3972 This option causes the contents of the message headers (-H) spool file to be
3973 written to the standard output. This option can be used only by an admin user.
3974
3975 .vitem &%-Mvl%&&~<&'message&~id'&>
3976 .oindex "&%-Mvl%&"
3977 .cindex "listing" "message log"
3978 .cindex "message" "listing message log"
3979 This option causes the contents of the message log spool file to be written to
3980 the standard output. This option can be used only by an admin user.
3981
3982 .vitem &%-m%&
3983 .oindex "&%-m%&"
3984 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3985 treats it that way too.
3986
3987 .vitem &%-N%&
3988 .oindex "&%-N%&"
3989 .cindex "debugging" "&%-N%& option"
3990 .cindex "debugging" "suppressing delivery"
3991 This is a debugging option that inhibits delivery of a message at the transport
3992 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3993 it just doesn't actually transport the message, but instead behaves as if it
3994 had successfully done so. However, it does not make any updates to the retry
3995 database, and the log entries for deliveries are flagged with &"*>"& rather
3996 than &"=>"&.
3997
3998 Because &%-N%& discards any message to which it applies, only root or the Exim
3999 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4000 words, an ordinary user can use it only when supplying an incoming message to
4001 which it will apply. Although transportation never fails when &%-N%& is set, an
4002 address may be deferred because of a configuration problem on a transport, or a
4003 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4004 the message, and applies to any subsequent delivery attempts that may happen
4005 for that message.
4006
4007 .vitem &%-n%&
4008 .oindex "&%-n%&"
4009 This option is interpreted by Sendmail to mean &"no aliasing"&.
4010 For normal modes of operation, it is ignored by Exim.
4011 When combined with &%-bP%& it suppresses the name of an option from being output.
4012
4013 .vitem &%-O%&&~<&'data'&>
4014 .oindex "&%-O%&"
4015 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4016 Exim.
4017
4018 .vitem &%-oA%&&~<&'file&~name'&>
4019 .oindex "&%-oA%&"
4020 .cindex "Sendmail compatibility" "&%-oA%& option"
4021 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4022 alternative alias file name. Exim handles &%-bi%& differently; see the
4023 description above.
4024
4025 .vitem &%-oB%&&~<&'n'&>
4026 .oindex "&%-oB%&"
4027 .cindex "SMTP" "passed connection"
4028 .cindex "SMTP" "multiple deliveries"
4029 .cindex "multiple SMTP deliveries"
4030 This is a debugging option which limits the maximum number of messages that can
4031 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4032 transport. If <&'n'&> is omitted, the limit is set to 1.
4033
4034 .vitem &%-odb%&
4035 .oindex "&%-odb%&"
4036 .cindex "background delivery"
4037 .cindex "delivery" "in the background"
4038 This option applies to all modes in which Exim accepts incoming messages,
4039 including the listening daemon. It requests &"background"& delivery of such
4040 messages, which means that the accepting process automatically starts a
4041 delivery process for each message received, but does not wait for the delivery
4042 processes to finish.
4043
4044 When all the messages have been received, the reception process exits,
4045 leaving the delivery processes to finish in their own time. The standard output
4046 and error streams are closed at the start of each delivery process.
4047 This is the default action if none of the &%-od%& options are present.
4048
4049 If one of the queueing options in the configuration file
4050 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4051 overrides it if &%queue_only_override%& is set true, which is the default
4052 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4053
4054 .vitem &%-odf%&
4055 .oindex "&%-odf%&"
4056 .cindex "foreground delivery"
4057 .cindex "delivery" "in the foreground"
4058 This option requests &"foreground"& (synchronous) delivery when Exim has
4059 accepted a locally-generated message. (For the daemon it is exactly the same as
4060 &%-odb%&.) A delivery process is automatically started to deliver the message,
4061 and Exim waits for it to complete before proceeding.
4062
4063 The original Exim reception process does not finish until the delivery
4064 process for the final message has ended. The standard error stream is left open
4065 during deliveries.
4066
4067 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4068 false and one of the queueing options in the configuration file is in effect.
4069
4070 If there is a temporary delivery error during foreground delivery, the
4071 message is left on the queue for later delivery, and the original reception
4072 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4073 restricted configuration that never queues messages.
4074
4075
4076 .vitem &%-odi%&
4077 .oindex "&%-odi%&"
4078 This option is synonymous with &%-odf%&. It is provided for compatibility with
4079 Sendmail.
4080
4081 .vitem &%-odq%&
4082 .oindex "&%-odq%&"
4083 .cindex "non-immediate delivery"
4084 .cindex "delivery" "suppressing immediate"
4085 .cindex "queueing incoming messages"
4086 This option applies to all modes in which Exim accepts incoming messages,
4087 including the listening daemon. It specifies that the accepting process should
4088 not automatically start a delivery process for each message received. Messages
4089 are placed on the queue, and remain there until a subsequent queue runner
4090 process encounters them. There are several configuration options (such as
4091 &%queue_only%&) that can be used to queue incoming messages under certain
4092 conditions. This option overrides all of them and also &%-odqs%&. It always
4093 forces queueing.
4094
4095 .vitem &%-odqs%&
4096 .oindex "&%-odqs%&"
4097 .cindex "SMTP" "delaying delivery"
4098 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4099 However, like &%-odb%& and &%-odi%&, this option has no effect if
4100 &%queue_only_override%& is false and one of the queueing options in the
4101 configuration file is in effect.
4102
4103 When &%-odqs%& does operate, a delivery process is started for each incoming
4104 message, in the background by default, but in the foreground if &%-odi%& is
4105 also present. The recipient addresses are routed, and local deliveries are done
4106 in the normal way. However, if any SMTP deliveries are required, they are not
4107 done at this time, so the message remains on the queue until a subsequent queue
4108 runner process encounters it. Because routing was done, Exim knows which
4109 messages are waiting for which hosts, and so a number of messages for the same
4110 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4111 configuration option has the same effect for specific domains. See also the
4112 &%-qq%& option.
4113
4114 .vitem &%-oee%&
4115 .oindex "&%-oee%&"
4116 .cindex "error" "reporting"
4117 If an error is detected while a non-SMTP message is being received (for
4118 example, a malformed address), the error is reported to the sender in a mail
4119 message.
4120
4121 .cindex "return code" "for &%-oee%&"
4122 Provided
4123 this error message is successfully sent, the Exim receiving process
4124 exits with a return code of zero. If not, the return code is 2 if the problem
4125 is that the original message has no recipients, or 1 for any other error.
4126 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4127
4128 .vitem &%-oem%&
4129 .oindex "&%-oem%&"
4130 .cindex "error" "reporting"
4131 .cindex "return code" "for &%-oem%&"
4132 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4133 return code, whether or not the error message was successfully sent.
4134 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4135
4136 .vitem &%-oep%&
4137 .oindex "&%-oep%&"
4138 .cindex "error" "reporting"
4139 If an error is detected while a non-SMTP message is being received, the
4140 error is reported by writing a message to the standard error file (stderr).
4141 .cindex "return code" "for &%-oep%&"
4142 The return code is 1 for all errors.
4143
4144 .vitem &%-oeq%&
4145 .oindex "&%-oeq%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oep%&.
4149
4150 .vitem &%-oew%&
4151 .oindex "&%-oew%&"
4152 .cindex "error" "reporting"
4153 This option is supported for compatibility with Sendmail, but has the same
4154 effect as &%-oem%&.
4155
4156 .vitem &%-oi%&
4157 .oindex "&%-oi%&"
4158 .cindex "dot" "in incoming non-SMTP message"
4159 This option, which has the same effect as &%-i%&, specifies that a dot on a
4160 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4161 single dot does terminate, though Exim does no special processing for other
4162 lines that start with a dot. This option is set by default if Exim is called as
4163 &'rmail'&. See also &%-ti%&.
4164
4165 .vitem &%-oitrue%&
4166 .oindex "&%-oitrue%&"
4167 This option is treated as synonymous with &%-oi%&.
4168
4169 .vitem &%-oMa%&&~<&'host&~address'&>
4170 .oindex "&%-oMa%&"
4171 .cindex "sender" "host address, specifying for local message"
4172 A number of options starting with &%-oM%& can be used to set values associated
4173 with remote hosts on locally-submitted messages (that is, messages not received
4174 over TCP/IP). These options can be used by any caller in conjunction with the
4175 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4176 other circumstances, they are ignored unless the caller is trusted.
4177
4178 The &%-oMa%& option sets the sender host address. This may include a port
4179 number at the end, after a full stop (period). For example:
4180 .code
4181 exim -bs -oMa 10.9.8.7.1234
4182 .endd
4183 An alternative syntax is to enclose the IP address in square brackets,
4184 followed by a colon and the port number:
4185 .code
4186 exim -bs -oMa [10.9.8.7]:1234
4187 .endd
4188 The IP address is placed in the &$sender_host_address$& variable, and the
4189 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4190 are present on the command line, the sender host IP address is taken from
4191 whichever one is last.
4192
4193 .vitem &%-oMaa%&&~<&'name'&>
4194 .oindex "&%-oMaa%&"
4195 .cindex "authentication" "name, specifying for local message"
4196 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4197 option sets the value of &$sender_host_authenticated$& (the authenticator
4198 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4199 This option can be used with &%-bh%& and &%-bs%& to set up an
4200 authenticated SMTP session without actually using the SMTP AUTH command.
4201
4202 .vitem &%-oMai%&&~<&'string'&>
4203 .oindex "&%-oMai%&"
4204 .cindex "authentication" "id, specifying for local message"
4205 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4206 option sets the value of &$authenticated_id$& (the id that was authenticated).
4207 This overrides the default value (the caller's login id, except with &%-bh%&,
4208 where there is no default) for messages from local sources. See chapter
4209 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4210
4211 .vitem &%-oMas%&&~<&'address'&>
4212 .oindex "&%-oMas%&"
4213 .cindex "authentication" "sender, specifying for local message"
4214 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4215 option sets the authenticated sender value in &$authenticated_sender$&. It
4216 overrides the sender address that is created from the caller's login id for
4217 messages from local sources, except when &%-bh%& is used, when there is no
4218 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4219 specified on a MAIL command overrides this value. See chapter
4220 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4221
4222 .vitem &%-oMi%&&~<&'interface&~address'&>
4223 .oindex "&%-oMi%&"
4224 .cindex "interface" "address, specifying for local message"
4225 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4226 option sets the IP interface address value. A port number may be included,
4227 using the same syntax as for &%-oMa%&. The interface address is placed in
4228 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4229
4230 .vitem &%-oMm%&&~<&'message&~reference'&>
4231 .oindex "&%-oMm%&"
4232 .cindex "message reference" "message reference, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4234 option sets the message reference, e.g. message-id, and is logged during
4235 delivery. This is useful when some kind of audit trail is required to tie
4236 messages together. The format of the message reference is checked and will
4237 abort if the format is invalid. The option will only be accepted if exim is
4238 running in trusted mode, not as any regular user.
4239
4240 The best example of a message reference is when Exim sends a bounce message.
4241 The message reference is the message-id of the original message for which Exim
4242 is sending the bounce.
4243
4244 .vitem &%-oMr%&&~<&'protocol&~name'&>
4245 .oindex "&%-oMr%&"
4246 .cindex "protocol, specifying for local message"
4247 .vindex "&$received_protocol$&"
4248 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4249 option sets the received protocol value that is stored in
4250 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4251 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4252 SMTP protocol names (see the description of &$received_protocol$& in section
4253 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4254 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4255 be set by &%-oMr%&.
4256
4257 .vitem &%-oMs%&&~<&'host&~name'&>
4258 .oindex "&%-oMs%&"
4259 .cindex "sender" "host name, specifying for local message"
4260 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4261 option sets the sender host name in &$sender_host_name$&. When this option is
4262 present, Exim does not attempt to look up a host name from an IP address; it
4263 uses the name it is given.
4264
4265 .vitem &%-oMt%&&~<&'ident&~string'&>
4266 .oindex "&%-oMt%&"
4267 .cindex "sender" "ident string, specifying for local message"
4268 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4269 option sets the sender ident value in &$sender_ident$&. The default setting for
4270 local callers is the login id of the calling process, except when &%-bh%& is
4271 used, when there is no default.
4272
4273 .vitem &%-om%&
4274 .oindex "&%-om%&"
4275 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4276 In Sendmail, this option means &"me too"&, indicating that the sender of a
4277 message should receive a copy of the message if the sender appears in an alias
4278 expansion. Exim always does this, so the option does nothing.
4279
4280 .vitem &%-oo%&
4281 .oindex "&%-oo%&"
4282 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4283 This option is ignored. In Sendmail it specifies &"old style headers"&,
4284 whatever that means.
4285
4286 .vitem &%-oP%&&~<&'path'&>
4287 .oindex "&%-oP%&"
4288 .cindex "pid (process id)" "of daemon"
4289 .cindex "daemon" "process id (pid)"
4290 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4291 value. The option specifies the file to which the process id of the daemon is
4292 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4293 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4294 because in those cases, the normal pid file is not used.
4295
4296 .vitem &%-or%&&~<&'time'&>
4297 .oindex "&%-or%&"
4298 .cindex "timeout" "for non-SMTP input"
4299 This option sets a timeout value for incoming non-SMTP messages. If it is not
4300 set, Exim will wait forever for the standard input. The value can also be set
4301 by the &%receive_timeout%& option. The format used for specifying times is
4302 described in section &<<SECTtimeformat>>&.
4303
4304 .vitem &%-os%&&~<&'time'&>
4305 .oindex "&%-os%&"
4306 .cindex "timeout" "for SMTP input"
4307 .cindex "SMTP" "input timeout"
4308 This option sets a timeout value for incoming SMTP messages. The timeout
4309 applies to each SMTP command and block of data. The value can also be set by
4310 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4311 for specifying times is described in section &<<SECTtimeformat>>&.
4312
4313 .vitem &%-ov%&
4314 .oindex "&%-ov%&"
4315 This option has exactly the same effect as &%-v%&.
4316
4317 .vitem &%-oX%&&~<&'number&~or&~string'&>
4318 .oindex "&%-oX%&"
4319 .cindex "TCP/IP" "setting listening ports"
4320 .cindex "TCP/IP" "setting listening interfaces"
4321 .cindex "port" "receiving TCP/IP"
4322 This option is relevant only when the &%-bd%& (start listening daemon) option
4323 is also given. It controls which ports and interfaces the daemon uses. Details
4324 of the syntax, and how it interacts with configuration file options, are given
4325 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4326 file is written unless &%-oP%& is also present to specify a pid file name.
4327
4328 .vitem &%-pd%&
4329 .oindex "&%-pd%&"
4330 .cindex "Perl" "starting the interpreter"
4331 This option applies when an embedded Perl interpreter is linked with Exim (see
4332 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4333 option, forcing the starting of the interpreter to be delayed until it is
4334 needed.
4335
4336 .vitem &%-ps%&
4337 .oindex "&%-ps%&"
4338 .cindex "Perl" "starting the interpreter"
4339 This option applies when an embedded Perl interpreter is linked with Exim (see
4340 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4341 option, forcing the starting of the interpreter to occur as soon as Exim is
4342 started.
4343
4344 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4345 .oindex "&%-p%&"
4346 For compatibility with Sendmail, this option is equivalent to
4347 .display
4348 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4349 .endd
4350 It sets the incoming protocol and host name (for trusted callers). The
4351 host name and its colon can be omitted when only the protocol is to be set.
4352 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4353 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4354 or &`s`& using this option (but that does not seem a real limitation).
4355
4356 .vitem &%-q%&
4357 .oindex "&%-q%&"
4358 .cindex "queue runner" "starting manually"
4359 This option is normally restricted to admin users. However, there is a
4360 configuration option called &%prod_requires_admin%& which can be set false to
4361 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4362 and &%-S%& options).
4363
4364 .cindex "queue runner" "description of operation"
4365 The &%-q%& option starts one queue runner process. This scans the queue of
4366 waiting messages, and runs a delivery process for each one in turn. It waits
4367 for each delivery process to finish before starting the next one. A delivery
4368 process may not actually do any deliveries if the retry times for the addresses
4369 have not been reached. Use &%-qf%& (see below) if you want to override this.
4370
4371 If
4372 .cindex "SMTP" "passed connection"
4373 .cindex "SMTP" "multiple deliveries"
4374 .cindex "multiple SMTP deliveries"
4375 the delivery process spawns other processes to deliver other messages down
4376 passed SMTP connections, the queue runner waits for these to finish before
4377 proceeding.
4378
4379 When all the queued messages have been considered, the original queue runner
4380 process terminates. In other words, a single pass is made over the waiting
4381 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4382 this to be repeated periodically.
4383
4384 Exim processes the waiting messages in an unpredictable order. It isn't very
4385 random, but it is likely to be different each time, which is all that matters.
4386 If one particular message screws up a remote MTA, other messages to the same
4387 MTA have a chance of getting through if they get tried first.
4388
4389 It is possible to cause the messages to be processed in lexical message id
4390 order, which is essentially the order in which they arrived, by setting the
4391 &%queue_run_in_order%& option, but this is not recommended for normal use.
4392
4393 .vitem &%-q%&<&'qflags'&>
4394 The &%-q%& option may be followed by one or more flag letters that change its
4395 behaviour. They are all optional, but if more than one is present, they must
4396 appear in the correct order. Each flag is described in a separate item below.
4397
4398 .vitem &%-qq...%&
4399 .oindex "&%-qq%&"
4400 .cindex "queue" "double scanning"
4401 .cindex "queue" "routing"
4402 .cindex "routing" "whole queue before delivery"
4403 An option starting with &%-qq%& requests a two-stage queue run. In the first
4404 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4405 every domain. Addresses are routed, local deliveries happen, but no remote
4406 transports are run.
4407
4408 .cindex "hints database" "remembering routing"
4409 The hints database that remembers which messages are waiting for specific hosts
4410 is updated, as if delivery to those hosts had been deferred. After this is
4411 complete, a second, normal queue scan happens, with routing and delivery taking
4412 place as normal. Messages that are routed to the same host should mostly be
4413 delivered down a single SMTP
4414 .cindex "SMTP" "passed connection"
4415 .cindex "SMTP" "multiple deliveries"
4416 .cindex "multiple SMTP deliveries"
4417 connection because of the hints that were set up during the first queue scan.
4418 This option may be useful for hosts that are connected to the Internet
4419 intermittently.
4420
4421 .vitem &%-q[q]i...%&
4422 .oindex "&%-qi%&"
4423 .cindex "queue" "initial delivery"
4424 If the &'i'& flag is present, the queue runner runs delivery processes only for
4425 those messages that haven't previously been tried. (&'i'& stands for &"initial
4426 delivery"&.) This can be helpful if you are putting messages on the queue using
4427 &%-odq%& and want a queue runner just to process the new messages.
4428
4429 .vitem &%-q[q][i]f...%&
4430 .oindex "&%-qf%&"
4431 .cindex "queue" "forcing delivery"
4432 .cindex "delivery" "forcing in queue run"
4433 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4434 message, whereas without &'f'& only those non-frozen addresses that have passed
4435 their retry times are tried.
4436
4437 .vitem &%-q[q][i]ff...%&
4438 .oindex "&%-qff%&"
4439 .cindex "frozen messages" "forcing delivery"
4440 If &'ff'& is present, a delivery attempt is forced for every message, whether
4441 frozen or not.
4442
4443 .vitem &%-q[q][i][f[f]]l%&
4444 .oindex "&%-ql%&"
4445 .cindex "queue" "local deliveries only"
4446 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4447 be done. If a message requires any remote deliveries, it remains on the queue
4448 for later delivery.
4449
4450 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4451 .cindex "queue" "delivering specific messages"
4452 When scanning the queue, Exim can be made to skip over messages whose ids are
4453 lexically less than a given value by following the &%-q%& option with a
4454 starting message id. For example:
4455 .code
4456 exim -q 0t5C6f-0000c8-00
4457 .endd
4458 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4459 second message id is given, messages whose ids are lexically greater than it
4460 are also skipped. If the same id is given twice, for example,
4461 .code
4462 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4463 .endd
4464 just one delivery process is started, for that message. This differs from
4465 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4466 that it counts as a delivery from a queue run. Note that the selection
4467 mechanism does not affect the order in which the messages are scanned. There
4468 are also other ways of selecting specific sets of messages for delivery in a
4469 queue run &-- see &%-R%& and &%-S%&.
4470
4471 .vitem &%-q%&<&'qflags'&><&'time'&>
4472 .cindex "queue runner" "starting periodically"
4473 .cindex "periodic queue running"
4474 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4475 starting a queue runner process at intervals specified by the given time value
4476 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4477 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4478 single daemon process handles both functions. A common way of starting up a
4479 combined daemon at system boot time is to use a command such as
4480 .code
4481 /usr/exim/bin/exim -bd -q30m
4482 .endd
4483 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4484 process every 30 minutes.
4485
4486 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4487 pid file is written unless one is explicitly requested by the &%-oP%& option.
4488
4489 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4490 .oindex "&%-qR%&"
4491 This option is synonymous with &%-R%&. It is provided for Sendmail
4492 compatibility.
4493
4494 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4495 .oindex "&%-qS%&"
4496 This option is synonymous with &%-S%&.
4497
4498 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-R%&"
4500 .cindex "queue runner" "for specific recipients"
4501 .cindex "delivery" "to given domain"
4502 .cindex "domain" "delivery to"
4503 The <&'rsflags'&> may be empty, in which case the white space before the string
4504 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4505 which are the possible values for <&'rsflags'&>. White space is required if
4506 <&'rsflags'&> is not empty.
4507
4508 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4509 perform a single queue run, except that, when scanning the messages on the
4510 queue, Exim processes only those that have at least one undelivered recipient
4511 address containing the given string, which is checked in a case-independent
4512 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4513 regular expression; otherwise it is a literal string.
4514
4515 If you want to do periodic queue runs for messages with specific recipients,
4516 you can combine &%-R%& with &%-q%& and a time value. For example:
4517 .code
4518 exim -q25m -R @special.domain.example
4519 .endd
4520 This example does a queue run for messages with recipients in the given domain
4521 every 25 minutes. Any additional flags that are specified with &%-q%& are
4522 applied to each queue run.
4523
4524 Once a message is selected for delivery by this mechanism, all its addresses
4525 are processed. For the first selected message, Exim overrides any retry
4526 information and forces a delivery attempt for each undelivered address. This
4527 means that if delivery of any address in the first message is successful, any
4528 existing retry information is deleted, and so delivery attempts for that
4529 address in subsequently selected messages (which are processed without forcing)
4530 will run. However, if delivery of any address does not succeed, the retry
4531 information is updated, and in subsequently selected messages, the failing
4532 address will be skipped.
4533
4534 .cindex "frozen messages" "forcing delivery"
4535 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4536 all selected messages, not just the first; frozen messages are included when
4537 &'ff'& is present.
4538
4539 The &%-R%& option makes it straightforward to initiate delivery of all messages
4540 to a given domain after a host has been down for some time. When the SMTP
4541 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4542 effect is to run Exim with the &%-R%& option, but it can be configured to run
4543 an arbitrary command instead.
4544
4545 .vitem &%-r%&
4546 .oindex "&%-r%&"
4547 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4548
4549 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4550 .oindex "&%-S%&"
4551 .cindex "delivery" "from given sender"
4552 .cindex "queue runner" "for specific senders"
4553 This option acts like &%-R%& except that it checks the string against each
4554 message's sender instead of against the recipients. If &%-R%& is also set, both
4555 conditions must be met for a message to be selected. If either of the options
4556 has &'f'& or &'ff'& in its flags, the associated action is taken.
4557
4558 .vitem &%-Tqt%&&~<&'times'&>
4559 .oindex "&%-Tqt%&"
4560 This is an option that is exclusively for use by the Exim testing suite. It is not
4561 recognized when Exim is run normally. It allows for the setting up of explicit
4562 &"queue times"& so that various warning/retry features can be tested.
4563
4564 .vitem &%-t%&
4565 .oindex "&%-t%&"
4566 .cindex "recipient" "extracting from header lines"
4567 .cindex "&'Bcc:'& header line"
4568 .cindex "&'Cc:'& header line"
4569 .cindex "&'To:'& header line"
4570 When Exim is receiving a locally-generated, non-SMTP message on its standard
4571 input, the &%-t%& option causes the recipients of the message to be obtained
4572 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4573 from the command arguments. The addresses are extracted before any rewriting
4574 takes place and the &'Bcc:'& header line, if present, is then removed.
4575
4576 .cindex "Sendmail compatibility" "&%-t%& option"
4577 If the command has any arguments, they specify addresses to which the message
4578 is &'not'& to be delivered. That is, the argument addresses are removed from
4579 the recipients list obtained from the headers. This is compatible with Smail 3
4580 and in accordance with the documented behaviour of several versions of
4581 Sendmail, as described in man pages on a number of operating systems (e.g.
4582 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4583 argument addresses to those obtained from the headers, and the O'Reilly
4584 Sendmail book documents it that way. Exim can be made to add argument addresses
4585 instead of subtracting them by setting the option
4586 &%extract_addresses_remove_arguments%& false.
4587
4588 .cindex "&%Resent-%& header lines" "with &%-t%&"
4589 If there are any &%Resent-%& header lines in the message, Exim extracts
4590 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4591 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4592 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4593 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4594
4595 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4596 message is resent several times). The RFC also specifies that they should be
4597 added at the front of the message, and separated by &'Received:'& lines. It is
4598 not at all clear how &%-t%& should operate in the present of multiple sets,
4599 nor indeed exactly what constitutes a &"set"&.
4600 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4601 are often added at the end of the header, and if a message is resent more than
4602 once, it is common for the original set of &%Resent-%& headers to be renamed as
4603 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4604
4605 .vitem &%-ti%&
4606 .oindex "&%-ti%&"
4607 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4608 compatibility with Sendmail.
4609
4610 .vitem &%-tls-on-connect%&
4611 .oindex "&%-tls-on-connect%&"
4612 .cindex "TLS" "use without STARTTLS"
4613 .cindex "TLS" "automatic start"
4614 This option is available when Exim is compiled with TLS support. It forces all
4615 incoming SMTP connections to behave as if the incoming port is listed in the
4616 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4617 &<<CHAPTLS>>& for further details.
4618
4619
4620 .vitem &%-U%&
4621 .oindex "&%-U%&"
4622 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4623 Sendmail uses this option for &"initial message submission"&, and its
4624 documentation states that in future releases, it may complain about
4625 syntactically invalid messages rather than fixing them when this flag is not
4626 set. Exim ignores this option.
4627
4628 .vitem &%-v%&
4629 .oindex "&%-v%&"
4630 This option causes Exim to write information to the standard error stream,
4631 describing what it is doing. In particular, it shows the log lines for
4632 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4633 dialogue is shown. Some of the log lines shown may not actually be written to
4634 the log if the setting of &%log_selector%& discards them. Any relevant
4635 selectors are shown with each log line. If none are shown, the logging is
4636 unconditional.
4637
4638 .vitem &%-x%&
4639 .oindex "&%-x%&"
4640 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4641 National Language Support extended characters in the body of the mail item"&).
4642 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4643 this option.
4644
4645 .vitem &%-X%&&~<&'logfile'&>
4646 .oindex "&%-X%&"
4647 This option is interpreted by Sendmail to cause debug information to be sent
4648 to the named file.  It is ignored by Exim.
4649 .endlist
4650
4651 .ecindex IIDclo1
4652 .ecindex IIDclo2
4653
4654
4655 . ////////////////////////////////////////////////////////////////////////////
4656 . Insert a stylized DocBook comment here, to identify the end of the command
4657 . line options. This is for the benefit of the Perl script that automatically
4658 . creates a man page for the options.
4659 . ////////////////////////////////////////////////////////////////////////////
4660
4661 .literal xml
4662 <!-- === End of command line options === -->
4663 .literal off
4664
4665
4666
4667
4668
4669 . ////////////////////////////////////////////////////////////////////////////
4670 . ////////////////////////////////////////////////////////////////////////////
4671
4672
4673 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4674          "The runtime configuration file"
4675
4676 .cindex "run time configuration"
4677 .cindex "configuration file" "general description"
4678 .cindex "CONFIGURE_FILE"
4679 .cindex "configuration file" "errors in"
4680 .cindex "error" "in configuration file"
4681 .cindex "return code" "for bad configuration"
4682 Exim uses a single run time configuration file that is read whenever an Exim
4683 binary is executed. Note that in normal operation, this happens frequently,
4684 because Exim is designed to operate in a distributed manner, without central
4685 control.
4686
4687 If a syntax error is detected while reading the configuration file, Exim
4688 writes a message on the standard error, and exits with a non-zero return code.
4689 The message is also written to the panic log. &*Note*&: Only simple syntax
4690 errors can be detected at this time. The values of any expanded options are
4691 not checked until the expansion happens, even when the expansion does not
4692 actually alter the string.
4693
4694 The name of the configuration file is compiled into the binary for security
4695 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4696 most configurations, this specifies a single file. However, it is permitted to
4697 give a colon-separated list of file names, in which case Exim uses the first
4698 existing file in the list.
4699
4700 .cindex "EXIM_USER"
4701 .cindex "EXIM_GROUP"
4702 .cindex "CONFIGURE_OWNER"
4703 .cindex "CONFIGURE_GROUP"
4704 .cindex "configuration file" "ownership"
4705 .cindex "ownership" "configuration file"
4706 The run time configuration file must be owned by root or by the user that is
4707 specified at compile time by the CONFIGURE_OWNER option (if set). The
4708 configuration file must not be world-writeable, or group-writeable unless its
4709 group is the root group or the one specified at compile time by the
4710 CONFIGURE_GROUP option.
4711
4712 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4713 to root, anybody who is able to edit the run time configuration file has an
4714 easy way to run commands as root. If you specify a user or group in the
4715 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4716 who are members of that group will trivially be able to obtain root privileges.
4717
4718 Up to Exim version 4.72, the run time configuration file was also permitted to
4719 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4720 since it offered a simple privilege escalation for any attacker who managed to
4721 compromise the Exim user account.
4722
4723 A default configuration file, which will work correctly in simple situations,
4724 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4725 defines just one file name, the installation process copies the default
4726 configuration to a new file of that name if it did not previously exist. If
4727 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4728 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4729 configuration.
4730
4731
4732
4733 .section "Using a different configuration file" "SECID40"
4734 .cindex "configuration file" "alternate"
4735 A one-off alternate configuration can be specified by the &%-C%& command line
4736 option, which may specify a single file or a list of files. However, when
4737 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4738 unless the argument for &%-C%& is identical to the built-in value from
4739 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4740 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4741 is useful mainly for checking the syntax of configuration files before
4742 installing them. No owner or group checks are done on a configuration file
4743 specified by &%-C%&, if root privilege has been dropped.
4744
4745 Even the Exim user is not trusted to specify an arbitrary configuration file
4746 with the &%-C%& option to be used with root privileges, unless that file is
4747 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4748 testing a configuration using &%-C%& right through message reception and
4749 delivery, even if the caller is root. The reception works, but by that time,
4750 Exim is running as the Exim user, so when it re-execs to regain privilege for
4751 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4752 can test reception and delivery using two separate commands (one to put a
4753 message on the queue, using &%-odq%&, and another to do the delivery, using
4754 &%-M%&).
4755
4756 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4757 prefix string with which any file named in a &%-C%& command line option must
4758 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4759 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4760 name can be used with &%-C%&.
4761
4762 One-off changes to a configuration can be specified by the &%-D%& command line
4763 option, which defines and overrides values for macros used inside the
4764 configuration file. However, like &%-C%&, the use of this option by a
4765 non-privileged user causes Exim to discard its root privilege.
4766 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4767 completely disabled, and its use causes an immediate error exit.
4768
4769 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4770 to declare certain macro names trusted, such that root privilege will not
4771 necessarily be discarded.
4772 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4773 considered safe and, if &%-D%& only supplies macros from this list, and the
4774 values are acceptable, then Exim will not give up root privilege if the caller
4775 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4776 transition mechanism and is expected to be removed in the future.  Acceptable
4777 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4778
4779 Some sites may wish to use the same Exim binary on different machines that
4780 share a file system, but to use different configuration files on each machine.
4781 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4782 looks for a file whose name is the configuration file name followed by a dot
4783 and the machine's node name, as obtained from the &[uname()]& function. If this
4784 file does not exist, the standard name is tried. This processing occurs for
4785 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4786
4787 In some esoteric situations different versions of Exim may be run under
4788 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4789 help with this. See the comments in &_src/EDITME_& for details.
4790
4791
4792
4793 .section "Configuration file format" "SECTconffilfor"
4794 .cindex "configuration file" "format of"
4795 .cindex "format" "configuration file"
4796 Exim's configuration file is divided into a number of different parts. General
4797 option settings must always appear at the start of the file. The other parts
4798 are all optional, and may appear in any order. Each part other than the first
4799 is introduced by the word &"begin"& followed by the name of the part. The
4800 optional parts are:
4801
4802 .ilist
4803 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4804 &<<CHAPACL>>&).
4805 .next
4806 .cindex "AUTH" "configuration"
4807 &'authenticators'&: Configuration settings for the authenticator drivers. These
4808 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4809 .next
4810 &'routers'&: Configuration settings for the router drivers. Routers process
4811 addresses and determine how the message is to be delivered (see chapters
4812 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4813 .next
4814 &'transports'&: Configuration settings for the transport drivers. Transports
4815 define mechanisms for copying messages to destinations (see chapters
4816 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4817 .next
4818 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4819 If there is no retry section, or if it is empty (that is, no retry rules are
4820 defined), Exim will not retry deliveries. In this situation, temporary errors
4821 are treated the same as permanent errors. Retry rules are discussed in chapter
4822 &<<CHAPretry>>&.
4823 .next
4824 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4825 when new addresses are generated during delivery. Rewriting is discussed in
4826 chapter &<<CHAPrewrite>>&.
4827 .next
4828 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4829 want to use this feature, you must set
4830 .code
4831 LOCAL_SCAN_HAS_OPTIONS=yes
4832 .endd
4833 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4834 facility are given in chapter &<<CHAPlocalscan>>&.
4835 .endlist
4836
4837 .cindex "configuration file" "leading white space in"
4838 .cindex "configuration file" "trailing white space in"
4839 .cindex "white space" "in configuration file"
4840 Leading and trailing white space in configuration lines is always ignored.
4841
4842 Blank lines in the file, and lines starting with a # character (ignoring
4843 leading white space) are treated as comments and are ignored. &*Note*&: A
4844 # character other than at the beginning of a line is not treated specially,
4845 and does not introduce a comment.
4846
4847 Any non-comment line can be continued by ending it with a backslash. Note that
4848 the general rule for white space means that trailing white space after the
4849 backslash and leading white space at the start of continuation
4850 lines is ignored. Comment lines beginning with # (but not empty lines) may
4851 appear in the middle of a sequence of continuation lines.
4852
4853 A convenient way to create a configuration file is to start from the
4854 default, which is supplied in &_src/configure.default_&, and add, delete, or
4855 change settings as required.
4856
4857 The ACLs, retry rules, and rewriting rules have their own syntax which is
4858 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4859 respectively. The other parts of the configuration file have some syntactic
4860 items in common, and these are described below, from section &<<SECTcos>>&
4861 onwards. Before that, the inclusion, macro, and conditional facilities are
4862 described.
4863
4864
4865
4866 .section "File inclusions in the configuration file" "SECID41"
4867 .cindex "inclusions in configuration file"
4868 .cindex "configuration file" "including other files"
4869 .cindex "&`.include`& in configuration file"
4870 .cindex "&`.include_if_exists`& in configuration file"
4871 You can include other files inside Exim's run time configuration file by
4872 using this syntax:
4873 .display
4874 &`.include`& <&'file name'&>
4875 &`.include_if_exists`& <&'file name'&>
4876 .endd
4877 on a line by itself. Double quotes round the file name are optional. If you use
4878 the first form, a configuration error occurs if the file does not exist; the
4879 second form does nothing for non-existent files. In all cases, an absolute file
4880 name is required.
4881
4882 Includes may be nested to any depth, but remember that Exim reads its
4883 configuration file often, so it is a good idea to keep them to a minimum.
4884 If you change the contents of an included file, you must HUP the daemon,
4885 because an included file is read only when the configuration itself is read.
4886
4887 The processing of inclusions happens early, at a physical line level, so, like
4888 comment lines, an inclusion can be used in the middle of an option setting,
4889 for example:
4890 .code
4891 hosts_lookup = a.b.c \
4892                .include /some/file
4893 .endd
4894 Include processing happens after macro processing (see below). Its effect is to
4895 process the lines of the included file as if they occurred inline where the
4896 inclusion appears.
4897
4898
4899
4900 .section "Macros in the configuration file" "SECTmacrodefs"
4901 .cindex "macro" "description of"
4902 .cindex "configuration file" "macros"
4903 If a line in the main part of the configuration (that is, before the first
4904 &"begin"& line) begins with an upper case letter, it is taken as a macro
4905 definition, and must be of the form
4906 .display
4907 <&'name'&> = <&'rest of line'&>
4908 .endd
4909 The name must consist of letters, digits, and underscores, and need not all be
4910 in upper case, though that is recommended. The rest of the line, including any
4911 continuations, is the replacement text, and has leading and trailing white
4912 space removed. Quotes are not removed. The replacement text can never end with
4913 a backslash character, but this doesn't seem to be a serious limitation.
4914
4915 Macros may also be defined between router, transport, authenticator, or ACL
4916 definitions. They may not, however, be defined within an individual driver or
4917 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4918
4919 .section "Macro substitution" "SECID42"
4920 Once a macro is defined, all subsequent lines in the file (and any included
4921 files) are scanned for the macro name; if there are several macros, the line is
4922 scanned for each in turn, in the order in which the macros are defined. The
4923 replacement text is not re-scanned for the current macro, though it is scanned
4924 for subsequently defined macros. For this reason, a macro name may not contain
4925 the name of a previously defined macro as a substring. You could, for example,
4926 define
4927 .display
4928 &`ABCD_XYZ = `&<&'something'&>
4929 &`ABCD = `&<&'something else'&>
4930 .endd
4931 but putting the definitions in the opposite order would provoke a configuration
4932 error. Macro expansion is applied to individual physical lines from the file,
4933 before checking for line continuation or file inclusion (see above). If a line
4934 consists solely of a macro name, and the expansion of the macro is empty, the
4935 line is ignored. A macro at the start of a line may turn the line into a
4936 comment line or a &`.include`& line.
4937
4938
4939 .section "Redefining macros" "SECID43"
4940 Once defined, the value of a macro can be redefined later in the configuration
4941 (or in an included file). Redefinition is specified by using &'=='& instead of
4942 &'='&. For example:
4943 .code
4944 MAC =  initial value
4945 ...
4946 MAC == updated value
4947 .endd
4948 Redefinition does not alter the order in which the macros are applied to the
4949 subsequent lines of the configuration file. It is still the same order in which
4950 the macros were originally defined. All that changes is the macro's value.
4951 Redefinition makes it possible to accumulate values. For example:
4952 .code
4953 MAC =  initial value
4954 ...
4955 MAC == MAC and something added
4956 .endd
4957 This can be helpful in situations where the configuration file is built
4958 from a number of other files.
4959
4960 .section "Overriding macro values" "SECID44"
4961 The values set for macros in the configuration file can be overridden by the
4962 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4963 used, unless called by root or the Exim user. A definition on the command line
4964 using the &%-D%& option causes all definitions and redefinitions within the
4965 file to be ignored.
4966
4967
4968
4969 .section "Example of macro usage" "SECID45"
4970 As an example of macro usage, consider a configuration where aliases are looked
4971 up in a MySQL database. It helps to keep the file less cluttered if long
4972 strings such as SQL statements are defined separately as macros, for example:
4973 .code
4974 ALIAS_QUERY = select mailbox from user where \
4975               login='${quote_mysql:$local_part}';
4976 .endd
4977 This can then be used in a &(redirect)& router setting like this:
4978 .code
4979 data = ${lookup mysql{ALIAS_QUERY}}
4980 .endd
4981 In earlier versions of Exim macros were sometimes used for domain, host, or
4982 address lists. In Exim 4 these are handled better by named lists &-- see
4983 section &<<SECTnamedlists>>&.
4984
4985
4986 .section "Conditional skips in the configuration file" "SECID46"
4987 .cindex "configuration file" "conditional skips"
4988 .cindex "&`.ifdef`&"
4989 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4990 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4991 portions of the configuration file. The processing happens whenever the file is
4992 read (that is, when an Exim binary starts to run).
4993
4994 The implementation is very simple. Instances of the first four directives must
4995 be followed by text that includes the names of one or macros. The condition
4996 that is tested is whether or not any macro substitution has taken place in the
4997 line. Thus:
4998 .code
4999 .ifdef AAA
5000 message_size_limit = 50M
5001 .else
5002 message_size_limit = 100M
5003 .endif
5004 .endd
5005 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5006 otherwise. If there is more than one macro named on the line, the condition
5007 is true if any of them are defined. That is, it is an &"or"& condition. To
5008 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5009
5010 Although you can use a macro expansion to generate one of these directives,
5011 it is not very useful, because the condition &"there was a macro substitution
5012 in this line"& will always be true.
5013
5014 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5015 to clarify complicated nestings.
5016
5017
5018
5019 .section "Common option syntax" "SECTcos"
5020 .cindex "common option syntax"
5021 .cindex "syntax of common options"
5022 .cindex "configuration file" "common option syntax"
5023 For the main set of options, driver options, and &[local_scan()]& options,
5024 each setting is on a line by itself, and starts with a name consisting of
5025 lower-case letters and underscores. Many options require a data value, and in
5026 these cases the name must be followed by an equals sign (with optional white
5027 space) and then the value. For example:
5028 .code
5029 qualify_domain = mydomain.example.com
5030 .endd
5031 .cindex "hiding configuration option values"
5032 .cindex "configuration options" "hiding value of"
5033 .cindex "options" "hiding value of"
5034 Some option settings may contain sensitive data, for example, passwords for
5035 accessing databases. To stop non-admin users from using the &%-bP%& command
5036 line option to read these values, you can precede the option settings with the
5037 word &"hide"&. For example:
5038 .code
5039 hide mysql_servers = localhost/users/admin/secret-password
5040 .endd
5041 For non-admin users, such options are displayed like this:
5042 .code
5043 mysql_servers = <value not displayable>
5044 .endd
5045 If &"hide"& is used on a driver option, it hides the value of that option on
5046 all instances of the same driver.
5047
5048 The following sections describe the syntax used for the different data types
5049 that are found in option settings.
5050
5051
5052 .section "Boolean options" "SECID47"
5053 .cindex "format" "boolean"
5054 .cindex "boolean configuration values"
5055 .oindex "&%no_%&&'xxx'&"
5056 .oindex "&%not_%&&'xxx'&"
5057 Options whose type is given as boolean are on/off switches. There are two
5058 different ways of specifying such options: with and without a data value. If
5059 the option name is specified on its own without data, the switch is turned on;
5060 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5061 boolean options may be followed by an equals sign and one of the words
5062 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5063 the following two settings have exactly the same effect:
5064 .code
5065 queue_only
5066 queue_only = true
5067 .endd
5068 The following two lines also have the same (opposite) effect:
5069 .code
5070 no_queue_only
5071 queue_only = false
5072 .endd
5073 You can use whichever syntax you prefer.
5074
5075
5076
5077
5078 .section "Integer values" "SECID48"
5079 .cindex "integer configuration values"
5080 .cindex "format" "integer"
5081 If an option's type is given as &"integer"&, the value can be given in decimal,
5082 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5083 number is assumed. Otherwise, it is treated as an octal number unless it starts
5084 with the characters &"0x"&, in which case the remainder is interpreted as a
5085 hexadecimal number.
5086
5087 If an integer value is followed by the letter K, it is multiplied by 1024; if
5088 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5089 of integer option settings are output, values which are an exact multiple of
5090 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5091 and M. The printing style is independent of the actual input format that was
5092 used.
5093
5094
5095 .section "Octal integer values" "SECID49"
5096 .cindex "integer format"
5097 .cindex "format" "octal integer"
5098 If an option's type is given as &"octal integer"&, its value is always
5099 interpreted as an octal number, whether or not it starts with the digit zero.
5100 Such options are always output in octal.
5101
5102
5103 .section "Fixed point numbers" "SECID50"
5104 .cindex "fixed point configuration values"
5105 .cindex "format" "fixed point"
5106 If an option's type is given as &"fixed-point"&, its value must be a decimal
5107 integer, optionally followed by a decimal point and up to three further digits.
5108
5109
5110
5111 .section "Time intervals" "SECTtimeformat"
5112 .cindex "time interval" "specifying in configuration"
5113 .cindex "format" "time interval"
5114 A time interval is specified as a sequence of numbers, each followed by one of
5115 the following letters, with no intervening white space:
5116
5117 .table2 30pt
5118 .irow &%s%& seconds
5119 .irow &%m%& minutes
5120 .irow &%h%& hours
5121 .irow &%d%& days
5122 .irow &%w%& weeks
5123 .endtable
5124
5125 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5126 intervals are output in the same format. Exim does not restrict the values; it
5127 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5128
5129
5130
5131 .section "String values" "SECTstrings"
5132 .cindex "string" "format of configuration values"
5133 .cindex "format" "string"
5134 If an option's type is specified as &"string"&, the value can be specified with
5135 or without double-quotes. If it does not start with a double-quote, the value
5136 consists of the remainder of the line plus any continuation lines, starting at
5137 the first character after any leading white space, with trailing white space
5138 removed, and with no interpretation of the characters in the string. Because
5139 Exim removes comment lines (those beginning with #) at an early stage, they can
5140 appear in the middle of a multi-line string. The following two settings are
5141 therefore equivalent:
5142 .code
5143 trusted_users = uucp:mail
5144 trusted_users = uucp:\
5145                 # This comment line is ignored
5146                 mail
5147 .endd
5148 .cindex "string" "quoted"
5149 .cindex "escape characters in quoted strings"
5150 If a string does start with a double-quote, it must end with a closing
5151 double-quote, and any backslash characters other than those used for line
5152 continuation are interpreted as escape characters, as follows:
5153
5154 .table2 100pt
5155 .irow &`\\`&                     "single backslash"
5156 .irow &`\n`&                     "newline"
5157 .irow &`\r`&                     "carriage return"
5158 .irow &`\t`&                     "tab"
5159 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5160 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5161                                    character"
5162 .endtable
5163
5164 If a backslash is followed by some other character, including a double-quote
5165 character, that character replaces the pair.
5166
5167 Quoting is necessary only if you want to make use of the backslash escapes to
5168 insert special characters, or if you need to specify a value with leading or
5169 trailing spaces. These cases are rare, so quoting is almost never needed in
5170 current versions of Exim. In versions of Exim before 3.14, quoting was required
5171 in order to continue lines, so you may come across older configuration files
5172 and examples that apparently quote unnecessarily.
5173
5174
5175 .section "Expanded strings" "SECID51"
5176 .cindex "expansion" "definition of"
5177 Some strings in the configuration file are subjected to &'string expansion'&,
5178 by which means various parts of the string may be changed according to the
5179 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5180 is as just described; in particular, the handling of backslashes in quoted
5181 strings is done as part of the input process, before expansion takes place.
5182 However, backslash is also an escape character for the expander, so any
5183 backslashes that are required for that reason must be doubled if they are
5184 within a quoted configuration string.
5185
5186
5187 .section "User and group names" "SECID52"
5188 .cindex "user name" "format of"
5189 .cindex "format" "user name"
5190 .cindex "groups" "name format"
5191 .cindex "format" "group name"
5192 User and group names are specified as strings, using the syntax described
5193 above, but the strings are interpreted specially. A user or group name must
5194 either consist entirely of digits, or be a name that can be looked up using the
5195 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5196
5197
5198 .section "List construction" "SECTlistconstruct"
5199 .cindex "list" "syntax of in configuration"
5200 .cindex "format" "list item in configuration"
5201 .cindex "string" "list, definition of"
5202 The data for some configuration options is a list of items, with colon as the
5203 default separator. Many of these options are shown with type &"string list"& in
5204 the descriptions later in this document. Others are listed as &"domain list"&,
5205 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5206 are all the same; however, those other than &"string list"& are subject to
5207 particular kinds of interpretation, as described in chapter
5208 &<<CHAPdomhosaddlists>>&.
5209
5210 In all these cases, the entire list is treated as a single string as far as the
5211 input syntax is concerned. The &%trusted_users%& setting in section
5212 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5213 in a list, it must be entered as two colons. Leading and trailing white space
5214 on each item in a list is ignored. This makes it possible to include items that
5215 start with a colon, and in particular, certain forms of IPv6 address. For
5216 example, the list
5217 .code
5218 local_interfaces = 127.0.0.1 : ::::1
5219 .endd
5220 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5221
5222 &*Note*&: Although leading and trailing white space is ignored in individual
5223 list items, it is not ignored when parsing the list. The space after the first
5224 colon in the example above is necessary. If it were not there, the list would
5225 be interpreted as the two items 127.0.0.1:: and 1.
5226
5227 .section "Changing list separators" "SECID53"
5228 .cindex "list separator" "changing"
5229 .cindex "IPv6" "addresses in lists"
5230 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5231 introduced to allow the separator character to be changed. If a list begins
5232 with a left angle bracket, followed by any punctuation character, that
5233 character is used instead of colon as the list separator. For example, the list
5234 above can be rewritten to use a semicolon separator like this:
5235 .code
5236 local_interfaces = <; 127.0.0.1 ; ::1
5237 .endd
5238 This facility applies to all lists, with the exception of the list in
5239 &%log_file_path%&. It is recommended that the use of non-colon separators be
5240 confined to circumstances where they really are needed.
5241
5242 .cindex "list separator" "newline as"
5243 .cindex "newline" "as list separator"
5244 It is also possible to use newline and other control characters (those with
5245 code values less than 32, plus DEL) as separators in lists. Such separators
5246 must be provided literally at the time the list is processed. For options that
5247 are string-expanded, you can write the separator using a normal escape
5248 sequence. This will be processed by the expander before the string is
5249 interpreted as a list. For example, if a newline-separated list of domains is
5250 generated by a lookup, you can process it directly by a line such as this:
5251 .code
5252 domains = <\n ${lookup mysql{.....}}
5253 .endd
5254 This avoids having to change the list separator in such data. You are unlikely
5255 to want to use a control character as a separator in an option that is not
5256 expanded, because the value is literal text. However, it can be done by giving
5257 the value in quotes. For example:
5258 .code
5259 local_interfaces = "<\n 127.0.0.1 \n ::1"
5260 .endd
5261 Unlike printing character separators, which can be included in list items by
5262 doubling, it is not possible to include a control character as data when it is
5263 set as the separator. Two such characters in succession are interpreted as
5264 enclosing an empty list item.
5265
5266
5267
5268 .section "Empty items in lists" "SECTempitelis"
5269 .cindex "list" "empty item in"
5270 An empty item at the end of a list is always ignored. In other words, trailing
5271 separator characters are ignored. Thus, the list in
5272 .code
5273 senders = user@domain :
5274 .endd
5275 contains only a single item. If you want to include an empty string as one item
5276 in a list, it must not be the last item. For example, this list contains three
5277 items, the second of which is empty:
5278 .code
5279 senders = user1@domain : : user2@domain
5280 .endd
5281 &*Note*&: There must be white space between the two colons, as otherwise they
5282 are interpreted as representing a single colon data character (and the list
5283 would then contain just one item). If you want to specify a list that contains
5284 just one, empty item, you can do it as in this example:
5285 .code
5286 senders = :
5287 .endd
5288 In this case, the first item is empty, and the second is discarded because it
5289 is at the end of the list.
5290
5291
5292
5293
5294 .section "Format of driver configurations" "SECTfordricon"
5295 .cindex "drivers" "configuration format"
5296 There are separate parts in the configuration for defining routers, transports,
5297 and authenticators. In each part, you are defining a number of driver
5298 instances, each with its own set of options. Each driver instance is defined by
5299 a sequence of lines like this:
5300 .display
5301 <&'instance name'&>:
5302   <&'option'&>
5303   ...
5304   <&'option'&>
5305 .endd
5306 In the following example, the instance name is &(localuser)&, and it is
5307 followed by three options settings:
5308 .code
5309 localuser:
5310   driver = accept
5311   check_local_user
5312   transport = local_delivery
5313 .endd
5314 For each driver instance, you specify which Exim code module it uses &-- by the
5315 setting of the &%driver%& option &-- and (optionally) some configuration
5316 settings. For example, in the case of transports, if you want a transport to
5317 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5318 a local file you would use the &(appendfile)& driver. Each of the drivers is
5319 described in detail in its own separate chapter later in this manual.
5320
5321 You can have several routers, transports, or authenticators that are based on
5322 the same underlying driver (each must have a different instance name).
5323
5324 The order in which routers are defined is important, because addresses are
5325 passed to individual routers one by one, in order. The order in which
5326 transports are defined does not matter at all. The order in which
5327 authenticators are defined is used only when Exim, as a client, is searching
5328 them to find one that matches an authentication mechanism offered by the
5329 server.
5330
5331 .cindex "generic options"
5332 .cindex "options" "generic &-- definition of"
5333 Within a driver instance definition, there are two kinds of option: &'generic'&
5334 and &'private'&. The generic options are those that apply to all drivers of the
5335 same type (that is, all routers, all transports or all authenticators). The
5336 &%driver%& option is a generic option that must appear in every definition.
5337 .cindex "private options"
5338 The private options are special for each driver, and none need appear, because
5339 they all have default values.
5340
5341 The options may appear in any order, except that the &%driver%& option must
5342 precede any private options, since these depend on the particular driver. For
5343 this reason, it is recommended that &%driver%& always be the first option.
5344
5345 Driver instance names, which are used for reference in log entries and
5346 elsewhere, can be any sequence of letters, digits, and underscores (starting
5347 with a letter) and must be unique among drivers of the same type. A router and
5348 a transport (for example) can each have the same name, but no two router
5349 instances can have the same name. The name of a driver instance should not be
5350 confused with the name of the underlying driver module. For example, the
5351 configuration lines:
5352 .code
5353 remote_smtp:
5354   driver = smtp
5355 .endd
5356 create an instance of the &(smtp)& transport driver whose name is
5357 &(remote_smtp)&. The same driver code can be used more than once, with
5358 different instance names and different option settings each time. A second
5359 instance of the &(smtp)& transport, with different options, might be defined
5360 thus:
5361 .code
5362 special_smtp:
5363   driver = smtp
5364   port = 1234
5365   command_timeout = 10s
5366 .endd
5367 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5368 these transport instances from routers, and these names would appear in log
5369 lines.
5370
5371 Comment lines may be present in the middle of driver specifications. The full
5372 list of option settings for any particular driver instance, including all the
5373 defaulted values, can be extracted by making use of the &%-bP%& command line
5374 option.
5375
5376
5377
5378
5379
5380
5381 . ////////////////////////////////////////////////////////////////////////////
5382 . ////////////////////////////////////////////////////////////////////////////
5383
5384 .chapter "The default configuration file" "CHAPdefconfil"
5385 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5386 .cindex "default" "configuration file &""walk through""&"
5387 The default configuration file supplied with Exim as &_src/configure.default_&
5388 is sufficient for a host with simple mail requirements. As an introduction to
5389 the way Exim is configured, this chapter &"walks through"& the default
5390 configuration, giving brief explanations of the settings. Detailed descriptions
5391 of the options are given in subsequent chapters. The default configuration file
5392 itself contains extensive comments about ways you might want to modify the
5393 initial settings. However, note that there are many options that are not
5394 mentioned at all in the default configuration.
5395
5396
5397
5398 .section "Main configuration settings" "SECTdefconfmain"
5399 The main (global) configuration option settings must always come first in the
5400 file. The first thing you'll see in the file, after some initial comments, is
5401 the line
5402 .code
5403 # primary_hostname =
5404 .endd
5405 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5406 to know the official, fully qualified name of your host, and this is where you
5407 can specify it. However, in most cases you do not need to set this option. When
5408 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5409
5410 The first three non-comment configuration lines are as follows:
5411 .code
5412 domainlist local_domains    = @
5413 domainlist relay_to_domains =
5414 hostlist   relay_from_hosts = 127.0.0.1
5415 .endd
5416 These are not, in fact, option settings. They are definitions of two named
5417 domain lists and one named host list. Exim allows you to give names to lists of
5418 domains, hosts, and email addresses, in order to make it easier to manage the
5419 configuration file (see section &<<SECTnamedlists>>&).
5420
5421 The first line defines a domain list called &'local_domains'&; this is used
5422 later in the configuration to identify domains that are to be delivered
5423 on the local host.
5424
5425 .cindex "@ in a domain list"
5426 There is just one item in this list, the string &"@"&. This is a special form
5427 of entry which means &"the name of the local host"&. Thus, if the local host is
5428 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5429 be delivered locally. Because the local host's name is referenced indirectly,
5430 the same configuration file can be used on different hosts.
5431
5432 The second line defines a domain list called &'relay_to_domains'&, but the
5433 list itself is empty. Later in the configuration we will come to the part that
5434 controls mail relaying through the local host; it allows relaying to any
5435 domains in this list. By default, therefore, no relaying on the basis of a mail
5436 domain is permitted.
5437
5438 The third line defines a host list called &'relay_from_hosts'&. This list is
5439 used later in the configuration to permit relaying from any host or IP address
5440 that matches the list. The default contains just the IP address of the IPv4
5441 loopback interface, which means that processes on the local host are able to
5442 submit mail for relaying by sending it over TCP/IP to that interface. No other
5443 hosts are permitted to submit messages for relaying.
5444
5445 Just to be sure there's no misunderstanding: at this point in the configuration
5446 we aren't actually setting up any controls. We are just defining some domains
5447 and hosts that will be used in the controls that are specified later.
5448
5449 The next two configuration lines are genuine option settings:
5450 .code
5451 acl_smtp_rcpt = acl_check_rcpt
5452 acl_smtp_data = acl_check_data
5453 .endd
5454 These options specify &'Access Control Lists'& (ACLs) that are to be used
5455 during an incoming SMTP session for every recipient of a message (every RCPT
5456 command), and after the contents of the message have been received,
5457 respectively. The names of the lists are &'acl_check_rcpt'& and
5458 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5459 section of the configuration. The RCPT ACL controls which recipients are
5460 accepted for an incoming message &-- if a configuration does not provide an ACL
5461 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5462 contents of a message to be checked.
5463
5464 Two commented-out option settings are next:
5465 .code
5466 # av_scanner = clamd:/tmp/clamd
5467 # spamd_address = 127.0.0.1 783
5468 .endd
5469 These are example settings that can be used when Exim is compiled with the
5470 content-scanning extension. The first specifies the interface to the virus
5471 scanner, and the second specifies the interface to SpamAssassin. Further
5472 details are given in chapter &<<CHAPexiscan>>&.
5473
5474 Three more commented-out option settings follow:
5475 .code
5476 # tls_advertise_hosts = *
5477 # tls_certificate = /etc/ssl/exim.crt
5478 # tls_privatekey = /etc/ssl/exim.pem
5479 .endd
5480 These are example settings that can be used when Exim is compiled with
5481 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5482 first one specifies the list of clients that are allowed to use TLS when
5483 connecting to this server; in this case the wildcard means all clients. The
5484 other options specify where Exim should find its TLS certificate and private
5485 key, which together prove the server's identity to any clients that connect.
5486 More details are given in chapter &<<CHAPTLS>>&.
5487
5488 Another two commented-out option settings follow:
5489 .code
5490 # daemon_smtp_ports = 25 : 465 : 587
5491 # tls_on_connect_ports = 465
5492 .endd
5493 .cindex "port" "465 and 587"
5494 .cindex "port" "for message submission"
5495 .cindex "message" "submission, ports for"
5496 .cindex "ssmtp protocol"
5497 .cindex "smtps protocol"
5498 .cindex "SMTP" "ssmtp protocol"
5499 .cindex "SMTP" "smtps protocol"
5500 These options provide better support for roaming users who wish to use this
5501 server for message submission. They are not much use unless you have turned on
5502 TLS (as described in the previous paragraph) and authentication (about which
5503 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5504 on end-user networks, so RFC 4409 specifies that message submission should use
5505 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5506 configured to use port 587 correctly, so these settings also enable the
5507 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5508 &<<SECTsupobssmt>>&).
5509
5510 Two more commented-out options settings follow:
5511 .code
5512 # qualify_domain =
5513 # qualify_recipient =
5514 .endd
5515 The first of these specifies a domain that Exim uses when it constructs a
5516 complete email address from a local login name. This is often needed when Exim
5517 receives a message from a local process. If you do not set &%qualify_domain%&,
5518 the value of &%primary_hostname%& is used. If you set both of these options,
5519 you can have different qualification domains for sender and recipient
5520 addresses. If you set only the first one, its value is used in both cases.
5521
5522 .cindex "domain literal" "recognizing format"
5523 The following line must be uncommented if you want Exim to recognize
5524 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5525 (an IP address within square brackets) instead of a named domain.
5526 .code
5527 # allow_domain_literals
5528 .endd
5529 The RFCs still require this form, but many people think that in the modern
5530 Internet it makes little sense to permit mail to be sent to specific hosts by
5531 quoting their IP addresses. This ancient format has been used by people who
5532 try to abuse hosts by using them for unwanted relaying. However, some
5533 people believe there are circumstances (for example, messages addressed to
5534 &'postmaster'&) where domain literals are still useful.
5535
5536 The next configuration line is a kind of trigger guard:
5537 .code
5538 never_users = root
5539 .endd
5540 It specifies that no delivery must ever be run as the root user. The normal
5541 convention is to set up &'root'& as an alias for the system administrator. This
5542 setting is a guard against slips in the configuration.
5543 The list of users specified by &%never_users%& is not, however, the complete
5544 list; the build-time configuration in &_Local/Makefile_& has an option called
5545 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5546 contents of &%never_users%& are added to this list. By default
5547 FIXED_NEVER_USERS also specifies root.
5548
5549 When a remote host connects to Exim in order to send mail, the only information
5550 Exim has about the host's identity is its IP address. The next configuration
5551 line,
5552 .code
5553 host_lookup = *
5554 .endd
5555 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5556 in order to get a host name. This improves the quality of the logging
5557 information, but if you feel it is too expensive, you can remove it entirely,
5558 or restrict the lookup to hosts on &"nearby"& networks.
5559 Note that it is not always possible to find a host name from an IP address,
5560 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5561 unreachable.
5562
5563 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5564 1413 (hence their names):
5565 .code
5566 rfc1413_hosts = *
5567 rfc1413_query_timeout = 0s
5568 .endd
5569 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5570 Few hosts offer RFC1413 service these days; calls have to be
5571 terminated by a timeout and this needlessly delays the startup
5572 of an incoming SMTP connection.
5573 If you have hosts for which you trust RFC1413 and need this
5574 information, you can change this.
5575
5576 This line enables an efficiency SMTP option.  It is negociated by clients
5577 and not expected to cause problems but can be disabled if needed.
5578 .code
5579 prdr_enable = true
5580 .endd
5581
5582 When Exim receives messages over SMTP connections, it expects all addresses to
5583 be fully qualified with a domain, as required by the SMTP definition. However,
5584 if you are running a server to which simple clients submit messages, you may
5585 find that they send unqualified addresses. The two commented-out options:
5586 .code
5587 # sender_unqualified_hosts =
5588 # recipient_unqualified_hosts =
5589 .endd
5590 show how you can specify hosts that are permitted to send unqualified sender
5591 and recipient addresses, respectively.
5592
5593 The &%percent_hack_domains%& option is also commented out:
5594 .code
5595 # percent_hack_domains =
5596 .endd
5597 It provides a list of domains for which the &"percent hack"& is to operate.
5598 This is an almost obsolete form of explicit email routing. If you do not know
5599 anything about it, you can safely ignore this topic.
5600
5601 The last two settings in the main part of the default configuration are
5602 concerned with messages that have been &"frozen"& on Exim's queue. When a
5603 message is frozen, Exim no longer continues to try to deliver it. Freezing
5604 occurs when a bounce message encounters a permanent failure because the sender
5605 address of the original message that caused the bounce is invalid, so the
5606 bounce cannot be delivered. This is probably the most common case, but there
5607 are also other conditions that cause freezing, and frozen messages are not
5608 always bounce messages.
5609 .code
5610 ignore_bounce_errors_after = 2d
5611 timeout_frozen_after = 7d
5612 .endd
5613 The first of these options specifies that failing bounce messages are to be
5614 discarded after 2 days on the queue. The second specifies that any frozen
5615 message (whether a bounce message or not) is to be timed out (and discarded)
5616 after a week. In this configuration, the first setting ensures that no failing
5617 bounce message ever lasts a week.
5618
5619
5620
5621 .section "ACL configuration" "SECID54"
5622 .cindex "default" "ACLs"
5623 .cindex "&ACL;" "default configuration"
5624 In the default configuration, the ACL section follows the main configuration.
5625 It starts with the line
5626 .code
5627 begin acl
5628 .endd
5629 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5630 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5631 and &%acl_smtp_data%& above.
5632
5633 .cindex "RCPT" "ACL for"
5634 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5635 RCPT command specifies one of the message's recipients. The ACL statements
5636 are considered in order, until the recipient address is either accepted or
5637 rejected. The RCPT command is then accepted or rejected, according to the
5638 result of the ACL processing.
5639 .code
5640 acl_check_rcpt:
5641 .endd
5642 This line, consisting of a name terminated by a colon, marks the start of the
5643 ACL, and names it.
5644 .code
5645 accept  hosts = :
5646 .endd
5647 This ACL statement accepts the recipient if the sending host matches the list.
5648 But what does that strange list mean? It doesn't actually contain any host
5649 names or IP addresses. The presence of the colon puts an empty item in the
5650 list; Exim matches this only if the incoming message did not come from a remote
5651 host, because in that case, the remote hostname is empty. The colon is
5652 important. Without it, the list itself is empty, and can never match anything.
5653
5654 What this statement is doing is to accept unconditionally all recipients in
5655 messages that are submitted by SMTP from local processes using the standard
5656 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5657 manner.
5658 .code
5659 deny    message       = Restricted characters in address
5660         domains       = +local_domains
5661         local_parts   = ^[.] : ^.*[@%!/|]
5662
5663 deny    message       = Restricted characters in address
5664         domains       = !+local_domains
5665         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5666 .endd
5667 These statements are concerned with local parts that contain any of the
5668 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5669 Although these characters are entirely legal in local parts (in the case of
5670 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5671 in Internet mail addresses.
5672
5673 The first three have in the past been associated with explicitly routed
5674 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5675 option). Addresses containing these characters are regularly tried by spammers
5676 in an attempt to bypass relaying restrictions, and also by open relay testing
5677 programs. Unless you really need them it is safest to reject these characters
5678 at this early stage. This configuration is heavy-handed in rejecting these
5679 characters for all messages it accepts from remote hosts. This is a deliberate
5680 policy of being as safe as possible.
5681
5682 The first rule above is stricter, and is applied to messages that are addressed
5683 to one of the local domains handled by this host. This is implemented by the
5684 first condition, which restricts it to domains that are listed in the
5685 &'local_domains'& domain list. The &"+"& character is used to indicate a
5686 reference to a named list. In this configuration, there is just one domain in
5687 &'local_domains'&, but in general there may be many.
5688
5689 The second condition on the first statement uses two regular expressions to
5690 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5691 or &"|"&. If you have local accounts that include these characters, you will
5692 have to modify this rule.
5693
5694 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5695 allows them because they have been encountered in practice. (Consider the
5696 common convention of local parts constructed as
5697 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5698 the author of Exim, who has no second initial.) However, a local part starting
5699 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5700 file name (for example, for a mailing list). This is also true for local parts
5701 that contain slashes. A pipe symbol can also be troublesome if the local part
5702 is incorporated unthinkingly into a shell command line.
5703
5704 The second rule above applies to all other domains, and is less strict. This
5705 allows your own users to send outgoing messages to sites that use slashes
5706 and vertical bars in their local parts. It blocks local parts that begin
5707 with a dot, slash, or vertical bar, but allows these characters within the
5708 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5709 and &"!"& is blocked, as before. The motivation here is to prevent your users
5710 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5711 .code
5712 accept  local_parts   = postmaster
5713         domains       = +local_domains
5714 .endd
5715 This statement, which has two conditions, accepts an incoming address if the
5716 local part is &'postmaster'& and the domain is one of those listed in the
5717 &'local_domains'& domain list. The &"+"& character is used to indicate a
5718 reference to a named list. In this configuration, there is just one domain in
5719 &'local_domains'&, but in general there may be many.
5720
5721 The presence of this statement means that mail to postmaster is never blocked
5722 by any of the subsequent tests. This can be helpful while sorting out problems
5723 in cases where the subsequent tests are incorrectly denying access.
5724 .code
5725 require verify        = sender
5726 .endd
5727 This statement requires the sender address to be verified before any subsequent
5728 ACL statement can be used. If verification fails, the incoming recipient
5729 address is refused. Verification consists of trying to route the address, to
5730 see if a bounce message could be delivered to it. In the case of remote
5731 addresses, basic verification checks only the domain, but &'callouts'& can be
5732 used for more verification if required. Section &<<SECTaddressverification>>&
5733 discusses the details of address verification.
5734 .code
5735 accept  hosts         = +relay_from_hosts
5736         control       = submission
5737 .endd
5738 This statement accepts the address if the message is coming from one of the
5739 hosts that are defined as being allowed to relay through this host. Recipient
5740 verification is omitted here, because in many cases the clients are dumb MUAs
5741 that do not cope well with SMTP error responses. For the same reason, the
5742 second line specifies &"submission mode"& for messages that are accepted. This
5743 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5744 messages that are deficient in some way, for example, because they lack a
5745 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5746 probably add recipient verification here, and disable submission mode.
5747 .code
5748 accept  authenticated = *
5749         control       = submission
5750 .endd
5751 This statement accepts the address if the client host has authenticated itself.
5752 Submission mode is again specified, on the grounds that such messages are most
5753 likely to come from MUAs. The default configuration does not define any
5754 authenticators, though it does include some nearly complete commented-out
5755 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5756 fact authenticate until you complete the authenticator definitions.
5757 .code
5758 require message = relay not permitted
5759         domains = +local_domains : +relay_to_domains
5760 .endd
5761 This statement rejects the address if its domain is neither a local domain nor
5762 one of the domains for which this host is a relay.
5763 .code
5764 require verify = recipient
5765 .endd
5766 This statement requires the recipient address to be verified; if verification
5767 fails, the address is rejected.
5768 .code
5769 # deny    message     = rejected because $sender_host_address \
5770 #                       is in a black list at $dnslist_domain\n\
5771 #                       $dnslist_text
5772 #         dnslists    = black.list.example
5773 #
5774 # warn    dnslists    = black.list.example
5775 #         add_header  = X-Warning: $sender_host_address is in \
5776 #                       a black list at $dnslist_domain
5777 #         log_message = found in $dnslist_domain
5778 .endd
5779 These commented-out lines are examples of how you could configure Exim to check
5780 sending hosts against a DNS black list. The first statement rejects messages
5781 from blacklisted hosts, whereas the second just inserts a warning header
5782 line.
5783 .code
5784 # require verify = csa
5785 .endd
5786 This commented-out line is an example of how you could turn on client SMTP
5787 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5788 records.
5789 .code
5790 accept
5791 .endd
5792 The final statement in the first ACL unconditionally accepts any recipient
5793 address that has successfully passed all the previous tests.
5794 .code
5795 acl_check_data:
5796 .endd
5797 This line marks the start of the second ACL, and names it. Most of the contents
5798 of this ACL are commented out:
5799 .code
5800 # deny    malware   = *
5801 #         message   = This message contains a virus \
5802 #                     ($malware_name).
5803 .endd
5804 These lines are examples of how to arrange for messages to be scanned for
5805 viruses when Exim has been compiled with the content-scanning extension, and a
5806 suitable virus scanner is installed. If the message is found to contain a
5807 virus, it is rejected with the given custom error message.
5808 .code
5809 # warn    spam      = nobody
5810 #         message   = X-Spam_score: $spam_score\n\
5811 #                     X-Spam_score_int: $spam_score_int\n\
5812 #                     X-Spam_bar: $spam_bar\n\
5813 #                     X-Spam_report: $spam_report
5814 .endd
5815 These lines are an example of how to arrange for messages to be scanned by
5816 SpamAssassin when Exim has been compiled with the content-scanning extension,
5817 and SpamAssassin has been installed. The SpamAssassin check is run with
5818 &`nobody`& as its user parameter, and the results are added to the message as a
5819 series of extra header line. In this case, the message is not rejected,
5820 whatever the spam score.
5821 .code
5822 accept
5823 .endd
5824 This final line in the DATA ACL accepts the message unconditionally.
5825
5826
5827 .section "Router configuration" "SECID55"
5828 .cindex "default" "routers"
5829 .cindex "routers" "default"
5830 The router configuration comes next in the default configuration, introduced
5831 by the line
5832 .code
5833 begin routers
5834 .endd
5835 Routers are the modules in Exim that make decisions about where to send
5836 messages. An address is passed to each router in turn, until it is either
5837 accepted, or failed. This means that the order in which you define the routers
5838 matters. Each router is fully described in its own chapter later in this
5839 manual. Here we give only brief overviews.
5840 .code
5841 # domain_literal:
5842 #   driver = ipliteral
5843 #   domains = !+local_domains
5844 #   transport = remote_smtp
5845 .endd
5846 .cindex "domain literal" "default router"
5847 This router is commented out because the majority of sites do not want to
5848 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5849 you uncomment this router, you also need to uncomment the setting of
5850 &%allow_domain_literals%& in the main part of the configuration.
5851 .code
5852 dnslookup:
5853   driver = dnslookup
5854   domains = ! +local_domains
5855   transport = remote_smtp
5856   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5857   no_more
5858 .endd
5859 The first uncommented router handles addresses that do not involve any local
5860 domains. This is specified by the line
5861 .code
5862 domains = ! +local_domains
5863 .endd
5864 The &%domains%& option lists the domains to which this router applies, but the
5865 exclamation mark is a negation sign, so the router is used only for domains
5866 that are not in the domain list called &'local_domains'& (which was defined at
5867 the start of the configuration). The plus sign before &'local_domains'&
5868 indicates that it is referring to a named list. Addresses in other domains are
5869 passed on to the following routers.
5870
5871 The name of the router driver is &(dnslookup)&,
5872 and is specified by the &%driver%& option. Do not be confused by the fact that
5873 the name of this router instance is the same as the name of the driver. The
5874 instance name is arbitrary, but the name set in the &%driver%& option must be
5875 one of the driver modules that is in the Exim binary.
5876
5877 The &(dnslookup)& router routes addresses by looking up their domains in the
5878 DNS in order to obtain a list of hosts to which the address is routed. If the
5879 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5880 specified by the &%transport%& option. If the router does not find the domain
5881 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5882 the address fails and is bounced.
5883
5884 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5885 be entirely ignored. This option is present because a number of cases have been
5886 encountered where MX records in the DNS point to host names
5887 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5888 Completely ignoring these IP addresses causes Exim to fail to route the
5889 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5890 continue to try to deliver the message periodically until the address timed
5891 out.
5892 .code
5893 system_aliases:
5894   driver = redirect
5895   allow_fail
5896   allow_defer
5897   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5898 # user = exim
5899   file_transport = address_file
5900   pipe_transport = address_pipe
5901 .endd
5902 Control reaches this and subsequent routers only for addresses in the local
5903 domains. This router checks to see whether the local part is defined as an
5904 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5905 data that it looks up from that file. If no data is found for the local part,
5906 the value of the &%data%& option is empty, causing the address to be passed to
5907 the next router.
5908
5909 &_/etc/aliases_& is a conventional name for the system aliases file that is
5910 often used. That is why it is referenced by from the default configuration
5911 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5912 &_Local/Makefile_& before building Exim.
5913 .code
5914 userforward:
5915   driver = redirect
5916   check_local_user
5917 # local_part_suffix = +* : -*
5918 # local_part_suffix_optional
5919   file = $home/.forward
5920 # allow_filter
5921   no_verify
5922   no_expn
5923   check_ancestor
5924   file_transport = address_file
5925   pipe_transport = address_pipe
5926   reply_transport = address_reply
5927 .endd
5928 This is the most complicated router in the default configuration. It is another
5929 redirection router, but this time it is looking for forwarding data set up by
5930 individual users. The &%check_local_user%& setting specifies a check that the
5931 local part of the address is the login name of a local user. If it is not, the
5932 router is skipped. The two commented options that follow &%check_local_user%&,
5933 namely:
5934 .code
5935 # local_part_suffix = +* : -*
5936 # local_part_suffix_optional
5937 .endd
5938 .vindex "&$local_part_suffix$&"
5939 show how you can specify the recognition of local part suffixes. If the first
5940 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5941 by any sequence of characters, is removed from the local part and placed in the
5942 variable &$local_part_suffix$&. The second suffix option specifies that the
5943 presence of a suffix in the local part is optional. When a suffix is present,
5944 the check for a local login uses the local part with the suffix removed.
5945
5946 When a local user account is found, the file called &_.forward_& in the user's
5947 home directory is consulted. If it does not exist, or is empty, the router
5948 declines. Otherwise, the contents of &_.forward_& are interpreted as
5949 redirection data (see chapter &<<CHAPredirect>>& for more details).
5950
5951 .cindex "Sieve filter" "enabling in default router"
5952 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5953 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5954 is commented out by default), the contents of the file are interpreted as a set
5955 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5956 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5957 separate document entitled &'Exim's interfaces to mail filtering'&.
5958
5959 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5960 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5961 There are two reasons for doing this:
5962
5963 .olist
5964 Whether or not a local user has a &_.forward_& file is not really relevant when
5965 checking an address for validity; it makes sense not to waste resources doing
5966 unnecessary work.
5967 .next
5968 More importantly, when Exim is verifying addresses or handling an EXPN
5969 command during an SMTP session, it is running as the Exim user, not as root.
5970 The group is the Exim group, and no additional groups are set up.
5971 It may therefore not be possible for Exim to read users' &_.forward_& files at
5972 this time.
5973 .endlist
5974
5975 The setting of &%check_ancestor%& prevents the router from generating a new
5976 address that is the same as any previous address that was redirected. (This
5977 works round a problem concerning a bad interaction between aliasing and
5978 forwarding &-- see section &<<SECTredlocmai>>&).
5979
5980 The final three option settings specify the transports that are to be used when
5981 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5982 auto-reply, respectively. For example, if a &_.forward_& file contains
5983 .code
5984 a.nother@elsewhere.example, /home/spqr/archive
5985 .endd
5986 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5987 transport.
5988 .code
5989 localuser:
5990   driver = accept
5991   check_local_user
5992 # local_part_suffix = +* : -*
5993 # local_part_suffix_optional
5994   transport = local_delivery
5995 .endd
5996 The final router sets up delivery into local mailboxes, provided that the local
5997 part is the name of a local login, by accepting the address and assigning it to
5998 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5999 routers, so the address is bounced. The commented suffix settings fulfil the
6000 same purpose as they do for the &(userforward)& router.
6001
6002
6003 .section "Transport configuration" "SECID56"
6004 .cindex "default" "transports"
6005 .cindex "transports" "default"
6006 Transports define mechanisms for actually delivering messages. They operate
6007 only when referenced from routers, so the order in which they are defined does
6008 not matter. The transports section of the configuration starts with
6009 .code
6010 begin transports
6011 .endd
6012 One remote transport and four local transports are defined.
6013 .code
6014 remote_smtp:
6015   driver = smtp
6016   hosts_try_prdr = *
6017 .endd
6018 This transport is used for delivering messages over SMTP connections.
6019 The list of remote hosts comes from the router.
6020 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6021 It is negotiated between client and server
6022 and not expected to cause problems but can be disabled if needed.
6023 All other options are defaulted.
6024 .code
6025 local_delivery:
6026   driver = appendfile
6027   file = /var/mail/$local_part
6028   delivery_date_add
6029   envelope_to_add
6030   return_path_add
6031 # group = mail
6032 # mode = 0660
6033 .endd
6034 This &(appendfile)& transport is used for local delivery to user mailboxes in
6035 traditional BSD mailbox format. By default it runs under the uid and gid of the
6036 local user, which requires the sticky bit to be set on the &_/var/mail_&
6037 directory. Some systems use the alternative approach of running mail deliveries
6038 under a particular group instead of using the sticky bit. The commented options
6039 show how this can be done.
6040
6041 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6042 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6043 similarly-named options above.
6044 .code
6045 address_pipe:
6046   driver = pipe
6047   return_output
6048 .endd
6049 This transport is used for handling deliveries to pipes that are generated by
6050 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6051 option specifies that any output generated by the pipe is to be returned to the
6052 sender.
6053 .code
6054 address_file:
6055   driver = appendfile
6056   delivery_date_add
6057   envelope_to_add
6058   return_path_add
6059 .endd
6060 This transport is used for handling deliveries to files that are generated by
6061 redirection. The name of the file is not specified in this instance of
6062 &(appendfile)&, because it comes from the &(redirect)& router.
6063 .code
6064 address_reply:
6065   driver = autoreply
6066 .endd
6067 This transport is used for handling automatic replies generated by users'
6068 filter files.
6069
6070
6071
6072 .section "Default retry rule" "SECID57"
6073 .cindex "retry" "default rule"
6074 .cindex "default" "retry rule"
6075 The retry section of the configuration file contains rules which affect the way
6076 Exim retries deliveries that cannot be completed at the first attempt. It is
6077 introduced by the line
6078 .code
6079 begin retry
6080 .endd
6081 In the default configuration, there is just one rule, which applies to all
6082 errors:
6083 .code
6084 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6085 .endd
6086 This causes any temporarily failing address to be retried every 15 minutes for
6087 2 hours, then at intervals starting at one hour and increasing by a factor of
6088 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6089 is not delivered after 4 days of temporary failure, it is bounced.
6090
6091 If the retry section is removed from the configuration, or is empty (that is,
6092 if no retry rules are defined), Exim will not retry deliveries. This turns
6093 temporary errors into permanent errors.
6094
6095
6096 .section "Rewriting configuration" "SECID58"
6097 The rewriting section of the configuration, introduced by
6098 .code
6099 begin rewrite
6100 .endd
6101 contains rules for rewriting addresses in messages as they arrive. There are no
6102 rewriting rules in the default configuration file.
6103
6104
6105
6106 .section "Authenticators configuration" "SECTdefconfauth"
6107 .cindex "AUTH" "configuration"
6108 The authenticators section of the configuration, introduced by
6109 .code
6110 begin authenticators
6111 .endd
6112 defines mechanisms for the use of the SMTP AUTH command. The default
6113 configuration file contains two commented-out example authenticators
6114 which support plaintext username/password authentication using the
6115 standard PLAIN mechanism and the traditional but non-standard LOGIN
6116 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6117 to support most MUA software.
6118
6119 The example PLAIN authenticator looks like this:
6120 .code
6121 #PLAIN:
6122 #  driver                  = plaintext
6123 #  server_set_id           = $auth2
6124 #  server_prompts          = :
6125 #  server_condition        = Authentication is not yet configured
6126 #  server_advertise_condition = ${if def:tls_in_cipher }
6127 .endd
6128 And the example LOGIN authenticator looks like this:
6129 .code
6130 #LOGIN:
6131 #  driver                  = plaintext
6132 #  server_set_id           = $auth1
6133 #  server_prompts          = <| Username: | Password:
6134 #  server_condition        = Authentication is not yet configured
6135 #  server_advertise_condition = ${if def:tls_in_cipher }
6136 .endd
6137
6138 The &%server_set_id%& option makes Exim remember the authenticated username
6139 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6140 &%server_prompts%& option configures the &(plaintext)& authenticator so
6141 that it implements the details of the specific authentication mechanism,
6142 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6143 when Exim offers authentication to clients; in the examples, this is only
6144 when TLS or SSL has been started, so to enable the authenticators you also
6145 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6146
6147 The &%server_condition%& setting defines how to verify that the username and
6148 password are correct. In the examples it just produces an error message.
6149 To make the authenticators work, you can use a string expansion
6150 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6151
6152 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6153 usercode and password are in different positions.
6154 Chapter &<<CHAPplaintext>>& covers both.
6155
6156 .ecindex IIDconfiwal
6157
6158
6159
6160 . ////////////////////////////////////////////////////////////////////////////
6161 . ////////////////////////////////////////////////////////////////////////////
6162
6163 .chapter "Regular expressions" "CHAPregexp"
6164
6165 .cindex "regular expressions" "library"
6166 .cindex "PCRE"
6167 Exim supports the use of regular expressions in many of its options. It
6168 uses the PCRE regular expression library; this provides regular expression
6169 matching that is compatible with Perl 5. The syntax and semantics of
6170 regular expressions is discussed in many Perl reference books, and also in
6171 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6172 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6173
6174 The documentation for the syntax and semantics of the regular expressions that
6175 are supported by PCRE is included in the PCRE distribution, and no further
6176 description is included here. The PCRE functions are called from Exim using
6177 the default option settings (that is, with no PCRE options set), except that
6178 the PCRE_CASELESS option is set when the matching is required to be
6179 case-insensitive.
6180
6181 In most cases, when a regular expression is required in an Exim configuration,
6182 it has to start with a circumflex, in order to distinguish it from plain text
6183 or an &"ends with"& wildcard. In this example of a configuration setting, the
6184 second item in the colon-separated list is a regular expression.
6185 .code
6186 domains = a.b.c : ^\\d{3} : *.y.z : ...
6187 .endd
6188 The doubling of the backslash is required because of string expansion that
6189 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6190 of this issue, and a way of avoiding the need for doubling backslashes. The
6191 regular expression that is eventually used in this example contains just one
6192 backslash. The circumflex is included in the regular expression, and has the
6193 normal effect of &"anchoring"& it to the start of the string that is being
6194 matched.
6195
6196 There are, however, two cases where a circumflex is not required for the
6197 recognition of a regular expression: these are the &%match%& condition in a
6198 string expansion, and the &%matches%& condition in an Exim filter file. In
6199 these cases, the relevant string is always treated as a regular expression; if
6200 it does not start with a circumflex, the expression is not anchored, and can
6201 match anywhere in the subject string.
6202
6203 In all cases, if you want a regular expression to match at the end of a string,
6204 you must code the $ metacharacter to indicate this. For example:
6205 .code
6206 domains = ^\\d{3}\\.example
6207 .endd
6208 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6209 You need to use:
6210 .code
6211 domains = ^\\d{3}\\.example\$
6212 .endd
6213 if you want &'example'& to be the top-level domain. The backslash before the
6214 $ is needed because string expansion also interprets dollar characters.
6215
6216
6217
6218 . ////////////////////////////////////////////////////////////////////////////
6219 . ////////////////////////////////////////////////////////////////////////////
6220
6221 .chapter "File and database lookups" "CHAPfdlookup"
6222 .scindex IIDfidalo1 "file" "lookups"
6223 .scindex IIDfidalo2 "database" "lookups"
6224 .cindex "lookup" "description of"
6225 Exim can be configured to look up data in files or databases as it processes
6226 messages. Two different kinds of syntax are used:
6227
6228 .olist
6229 A string that is to be expanded may contain explicit lookup requests. These
6230 cause parts of the string to be replaced by data that is obtained from the
6231 lookup. Lookups of this type are conditional expansion items. Different results
6232 can be defined for the cases of lookup success and failure. See chapter
6233 &<<CHAPexpand>>&, where string expansions are described in detail.
6234 .next
6235 Lists of domains, hosts, and email addresses can contain lookup requests as a
6236 way of avoiding excessively long linear lists. In this case, the data that is
6237 returned by the lookup is often (but not always) discarded; whether the lookup
6238 succeeds or fails is what really counts. These kinds of list are described in
6239 chapter &<<CHAPdomhosaddlists>>&.
6240 .endlist
6241
6242 String expansions, lists, and lookups interact with each other in such a way
6243 that there is no order in which to describe any one of them that does not
6244 involve references to the others. Each of these three chapters makes more sense
6245 if you have read the other two first. If you are reading this for the first
6246 time, be aware that some of it will make a lot more sense after you have read
6247 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6248
6249 .section "Examples of different lookup syntax" "SECID60"
6250 It is easy to confuse the two different kinds of lookup, especially as the
6251 lists that may contain the second kind are always expanded before being
6252 processed as lists. Therefore, they may also contain lookups of the first kind.
6253 Be careful to distinguish between the following two examples:
6254 .code
6255 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6256 domains = lsearch;/some/file
6257 .endd
6258 The first uses a string expansion, the result of which must be a domain list.
6259 No strings have been specified for a successful or a failing lookup; the
6260 defaults in this case are the looked-up data and an empty string, respectively.
6261 The expansion takes place before the string is processed as a list, and the
6262 file that is searched could contain lines like this:
6263 .code
6264 192.168.3.4: domain1:domain2:...
6265 192.168.1.9: domain3:domain4:...
6266 .endd
6267 When the lookup succeeds, the result of the expansion is a list of domains (and
6268 possibly other types of item that are allowed in domain lists).
6269
6270 In the second example, the lookup is a single item in a domain list. It causes
6271 Exim to use a lookup to see if the domain that is being processed can be found
6272 in the file. The file could contains lines like this:
6273 .code
6274 domain1:
6275 domain2:
6276 .endd
6277 Any data that follows the keys is not relevant when checking that the domain
6278 matches the list item.
6279
6280 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6281 Consider a file containing lines like this:
6282 .code
6283 192.168.5.6: lsearch;/another/file
6284 .endd
6285 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6286 first &%domains%& setting above generates the second setting, which therefore
6287 causes a second lookup to occur.
6288
6289 The rest of this chapter describes the different lookup types that are
6290 available. Any of them can be used in any part of the configuration where a
6291 lookup is permitted.
6292
6293
6294 .section "Lookup types" "SECID61"
6295 .cindex "lookup" "types of"
6296 .cindex "single-key lookup" "definition of"
6297 Two different types of data lookup are implemented:
6298
6299 .ilist
6300 The &'single-key'& type requires the specification of a file in which to look,
6301 and a single key to search for. The key must be a non-empty string for the
6302 lookup to succeed. The lookup type determines how the file is searched.
6303 .next
6304 .cindex "query-style lookup" "definition of"
6305 The &'query-style'& type accepts a generalized database query. No particular
6306 key value is assumed by Exim for query-style lookups. You can use whichever
6307 Exim variables you need to construct the database query.
6308 .endlist
6309
6310 The code for each lookup type is in a separate source file that is included in
6311 the binary of Exim only if the corresponding compile-time option is set. The
6312 default settings in &_src/EDITME_& are:
6313 .code
6314 LOOKUP_DBM=yes
6315 LOOKUP_LSEARCH=yes
6316 .endd
6317 which means that only linear searching and DBM lookups are included by default.
6318 For some types of lookup (e.g. SQL databases), you need to install appropriate
6319 libraries and header files before building Exim.
6320
6321
6322
6323
6324 .section "Single-key lookup types" "SECTsinglekeylookups"
6325 .cindex "lookup" "single-key types"
6326 .cindex "single-key lookup" "list of types"
6327 The following single-key lookup types are implemented:
6328
6329 .ilist
6330 .cindex "cdb" "description of"
6331 .cindex "lookup" "cdb"
6332 .cindex "binary zero" "in lookup key"
6333 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6334 string without a terminating binary zero. The cdb format is designed for
6335 indexed files that are read frequently and never updated, except by total
6336 re-creation. As such, it is particularly suitable for large files containing
6337 aliases or other indexed data referenced by an MTA. Information about cdb can
6338 be found in several places:
6339 .display
6340 &url(http://www.pobox.com/~djb/cdb.html)
6341 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6342 &url(http://packages.debian.org/stable/utils/freecdb.html)
6343 .endd
6344 A cdb distribution is not needed in order to build Exim with cdb support,
6345 because the code for reading cdb files is included directly in Exim itself.
6346 However, no means of building or testing cdb files is provided with Exim, so
6347 you need to obtain a cdb distribution in order to do this.
6348 .next
6349 .cindex "DBM" "lookup type"
6350 .cindex "lookup" "dbm"
6351 .cindex "binary zero" "in lookup key"
6352 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6353 DBM file by looking up the record with the given key. A terminating binary
6354 zero is included in the key that is passed to the DBM library. See section
6355 &<<SECTdb>>& for a discussion of DBM libraries.
6356
6357 .cindex "Berkeley DB library" "file format"
6358 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6359 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6360 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6361 the DB_UNKNOWN option. This enables it to handle any of the types of database
6362 that the library supports, and can be useful for accessing DBM files created by
6363 other applications. (For earlier DB versions, DB_HASH is always used.)
6364 .next
6365 .cindex "lookup" "dbmjz"
6366 .cindex "lookup" "dbm &-- embedded NULs"
6367 .cindex "sasldb2"
6368 .cindex "dbmjz lookup type"
6369 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6370 interpreted as an Exim list; the elements of the list are joined together with
6371 ASCII NUL characters to form the lookup key.  An example usage would be to
6372 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6373 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6374 &(cram_md5)& authenticator.
6375 .next
6376 .cindex "lookup" "dbmnz"
6377 .cindex "lookup" "dbm &-- terminating zero"
6378 .cindex "binary zero" "in lookup key"
6379 .cindex "Courier"
6380 .cindex "&_/etc/userdbshadow.dat_&"
6381 .cindex "dbmnz lookup type"
6382 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6383 is not included in the key that is passed to the DBM library. You may need this
6384 if you want to look up data in files that are created by or shared with some
6385 other application that does not use terminating zeros. For example, you need to
6386 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6387 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6388 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6389 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6390 .next
6391 .cindex "lookup" "dsearch"
6392 .cindex "dsearch lookup type"
6393 &(dsearch)&: The given file must be a directory; this is searched for an entry
6394 whose name is the key by calling the &[lstat()]& function. The key may not
6395 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6396 the lookup is the name of the entry, which may be a file, directory,
6397 symbolic link, or any other kind of directory entry. An example of how this
6398 lookup can be used to support virtual domains is given in section
6399 &<<SECTvirtualdomains>>&.
6400 .next
6401 .cindex "lookup" "iplsearch"
6402 .cindex "iplsearch lookup type"
6403 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6404 terminated by a colon or white space or the end of the line. The keys in the
6405 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6406 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6407 being interpreted as a key terminator. For example:
6408 .code
6409 1.2.3.4:           data for 1.2.3.4
6410 192.168.0.0/16:    data for 192.168.0.0/16
6411 "abcd::cdab":      data for abcd::cdab
6412 "abcd:abcd::/32"   data for abcd:abcd::/32
6413 .endd
6414 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6415 file is searched linearly, using the CIDR masks where present, until a matching
6416 key is found. The first key that matches is used; there is no attempt to find a
6417 &"best"& match. Apart from the way the keys are matched, the processing for
6418 &(iplsearch)& is the same as for &(lsearch)&.
6419
6420 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6421 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6422 lookup types support only literal keys.
6423
6424 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6425 the implicit key is the host's IP address rather than its name (see section
6426 &<<SECThoslispatsikey>>&).
6427 .next
6428 .cindex "linear search"
6429 .cindex "lookup" "lsearch"
6430 .cindex "lsearch lookup type"
6431 .cindex "case sensitivity" "in lsearch lookup"
6432 &(lsearch)&: The given file is a text file that is searched linearly for a
6433 line beginning with the search key, terminated by a colon or white space or the
6434 end of the line. The search is case-insensitive; that is, upper and lower case
6435 letters are treated as the same. The first occurrence of the key that is found
6436 in the file is used.
6437
6438 White space between the key and the colon is permitted. The remainder of the
6439 line, with leading and trailing white space removed, is the data. This can be
6440 continued onto subsequent lines by starting them with any amount of white
6441 space, but only a single space character is included in the data at such a
6442 junction. If the data begins with a colon, the key must be terminated by a
6443 colon, for example:
6444 .code
6445 baduser:  :fail:
6446 .endd
6447 Empty lines and lines beginning with # are ignored, even if they occur in the
6448 middle of an item. This is the traditional textual format of alias files. Note
6449 that the keys in an &(lsearch)& file are literal strings. There is no
6450 wildcarding of any kind.
6451
6452 .cindex "lookup" "lsearch &-- colons in keys"
6453 .cindex "white space" "in lsearch key"
6454 In most &(lsearch)& files, keys are not required to contain colons or #
6455 characters, or white space. However, if you need this feature, it is available.
6456 If a key begins with a doublequote character, it is terminated only by a
6457 matching quote (or end of line), and the normal escaping rules apply to its
6458 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6459 quoted keys (exactly as for unquoted keys). There is no special handling of
6460 quotes for the data part of an &(lsearch)& line.
6461
6462 .next
6463 .cindex "NIS lookup type"
6464 .cindex "lookup" "NIS"
6465 .cindex "binary zero" "in lookup key"
6466 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6467 the given key, without a terminating binary zero. There is a variant called
6468 &(nis0)& which does include the terminating binary zero in the key. This is
6469 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6470 aliases; the full map names must be used.
6471
6472 .next
6473 .cindex "wildlsearch lookup type"
6474 .cindex "lookup" "wildlsearch"
6475 .cindex "nwildlsearch lookup type"
6476 .cindex "lookup" "nwildlsearch"
6477 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6478 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6479 the file may be wildcarded. The difference between these two lookup types is
6480 that for &(wildlsearch)&, each key in the file is string-expanded before being
6481 used, whereas for &(nwildlsearch)&, no expansion takes place.
6482
6483 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6484 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6485 file that are regular expressions can be made case-sensitive by the use of
6486 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6487
6488 . ==== As this is a nested list, any displays it contains must be indented
6489 . ==== as otherwise they are too far to the left.
6490
6491 .olist
6492 The string may begin with an asterisk to mean &"ends with"&. For example:
6493 .code
6494     *.a.b.c       data for anything.a.b.c
6495     *fish         data for anythingfish
6496 .endd
6497 .next
6498 The string may begin with a circumflex to indicate a regular expression. For
6499 example, for &(wildlsearch)&:
6500 .code
6501     ^\N\d+\.a\.b\N    data for <digits>.a.b
6502 .endd
6503 Note the use of &`\N`& to disable expansion of the contents of the regular
6504 expression. If you are using &(nwildlsearch)&, where the keys are not
6505 string-expanded, the equivalent entry is:
6506 .code
6507     ^\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509 The case-insensitive flag is set at the start of compiling the regular
6510 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6511 For example, to make the entire pattern case-sensitive:
6512 .code
6513     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6514 .endd
6515
6516 If the regular expression contains white space or colon characters, you must
6517 either quote it (see &(lsearch)& above), or represent these characters in other
6518 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6519 colon. This may be easier than quoting, because if you quote, you have to
6520 escape all the backslashes inside the quotes.
6521
6522 &*Note*&: It is not possible to capture substrings in a regular expression
6523 match for later use, because the results of all lookups are cached. If a lookup
6524 is repeated, the result is taken from the cache, and no actual pattern matching
6525 takes place. The values of all the numeric variables are unset after a
6526 &((n)wildlsearch)& match.
6527
6528 .next
6529 Although I cannot see it being of much use, the general matching function that
6530 is used to implement &((n)wildlsearch)& means that the string may begin with a
6531 lookup name terminated by a semicolon, and followed by lookup data. For
6532 example:
6533 .code
6534     cdb;/some/file  data for keys that match the file
6535 .endd
6536 The data that is obtained from the nested lookup is discarded.
6537 .endlist olist
6538
6539 Keys that do not match any of these patterns are interpreted literally. The
6540 continuation rules for the data are the same as for &(lsearch)&, and keys may
6541 be followed by optional colons.
6542
6543 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6544 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6545 lookup types support only literal keys.
6546 .endlist ilist
6547
6548
6549 .section "Query-style lookup types" "SECID62"
6550 .cindex "lookup" "query-style types"
6551 .cindex "query-style lookup" "list of types"
6552 The supported query-style lookup types are listed below. Further details about
6553 many of them are given in later sections.
6554
6555 .ilist
6556 .cindex "DNS" "as a lookup type"
6557 .cindex "lookup" "DNS"
6558 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6559 are given in the supplied query. The resulting data is the contents of the
6560 records. See section &<<SECTdnsdb>>&.
6561 .next
6562 .cindex "InterBase lookup type"
6563 .cindex "lookup" "InterBase"
6564 &(ibase)&: This does a lookup in an InterBase database.
6565 .next
6566 .cindex "LDAP" "lookup type"
6567 .cindex "lookup" "LDAP"
6568 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6569 returns attributes from a single entry. There is a variant called &(ldapm)&
6570 that permits values from multiple entries to be returned. A third variant
6571 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6572 any attribute values. See section &<<SECTldap>>&.
6573 .next
6574 .cindex "MySQL" "lookup type"
6575 .cindex "lookup" "MySQL"
6576 &(mysql)&: The format of the query is an SQL statement that is passed to a
6577 MySQL database. See section &<<SECTsql>>&.
6578 .next
6579 .cindex "NIS+ lookup type"
6580 .cindex "lookup" "NIS+"
6581 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6582 the field to be returned. See section &<<SECTnisplus>>&.
6583 .next
6584 .cindex "Oracle" "lookup type"
6585 .cindex "lookup" "Oracle"
6586 &(oracle)&: The format of the query is an SQL statement that is passed to an
6587 Oracle database. See section &<<SECTsql>>&.
6588 .next
6589 .cindex "lookup" "passwd"
6590 .cindex "passwd lookup type"
6591 .cindex "&_/etc/passwd_&"
6592 &(passwd)& is a query-style lookup with queries that are just user names. The
6593 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6594 success, the result string is the same as you would get from an &(lsearch)&
6595 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6596 password value. For example:
6597 .code
6598 *:42:42:King Rat:/home/kr:/bin/bash
6599 .endd
6600 .next
6601 .cindex "PostgreSQL lookup type"
6602 .cindex "lookup" "PostgreSQL"
6603 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6604 PostgreSQL database. See section &<<SECTsql>>&.
6605
6606 .next
6607 .cindex "sqlite lookup type"
6608 .cindex "lookup" "sqlite"
6609 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6610 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6611
6612 .next
6613 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6614 not likely to be useful in normal operation.
6615 .next
6616 .cindex "whoson lookup type"
6617 .cindex "lookup" "whoson"
6618 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6619 allows a server to check whether a particular (dynamically allocated) IP
6620 address is currently allocated to a known (trusted) user and, optionally, to
6621 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6622 at one time for &"POP before SMTP"& authentication, but that approach has been
6623 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6624 &"POP before SMTP"& checking using ACL statements such as
6625 .code
6626 require condition = \
6627   ${lookup whoson {$sender_host_address}{yes}{no}}
6628 .endd
6629 The query consists of a single IP address. The value returned is the name of
6630 the authenticated user, which is stored in the variable &$value$&. However, in
6631 this example, the data in &$value$& is not used; the result of the lookup is
6632 one of the fixed strings &"yes"& or &"no"&.
6633 .endlist
6634
6635
6636
6637 .section "Temporary errors in lookups" "SECID63"
6638 .cindex "lookup" "temporary error in"
6639 Lookup functions can return temporary error codes if the lookup cannot be
6640 completed. For example, an SQL or LDAP database might be unavailable. For this
6641 reason, it is not advisable to use a lookup that might do this for critical
6642 options such as a list of local domains.
6643
6644 When a lookup cannot be completed in a router or transport, delivery
6645 of the message (to the relevant address) is deferred, as for any other
6646 temporary error. In other circumstances Exim may assume the lookup has failed,
6647 or may give up altogether.
6648
6649
6650
6651 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6652 .cindex "wildcard lookups"
6653 .cindex "lookup" "default values"
6654 .cindex "lookup" "wildcard"
6655 .cindex "lookup" "* added to type"
6656 .cindex "default" "in single-key lookups"
6657 In this context, a &"default value"& is a value specified by the administrator
6658 that is to be used if a lookup fails.
6659
6660 &*Note:*& This section applies only to single-key lookups. For query-style
6661 lookups, the facilities of the query language must be used. An attempt to
6662 specify a default for a query-style lookup provokes an error.
6663
6664 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6665 and the initial lookup fails, the key &"*"& is looked up in the file to
6666 provide a default value. See also the section on partial matching below.
6667
6668 .cindex "*@ with single-key lookup"
6669 .cindex "lookup" "*@ added to type"
6670 .cindex "alias file" "per-domain default"
6671 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6672 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6673 character, a second lookup is done with everything before the last @ replaced
6674 by *. This makes it possible to provide per-domain defaults in alias files
6675 that include the domains in the keys. If the second lookup fails (or doesn't
6676 take place because there is no @ in the key), &"*"& is looked up.
6677 For example, a &(redirect)& router might contain:
6678 .code
6679 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6680 .endd
6681 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6682 looks up these keys, in this order:
6683 .code
6684 jane@eyre.example
6685 *@eyre.example
6686 *
6687 .endd
6688 The data is taken from whichever key it finds first. &*Note*&: In an
6689 &(lsearch)& file, this does not mean the first of these keys in the file. A
6690 complete scan is done for each key, and only if it is not found at all does
6691 Exim move on to try the next key.
6692
6693
6694
6695 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6696 .cindex "partial matching"
6697 .cindex "wildcard lookups"
6698 .cindex "lookup" "partial matching"
6699 .cindex "lookup" "wildcard"
6700 .cindex "asterisk" "in search type"
6701 The normal operation of a single-key lookup is to search the file for an exact
6702 match with the given key. However, in a number of situations where domains are
6703 being looked up, it is useful to be able to do partial matching. In this case,
6704 information in the file that has a key starting with &"*."& is matched by any
6705 domain that ends with the components that follow the full stop. For example, if
6706 a key in a DBM file is
6707 .code
6708 *.dates.fict.example
6709 .endd
6710 then when partial matching is enabled this is matched by (amongst others)
6711 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6712 by &'dates.fict.example'&, if that does not appear as a separate key in the
6713 file.
6714
6715 &*Note*&: Partial matching is not available for query-style lookups. It is
6716 also not available for any lookup items in address lists (see section
6717 &<<SECTaddresslist>>&).
6718
6719 Partial matching is implemented by doing a series of separate lookups using
6720 keys constructed by modifying the original subject key. This means that it can
6721 be used with any of the single-key lookup types, provided that
6722 partial matching keys
6723 beginning with a special prefix (default &"*."&) are included in the data file.
6724 Keys in the file that do not begin with the prefix are matched only by
6725 unmodified subject keys when partial matching is in use.
6726
6727 Partial matching is requested by adding the string &"partial-"& to the front of
6728 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6729 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6730 is added at the start of the subject key, and it is looked up again. If that
6731 fails, further lookups are tried with dot-separated components removed from the
6732 start of the subject key, one-by-one, and &"*."& added on the front of what
6733 remains.
6734
6735 A minimum number of two non-* components are required. This can be adjusted
6736 by including a number before the hyphen in the search type. For example,
6737 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6738 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6739 subject key is &'2250.dates.fict.example'& then the following keys are looked
6740 up when the minimum number of non-* components is two:
6741 .code
6742 2250.dates.fict.example
6743 *.2250.dates.fict.example
6744 *.dates.fict.example
6745 *.fict.example
6746 .endd
6747 As soon as one key in the sequence is successfully looked up, the lookup
6748 finishes.
6749
6750 .cindex "lookup" "partial matching &-- changing prefix"
6751 .cindex "prefix" "for partial matching"
6752 The use of &"*."& as the partial matching prefix is a default that can be
6753 changed. The motivation for this feature is to allow Exim to operate with file
6754 formats that are used by other MTAs. A different prefix can be supplied in
6755 parentheses instead of the hyphen after &"partial"&. For example:
6756 .code
6757 domains = partial(.)lsearch;/some/file
6758 .endd
6759 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6760 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6761 components is unchanged). The prefix may consist of any punctuation characters
6762 other than a closing parenthesis. It may be empty, for example:
6763 .code
6764 domains = partial1()cdb;/some/file
6765 .endd
6766 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6767 &`a.b.c`&, &`b.c`&, and &`c`&.
6768
6769 If &"partial0"& is specified, what happens at the end (when the lookup with
6770 just one non-wild component has failed, and the original key is shortened right
6771 down to the null string) depends on the prefix:
6772
6773 .ilist
6774 If the prefix has zero length, the whole lookup fails.
6775 .next
6776 If the prefix has length 1, a lookup for just the prefix is done. For
6777 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6778 .next
6779 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6780 remainder is looked up. With the default prefix, therefore, the final lookup is
6781 for &"*"& on its own.
6782 .next
6783 Otherwise, the whole prefix is looked up.
6784 .endlist
6785
6786
6787 If the search type ends in &"*"& or &"*@"& (see section
6788 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6789 this implies happens after all partial lookups have failed. If &"partial0"& is
6790 specified, adding &"*"& to the search type has no effect with the default
6791 prefix, because the &"*"& key is already included in the sequence of partial
6792 lookups. However, there might be a use for lookup types such as
6793 &"partial0(.)lsearch*"&.
6794
6795 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6796 in domain lists and the like. Partial matching works only in terms of
6797 dot-separated components; a key such as &`*fict.example`&
6798 in a database file is useless, because the asterisk in a partial matching
6799 subject key is always followed by a dot.
6800
6801
6802
6803
6804 .section "Lookup caching" "SECID64"
6805 .cindex "lookup" "caching"
6806 .cindex "caching" "lookup data"
6807 Exim caches all lookup results in order to avoid needless repetition of
6808 lookups. However, because (apart from the daemon) Exim operates as a collection
6809 of independent, short-lived processes, this caching applies only within a
6810 single Exim process. There is no inter-process lookup caching facility.
6811
6812 For single-key lookups, Exim keeps the relevant files open in case there is
6813 another lookup that needs them. In some types of configuration this can lead to
6814 many files being kept open for messages with many recipients. To avoid hitting
6815 the operating system limit on the number of simultaneously open files, Exim
6816 closes the least recently used file when it needs to open more files than its
6817 own internal limit, which can be changed via the &%lookup_open_max%& option.
6818
6819 The single-key lookup files are closed and the lookup caches are flushed at
6820 strategic points during delivery &-- for example, after all routing is
6821 complete.
6822
6823
6824
6825
6826 .section "Quoting lookup data" "SECID65"
6827 .cindex "lookup" "quoting"
6828 .cindex "quoting" "in lookups"
6829 When data from an incoming message is included in a query-style lookup, there
6830 is the possibility of special characters in the data messing up the syntax of
6831 the query. For example, a NIS+ query that contains
6832 .code
6833 [name=$local_part]
6834 .endd
6835 will be broken if the local part happens to contain a closing square bracket.
6836 For NIS+, data can be enclosed in double quotes like this:
6837 .code
6838 [name="$local_part"]
6839 .endd
6840 but this still leaves the problem of a double quote in the data. The rule for
6841 NIS+ is that double quotes must be doubled. Other lookup types have different
6842 rules, and to cope with the differing requirements, an expansion operator
6843 of the following form is provided:
6844 .code
6845 ${quote_<lookup-type>:<string>}
6846 .endd
6847 For example, the safest way to write the NIS+ query is
6848 .code
6849 [name="${quote_nisplus:$local_part}"]
6850 .endd
6851 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6852 operator can be used for all lookup types, but has no effect for single-key
6853 lookups, since no quoting is ever needed in their key strings.
6854
6855
6856
6857
6858 .section "More about dnsdb" "SECTdnsdb"
6859 .cindex "dnsdb lookup"
6860 .cindex "lookup" "dnsdb"
6861 .cindex "DNS" "as a lookup type"
6862 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6863 of a record type and a domain name, separated by an equals sign. For example,
6864 an expansion string could contain:
6865 .code
6866 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6867 .endd
6868 If the lookup succeeds, the result is placed in &$value$&, which in this case
6869 is used on its own as the result. If the lookup does not succeed, the
6870 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6871 &<<SECTforexpfai>>& for an explanation of what this means.
6872
6873 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6874 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6875 configured). If no type is given, TXT is assumed. When the type is PTR,
6876 the data can be an IP address, written as normal; inversion and the addition of
6877 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6878 .code
6879 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6880 .endd
6881 If the data for a PTR record is not a syntactically valid IP address, it is not
6882 altered and nothing is added.
6883
6884 For any record type, if multiple records are found (or, for A6 lookups, if a
6885 single record leads to multiple addresses), the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895
6896 .cindex "MX record" "in &(dnsdb)& lookup"
6897 .cindex "SRV record" "in &(dnsdb)& lookup"
6898 For an MX lookup, both the preference value and the host name are returned for
6899 each record, separated by a space. For an SRV lookup, the priority, weight,
6900 port, and host name are returned for each record, separated by spaces.
6901 .new
6902 An alternate field separator can be specified using a comma after the main
6903 separator character, followed immediately by the field separator.
6904 .wen
6905
6906 .cindex "TXT record" "in &(dnsdb)& lookup"
6907 .cindex "SPF record" "in &(dnsdb)& lookup"
6908 For TXT records with multiple items of data, only the first item is returned,
6909 unless a separator for them is specified using a comma after the separator
6910 character followed immediately by the TXT record item separator. To concatenate
6911 items without a separator, use a semicolon instead. For SPF records the
6912 default behaviour is to concatenate multiple items without using a separator.
6913 .code
6914 ${lookup dnsdb{>\n,: txt=a.b.example}}
6915 ${lookup dnsdb{>\n; txt=a.b.example}}
6916 ${lookup dnsdb{spf=example.org}}
6917 .endd
6918 It is permitted to specify a space as the separator character. Further
6919 white space is ignored.
6920
6921 .section "Pseudo dnsdb record types" "SECID66"
6922 .cindex "MX record" "in &(dnsdb)& lookup"
6923 By default, both the preference value and the host name are returned for
6924 each MX record, separated by a space. If you want only host names, you can use
6925 the pseudo-type MXH:
6926 .code
6927 ${lookup dnsdb{mxh=a.b.example}}
6928 .endd
6929 In this case, the preference values are omitted, and just the host names are
6930 returned.
6931
6932 .cindex "name server for enclosing domain"
6933 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6934 records on the given domain, but if none are found, it removes the first
6935 component of the domain name, and tries again. This process continues until NS
6936 records are found or there are no more components left (or there is a DNS
6937 error). In other words, it may return the name servers for a top-level domain,
6938 but it never returns the root name servers. If there are no NS records for the
6939 top-level domain, the lookup fails. Consider these examples:
6940 .code
6941 ${lookup dnsdb{zns=xxx.quercite.com}}
6942 ${lookup dnsdb{zns=xxx.edu}}
6943 .endd
6944 Assuming that in each case there are no NS records for the full domain name,
6945 the first returns the name servers for &%quercite.com%&, and the second returns
6946 the name servers for &%edu%&.
6947
6948 You should be careful about how you use this lookup because, unless the
6949 top-level domain does not exist, the lookup always returns some host names. The
6950 sort of use to which this might be put is for seeing if the name servers for a
6951 given domain are on a blacklist. You can probably assume that the name servers
6952 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6953 such a list.
6954
6955 .cindex "CSA" "in &(dnsdb)& lookup"
6956 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6957 records according to the CSA rules, which are described in section
6958 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6959 not sufficient because of the extra parent domain search behaviour of CSA. The
6960 result of a successful lookup such as:
6961 .code
6962 ${lookup dnsdb {csa=$sender_helo_name}}
6963 .endd
6964 has two space-separated fields: an authorization code and a target host name.
6965 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6966 authorization required but absent, or &"?"& for unknown.
6967
6968 .cindex "A+" "in &(dnsdb)& lookup"
6969 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6970 and then an A lookup.  All results are returned; defer processing
6971 (see below) is handled separately for each lookup.  Example:
6972 .code
6973 ${lookup dnsdb {>; a+=$sender_helo_name}}
6974 .endd
6975
6976
6977 .section "Multiple dnsdb lookups" "SECID67"
6978 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6979 However, you can specify a list of domains or IP addresses in a single
6980 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6981 the default separator, but with the ability to change this. For example:
6982 .code
6983 ${lookup dnsdb{one.domain.com:two.domain.com}}
6984 ${lookup dnsdb{a=one.host.com:two.host.com}}
6985 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6986 .endd
6987 In order to retain backwards compatibility, there is one special case: if
6988 the lookup type is PTR and no change of separator is specified, Exim looks
6989 to see if the rest of the string is precisely one IPv6 address. In this
6990 case, it does not treat it as a list.
6991
6992 The data from each lookup is concatenated, with newline separators by default,
6993 in the same way that multiple DNS records for a single item are handled. A
6994 different separator can be specified, as described above.
6995
6996 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6997 each followed by a comma,
6998 that may appear before the record type.
6999
7000 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7001 temporary DNS error for any of them, the behaviour is controlled by
7002 a defer-option modifier.
7003 The possible keywords are
7004 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7005 With &"strict"& behaviour, any temporary DNS error causes the
7006 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7007 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7008 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7009 error causes the whole lookup to defer only if none of the other lookups
7010 succeed. The default is &"lax"&, so the following lookups are equivalent:
7011 .code
7012 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7013 ${lookup dnsdb{a=one.host.com:two.host.com}}
7014 .endd
7015 Thus, in the default case, as long as at least one of the DNS lookups
7016 yields some data, the lookup succeeds.
7017
7018 .cindex "DNSSEC" "dns lookup"
7019 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7020 The possible keywords are
7021 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7022 With &"strict"& or &"lax"& DNSSEC information is requested
7023 with the lookup.
7024 With &"strict"& a response from the DNS resolver that
7025 is not labelled as authenticated data
7026 is treated as equivalent to a temporary DNS error.
7027 The default is &"never"&.
7028
7029 See also the &$lookup_dnssec_authenticated$& variable.
7030
7031
7032
7033
7034 .section "More about LDAP" "SECTldap"
7035 .cindex "LDAP" "lookup, more about"
7036 .cindex "lookup" "LDAP"
7037 .cindex "Solaris" "LDAP"
7038 The original LDAP implementation came from the University of Michigan; this has
7039 become &"Open LDAP"&, and there are now two different releases. Another
7040 implementation comes from Netscape, and Solaris 7 and subsequent releases
7041 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7042 the lookup function level, their error handling is different. For this reason
7043 it is necessary to set a compile-time variable when building Exim with LDAP, to
7044 indicate which LDAP library is in use. One of the following should appear in
7045 your &_Local/Makefile_&:
7046 .code
7047 LDAP_LIB_TYPE=UMICHIGAN
7048 LDAP_LIB_TYPE=OPENLDAP1
7049 LDAP_LIB_TYPE=OPENLDAP2
7050 LDAP_LIB_TYPE=NETSCAPE
7051 LDAP_LIB_TYPE=SOLARIS
7052 .endd
7053 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7054 same interface as the University of Michigan version.
7055
7056 There are three LDAP lookup types in Exim. These behave slightly differently in
7057 the way they handle the results of a query:
7058
7059 .ilist
7060 &(ldap)& requires the result to contain just one entry; if there are more, it
7061 gives an error.
7062 .next
7063 &(ldapdn)& also requires the result to contain just one entry, but it is the
7064 Distinguished Name that is returned rather than any attribute values.
7065 .next
7066 &(ldapm)& permits the result to contain more than one entry; the attributes
7067 from all of them are returned.
7068 .endlist
7069
7070
7071 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7072 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7073 the data returned by a successful lookup is described in the next section.
7074 First we explain how LDAP queries are coded.
7075
7076
7077 .section "Format of LDAP queries" "SECTforldaque"
7078 .cindex "LDAP" "query format"
7079 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7080 the configuration of a &(redirect)& router one might have this setting:
7081 .code
7082 data = ${lookup ldap \
7083   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7084   c=UK?mailbox?base?}}
7085 .endd
7086 .cindex "LDAP" "with TLS"
7087 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7088 secure (encrypted) LDAP connections. The second of these ensures that an
7089 encrypted TLS connection is used.
7090
7091 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7092 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7093 See the &%ldap_start_tls%& option.
7094
7095 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7096 controlled. Every part of the TLS configuration can be configured by settings in
7097 &_exim.conf_&. Depending on the version of the client libraries installed on
7098 your system, some of the initialization may have required setting options in
7099 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7100 certificates. This revealed a nuance where the current UID that exim was
7101 running as could affect which config files it read. With Exim 4.83, these
7102 methods become optional, only taking effect if not specifically set in
7103 &_exim.conf_&.
7104
7105
7106 .section "LDAP quoting" "SECID68"
7107 .cindex "LDAP" "quoting"
7108 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7109 and the second because the LDAP query is represented as a URL. Furthermore,
7110 within an LDAP query, two different kinds of quoting are required. For this
7111 reason, there are two different LDAP-specific quoting operators.
7112
7113 The &%quote_ldap%& operator is designed for use on strings that are part of
7114 filter specifications. Conceptually, it first does the following conversions on
7115 the string:
7116 .code
7117 *   =>   \2A
7118 (   =>   \28
7119 )   =>   \29
7120 \   =>   \5C
7121 .endd
7122 in accordance with RFC 2254. The resulting string is then quoted according
7123 to the rules for URLs, that is, all non-alphanumeric characters except
7124 .code
7125 ! $ ' - . _ ( ) * +
7126 .endd
7127 are converted to their hex values, preceded by a percent sign. For example:
7128 .code
7129 ${quote_ldap: a(bc)*, a<yz>; }
7130 .endd
7131 yields
7132 .code
7133 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7134 .endd
7135 Removing the URL quoting, this is (with a leading and a trailing space):
7136 .code
7137 a\28bc\29\2A, a<yz>;
7138 .endd
7139 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7140 base DN specifications in queries. Conceptually, it first converts the string
7141 by inserting a backslash in front of any of the following characters:
7142 .code
7143 , + " \ < > ;
7144 .endd
7145 It also inserts a backslash before any leading spaces or # characters, and
7146 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7147 is then quoted according to the rules for URLs. For example:
7148 .code
7149 ${quote_ldap_dn: a(bc)*, a<yz>; }
7150 .endd
7151 yields
7152 .code
7153 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7154 .endd
7155 Removing the URL quoting, this is (with a trailing space):
7156 .code
7157 \ a(bc)*\, a\<yz\>\;\
7158 .endd
7159 There are some further comments about quoting in the section on LDAP
7160 authentication below.
7161
7162
7163 .section "LDAP connections" "SECID69"
7164 .cindex "LDAP" "connections"
7165 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7166 is in use, via a Unix domain socket. The example given above does not specify
7167 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7168 by starting it with
7169 .code
7170 ldap://<hostname>:<port>/...
7171 .endd
7172 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7173 used. When no server is specified in a query, a list of default servers is
7174 taken from the &%ldap_default_servers%& configuration option. This supplies a
7175 colon-separated list of servers which are tried in turn until one successfully
7176 handles a query, or there is a serious error. Successful handling either
7177 returns the requested data, or indicates that it does not exist. Serious errors
7178 are syntactical, or multiple values when only a single value is expected.
7179 Errors which cause the next server to be tried are connection failures, bind
7180 failures, and timeouts.
7181
7182 For each server name in the list, a port number can be given. The standard way
7183 of specifying a host and port is to use a colon separator (RFC 1738). Because
7184 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7185 doubled. For example
7186 .code
7187 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7188 .endd
7189 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7190 to the LDAP library with no server name, and the library's default (normally
7191 the local host) is used.
7192
7193 If you are using the OpenLDAP library, you can connect to an LDAP server using
7194 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7195 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7196 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7197 not available.
7198
7199 For this type of connection, instead of a host name for the server, a pathname
7200 for the socket is required, and the port number is not relevant. The pathname
7201 can be specified either as an item in &%ldap_default_servers%&, or inline in
7202 the query. In the former case, you can have settings such as
7203 .code
7204 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7205 .endd
7206 When the pathname is given in the query, you have to escape the slashes as
7207 &`%2F`& to fit in with the LDAP URL syntax. For example:
7208 .code
7209 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7210 .endd
7211 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7212 a pathname, it uses the Unix domain socket code, even if the query actually
7213 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7214 socket connection. This behaviour means that you can use a setting of
7215 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7216 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7217 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7218 backup host.
7219
7220 If an explicit &`ldapi`& type is given in a query when a host name is
7221 specified, an error is diagnosed. However, if there are more items in
7222 &%ldap_default_servers%&, they are tried. In other words:
7223
7224 .ilist
7225 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7226 interface.
7227 .next
7228 Using &`ldapi`& with a host name causes an error.
7229 .endlist
7230
7231
7232 Using &`ldapi`& with no host or path in the query, and no setting of
7233 &%ldap_default_servers%&, does whatever the library does by default.
7234
7235
7236
7237 .section "LDAP authentication and control information" "SECID70"
7238 .cindex "LDAP" "authentication"
7239 The LDAP URL syntax provides no way of passing authentication and other control
7240 information to the server. To make this possible, the URL in an LDAP query may
7241 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7242 spaces. If a value contains spaces it must be enclosed in double quotes, and
7243 when double quotes are used, backslash is interpreted in the usual way inside
7244 them. The following names are recognized:
7245 .display
7246 &`DEREFERENCE`&  set the dereferencing parameter
7247 &`NETTIME    `&  set a timeout for a network operation
7248 &`USER       `&  set the DN, for authenticating the LDAP bind
7249 &`PASS       `&  set the password, likewise
7250 &`REFERRALS  `&  set the referrals parameter
7251 &`SERVERS    `&  set alternate server list for this query only
7252 &`SIZE       `&  set the limit for the number of entries returned
7253 &`TIME       `&  set the maximum waiting time for a query
7254 .endd
7255 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7256 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7257 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7258 library from trying to follow referrals issued by the LDAP server.
7259
7260 The name CONNECT is an obsolete name for NETTIME, retained for
7261 backwards compatibility. This timeout (specified as a number of seconds) is
7262 enforced from the client end for operations that can be carried out over a
7263 network. Specifically, it applies to network connections and calls to the
7264 &'ldap_result()'& function. If the value is greater than zero, it is used if
7265 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7266 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7267 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7268 Netscape SDK; for OpenLDAP no action is taken.
7269
7270 The TIME parameter (also a number of seconds) is passed to the server to
7271 set a server-side limit on the time taken to complete a search.
7272
7273 The SERVERS parameter allows you to specify an alternate list of ldap servers
7274 to use for an individual lookup.  The global ldap_servers option provides a
7275 default list of ldap servers, and a single lookup can specify a single ldap
7276 server to use.  But when you need to do a lookup with a list of servers that is
7277 different than the default list (maybe different order, maybe a completely
7278 different set of servers), the SERVERS parameter allows you to specify this
7279 alternate list (colon-separated).
7280
7281 Here is an example of an LDAP query in an Exim lookup that uses some of these
7282 values. This is a single line, folded to fit on the page:
7283 .code
7284 ${lookup ldap
7285   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7286   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7287   {$value}fail}
7288 .endd
7289 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7290 any of the auxiliary data. Exim configuration settings that include lookups
7291 which contain password information should be preceded by &"hide"& to prevent
7292 non-admin users from using the &%-bP%& option to see their values.
7293
7294 The auxiliary data items may be given in any order. The default is no
7295 connection timeout (the system timeout is used), no user or password, no limit
7296 on the number of entries returned, and no time limit on queries.
7297
7298 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7299 removes any URL quoting that it may contain before passing it LDAP. Apparently
7300 some libraries do this for themselves, but some do not. Removing the URL
7301 quoting has two advantages:
7302
7303 .ilist
7304 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7305 DNs as with DNs inside actual queries.
7306 .next
7307 It permits spaces inside USER= DNs.
7308 .endlist
7309
7310 For example, a setting such as
7311 .code
7312 USER=cn=${quote_ldap_dn:$1}
7313 .endd
7314 should work even if &$1$& contains spaces.
7315
7316 Expanded data for the PASS= value should be quoted using the &%quote%&
7317 expansion operator, rather than the LDAP quote operators. The only reason this
7318 field needs quoting is to ensure that it conforms to the Exim syntax, which
7319 does not allow unquoted spaces. For example:
7320 .code
7321 PASS=${quote:$3}
7322 .endd
7323 The LDAP authentication mechanism can be used to check passwords as part of
7324 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7325 &<<CHAPexpand>>&.
7326
7327
7328
7329 .section "Format of data returned by LDAP" "SECID71"
7330 .cindex "LDAP" "returned data formats"
7331 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7332 as a sequence of values, for example
7333 .code
7334 cn=manager, o=University of Cambridge, c=UK
7335 .endd
7336 The &(ldap)& lookup type generates an error if more than one entry matches the
7337 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7338 the result between the data from different entries. It is possible for multiple
7339 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7340 you know that whatever values are returned all came from a single entry in the
7341 directory.
7342
7343 In the common case where you specify a single attribute in your LDAP query, the
7344 result is not quoted, and does not contain the attribute name. If the attribute
7345 has multiple values, they are separated by commas.
7346
7347 If you specify multiple attributes, the result contains space-separated, quoted
7348 strings, each preceded by the attribute name and an equals sign. Within the
7349 quotes, the quote character, backslash, and newline are escaped with
7350 backslashes, and commas are used to separate multiple values for the attribute.
7351 .new
7352 Any commas in attribute values are doubled
7353 (permitting treatment of the values as a comma-separated list).
7354 .wen
7355 Apart from the escaping, the string within quotes takes the same form as the
7356 output when a single attribute is requested. Specifying no attributes is the
7357 same as specifying all of an entry's attributes.
7358
7359 .new
7360 Here are some examples of the output format. The first line of each pair is an
7361 LDAP query, and the second is the data that is returned. The attribute called
7362 &%attr1%& has two values, one of them with an embedded comma, whereas
7363 &%attr2%& has only one value:
7364 .code
7365 ldap:///o=base?attr1?sub?(uid=fred)
7366 value1.1,value1,,2
7367
7368 ldap:///o=base?attr2?sub?(uid=fred)
7369 value two
7370
7371 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7372 attr1="value1.1,value1,,2" attr2="value two"
7373
7374 ldap:///o=base??sub?(uid=fred)
7375 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7376 .endd
7377 .wen
7378 You can
7379 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7380 results of LDAP lookups.
7381 The &%extract%& operator in string expansions can be used to pick out
7382 individual fields from data that consists of &'key'&=&'value'& pairs.
7383 .new
7384 The &%listextract%& operator should be used to pick out individual values
7385 of attributes, even when only a single value is expected.
7386 The doubling of embedded commas allows you to use the returned data as a
7387 comma separated list (using the "<," syntax for changing the input list separator).
7388 .wen
7389
7390
7391
7392
7393 .section "More about NIS+" "SECTnisplus"
7394 .cindex "NIS+ lookup type"
7395 .cindex "lookup" "NIS+"
7396 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7397 and field name. If this is given, the result of a successful query is the
7398 contents of the named field; otherwise the result consists of a concatenation
7399 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7400 values containing spaces are quoted. For example, the query
7401 .code
7402 [name=mg1456],passwd.org_dir
7403 .endd
7404 might return the string
7405 .code
7406 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7407 home=/home/mg1456 shell=/bin/bash shadow=""
7408 .endd
7409 (split over two lines here to fit on the page), whereas
7410 .code
7411 [name=mg1456],passwd.org_dir:gcos
7412 .endd
7413 would just return
7414 .code
7415 Martin Guerre
7416 .endd
7417 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7418 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7419 operator is to double any quote characters within the text.
7420
7421
7422
7423 .section "SQL lookups" "SECTsql"
7424 .cindex "SQL lookup types"
7425 .cindex "MySQL" "lookup type"
7426 .cindex "PostgreSQL lookup type"
7427 .cindex "lookup" "MySQL"
7428 .cindex "lookup" "PostgreSQL"
7429 .cindex "Oracle" "lookup type"
7430 .cindex "lookup" "Oracle"
7431 .cindex "InterBase lookup type"
7432 .cindex "lookup" "InterBase"
7433 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7434 databases. Queries for these databases contain SQL statements, so an example
7435 might be
7436 .code
7437 ${lookup mysql{select mailbox from users where id='userx'}\
7438   {$value}fail}
7439 .endd
7440 If the result of the query contains more than one field, the data for each
7441 field in the row is returned, preceded by its name, so the result of
7442 .code
7443 ${lookup pgsql{select home,name from users where id='userx'}\
7444   {$value}}
7445 .endd
7446 might be
7447 .code
7448 home=/home/userx name="Mister X"
7449 .endd
7450 Empty values and values containing spaces are double quoted, with embedded
7451 quotes escaped by a backslash. If the result of the query contains just one
7452 field, the value is passed back verbatim, without a field name, for example:
7453 .code
7454 Mister X
7455 .endd
7456 If the result of the query yields more than one row, it is all concatenated,
7457 with a newline between the data for each row.
7458
7459
7460 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7461 .cindex "MySQL" "lookup type"
7462 .cindex "PostgreSQL lookup type"
7463 .cindex "lookup" "MySQL"
7464 .cindex "lookup" "PostgreSQL"
7465 .cindex "Oracle" "lookup type"
7466 .cindex "lookup" "Oracle"
7467 .cindex "InterBase lookup type"
7468 .cindex "lookup" "InterBase"
7469 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7470 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7471 option (as appropriate) must be set to a colon-separated list of server
7472 information.
7473 (For MySQL and PostgreSQL only, the global option need not be set if all
7474 queries contain their own server information &-- see section
7475 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7476 items: host name, database name, user name, and password. In the case of
7477 Oracle, the host name field is used for the &"service name"&, and the database
7478 name field is not used and should be empty. For example:
7479 .code
7480 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7481 .endd
7482 Because password data is sensitive, you should always precede the setting with
7483 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7484 option. Here is an example where two MySQL servers are listed:
7485 .code
7486 hide mysql_servers = localhost/users/root/secret:\
7487                      otherhost/users/root/othersecret
7488 .endd
7489 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7490 because this is a colon-separated list, the colon has to be doubled. For each
7491 query, these parameter groups are tried in order until a connection is made and
7492 a query is successfully processed. The result of a query may be that no data is
7493 found, but that is still a successful query. In other words, the list of
7494 servers provides a backup facility, not a list of different places to look.
7495
7496 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7497 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7498 respectively, and the characters single-quote, double-quote, and backslash
7499 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7500 addition, escapes the percent and underscore characters. This cannot be done
7501 for MySQL because these escapes are not recognized in contexts where these
7502 characters are not special.
7503
7504 .section "Specifying the server in the query" "SECTspeserque"
7505 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7506 it is possible to specify a list of servers with an individual query. This is
7507 done by starting the query with
7508 .display
7509 &`servers=`&&'server1:server2:server3:...'&&`;`&
7510 .endd
7511 Each item in the list may take one of two forms:
7512 .olist
7513 If it contains no slashes it is assumed to be just a host name. The appropriate
7514 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7515 of the same name, and the remaining parameters (database, user, password) are
7516 taken from there.
7517 .next
7518 If it contains any slashes, it is taken as a complete parameter set.
7519 .endlist
7520 The list of servers is used in exactly the same way as the global list.
7521 Once a connection to a server has happened and a query has been
7522 successfully executed, processing of the lookup ceases.
7523
7524 This feature is intended for use in master/slave situations where updates
7525 are occurring and you want to update the master rather than a slave. If the
7526 master is in the list as a backup for reading, you might have a global setting
7527 like this:
7528 .code
7529 mysql_servers = slave1/db/name/pw:\
7530                 slave2/db/name/pw:\
7531                 master/db/name/pw
7532 .endd
7533 In an updating lookup, you could then write:
7534 .code
7535 ${lookup mysql{servers=master; UPDATE ...} }
7536 .endd
7537 That query would then be sent only to the master server. If, on the other hand,
7538 the master is not to be used for reading, and so is not present in the global
7539 option, you can still update it by a query of this form:
7540 .code
7541 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7542 .endd
7543
7544
7545 .section "Special MySQL features" "SECID73"
7546 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7547 causes a connection to the server on the local host by means of a Unix domain
7548 socket. An alternate socket can be specified in parentheses. The full syntax of
7549 each item in &%mysql_servers%& is:
7550 .display
7551 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7552   <&'user'&>/<&'password'&>
7553 .endd
7554 Any of the three sub-parts of the first field can be omitted. For normal use on
7555 the local host it can be left blank or set to just &"localhost"&.
7556
7557 No database need be supplied &-- but if it is absent here, it must be given in
7558 the queries.
7559
7560 If a MySQL query is issued that does not request any data (an insert, update,
7561 or delete command), the result of the lookup is the number of rows affected.
7562
7563 &*Warning*&: This can be misleading. If an update does not actually change
7564 anything (for example, setting a field to the value it already has), the result
7565 is zero because no rows are affected.
7566
7567
7568 .section "Special PostgreSQL features" "SECID74"
7569 PostgreSQL lookups can also use Unix domain socket connections to the database.
7570 This is usually faster and costs less CPU time than a TCP/IP connection.
7571 However it can be used only if the mail server runs on the same machine as the
7572 database server. A configuration line for PostgreSQL via Unix domain sockets
7573 looks like this:
7574 .code
7575 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7576 .endd
7577 In other words, instead of supplying a host name, a path to the socket is
7578 given. The path name is enclosed in parentheses so that its slashes aren't
7579 visually confused with the delimiters for the other server parameters.
7580
7581 If a PostgreSQL query is issued that does not request any data (an insert,
7582 update, or delete command), the result of the lookup is the number of rows
7583 affected.
7584
7585 .section "More about SQLite" "SECTsqlite"
7586 .cindex "lookup" "SQLite"
7587 .cindex "sqlite lookup type"
7588 SQLite is different to the other SQL lookups because a file name is required in
7589 addition to the SQL query. An SQLite database is a single file, and there is no
7590 daemon as in the other SQL databases. The interface to Exim requires the name
7591 of the file, as an absolute path, to be given at the start of the query. It is
7592 separated from the query by white space. This means that the path name cannot
7593 contain white space. Here is a lookup expansion example:
7594 .code
7595 ${lookup sqlite {/some/thing/sqlitedb \
7596   select name from aliases where id='userx';}}
7597 .endd
7598 In a list, the syntax is similar. For example:
7599 .code
7600 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7601    select * from relays where ip='$sender_host_address';
7602 .endd
7603 The only character affected by the &%quote_sqlite%& operator is a single
7604 quote, which it doubles.
7605
7606 The SQLite library handles multiple simultaneous accesses to the database
7607 internally. Multiple readers are permitted, but only one process can
7608 update at once. Attempts to access the database while it is being updated
7609 are rejected after a timeout period, during which the SQLite library
7610 waits for the lock to be released. In Exim, the default timeout is set
7611 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7612 option.
7613 .ecindex IIDfidalo1
7614 .ecindex IIDfidalo2
7615
7616
7617 . ////////////////////////////////////////////////////////////////////////////
7618 . ////////////////////////////////////////////////////////////////////////////
7619
7620 .chapter "Domain, host, address, and local part lists" &&&
7621          "CHAPdomhosaddlists" &&&
7622          "Domain, host, and address lists"
7623 .scindex IIDdohoadli "lists of domains; hosts; etc."
7624 A number of Exim configuration options contain lists of domains, hosts,
7625 email addresses, or local parts. For example, the &%hold_domains%& option
7626 contains a list of domains whose delivery is currently suspended. These lists
7627 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7628 arguments to expansion conditions such as &%match_domain%&.
7629
7630 Each item in one of these lists is a pattern to be matched against a domain,
7631 host, email address, or local part, respectively. In the sections below, the
7632 different types of pattern for each case are described, but first we cover some
7633 general facilities that apply to all four kinds of list.
7634
7635
7636
7637 .section "Expansion of lists" "SECID75"
7638 .cindex "expansion" "of lists"
7639 Each list is expanded as a single string before it is used. The result of
7640 expansion must be a list, possibly containing empty items, which is split up
7641 into separate items for matching. By default, colon is the separator character,
7642 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7643 &<<SECTempitelis>>& for details of the list syntax; the second of these
7644 discusses the way to specify empty list items.
7645
7646
7647 If the string expansion is forced to fail, Exim behaves as if the item it is
7648 testing (domain, host, address, or local part) is not in the list. Other
7649 expansion failures cause temporary errors.
7650
7651 If an item in a list is a regular expression, backslashes, dollars and possibly
7652 other special characters in the expression must be protected against
7653 misinterpretation by the string expander. The easiest way to do this is to use
7654 the &`\N`& expansion feature to indicate that the contents of the regular
7655 expression should not be expanded. For example, in an ACL you might have:
7656 .code
7657 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7658                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7659 .endd
7660 The first item is a regular expression that is protected from expansion by
7661 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7662 senders based on the receiving domain.
7663
7664
7665
7666
7667 .section "Negated items in lists" "SECID76"
7668 .cindex "list" "negation"
7669 .cindex "negation" "in lists"
7670 Items in a list may be positive or negative. Negative items are indicated by a
7671 leading exclamation mark, which may be followed by optional white space. A list
7672 defines a set of items (domains, etc). When Exim processes one of these lists,
7673 it is trying to find out whether a domain, host, address, or local part
7674 (respectively) is in the set that is defined by the list. It works like this:
7675
7676 The list is scanned from left to right. If a positive item is matched, the
7677 subject that is being checked is in the set; if a negative item is matched, the
7678 subject is not in the set. If the end of the list is reached without the
7679 subject having matched any of the patterns, it is in the set if the last item
7680 was a negative one, but not if it was a positive one. For example, the list in
7681 .code
7682 domainlist relay_to_domains = !a.b.c : *.b.c
7683 .endd
7684 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7685 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7686 list is positive. However, if the setting were
7687 .code
7688 domainlist relay_to_domains = !a.b.c
7689 .endd
7690 then all domains other than &'a.b.c'& would match because the last item in the
7691 list is negative. In other words, a list that ends with a negative item behaves
7692 as if it had an extra item &`:*`& on the end.
7693
7694 Another way of thinking about positive and negative items in lists is to read
7695 the connector as &"or"& after a positive item and as &"and"& after a negative
7696 item.
7697
7698
7699
7700 .section "File names in lists" "SECTfilnamlis"
7701 .cindex "list" "file name in"
7702 If an item in a domain, host, address, or local part list is an absolute file
7703 name (beginning with a slash character), each line of the file is read and
7704 processed as if it were an independent item in the list, except that further
7705 file names are not allowed,
7706 and no expansion of the data from the file takes place.
7707 Empty lines in the file are ignored, and the file may also contain comment
7708 lines:
7709
7710 .ilist
7711 For domain and host lists, if a # character appears anywhere in a line of the
7712 file, it and all following characters are ignored.
7713 .next
7714 Because local parts may legitimately contain # characters, a comment in an
7715 address list or local part list file is recognized only if # is preceded by
7716 white space or the start of the line. For example:
7717 .code
7718 not#comment@x.y.z   # but this is a comment
7719 .endd
7720 .endlist
7721
7722 Putting a file name in a list has the same effect as inserting each line of the
7723 file as an item in the list (blank lines and comments excepted). However, there
7724 is one important difference: the file is read each time the list is processed,
7725 so if its contents vary over time, Exim's behaviour changes.
7726
7727 If a file name is preceded by an exclamation mark, the sense of any match
7728 within the file is inverted. For example, if
7729 .code
7730 hold_domains = !/etc/nohold-domains
7731 .endd
7732 and the file contains the lines
7733 .code
7734 !a.b.c
7735 *.b.c
7736 .endd
7737 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7738 any domain matching &`*.b.c`& is not.
7739
7740
7741
7742 .section "An lsearch file is not an out-of-line list" "SECID77"
7743 As will be described in the sections that follow, lookups can be used in lists
7744 to provide indexed methods of checking list membership. There has been some
7745 confusion about the way &(lsearch)& lookups work in lists. Because
7746 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7747 sometimes thought that it is allowed to contain wild cards and other kinds of
7748 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7749 always fixed strings, just as for any other single-key lookup type.
7750
7751 If you want to use a file to contain wild-card patterns that form part of a
7752 list, just give the file name on its own, without a search type, as described
7753 in the previous section. You could also use the &(wildlsearch)& or
7754 &(nwildlsearch)&, but there is no advantage in doing this.
7755
7756
7757
7758
7759 .section "Named lists" "SECTnamedlists"
7760 .cindex "named lists"
7761 .cindex "list" "named"
7762 A list of domains, hosts, email addresses, or local parts can be given a name
7763 which is then used to refer to the list elsewhere in the configuration. This is
7764 particularly convenient if the same list is required in several different
7765 places. It also allows lists to be given meaningful names, which can improve
7766 the readability of the configuration. For example, it is conventional to define
7767 a domain list called &'local_domains'& for all the domains that are handled
7768 locally on a host, using a configuration line such as
7769 .code
7770 domainlist local_domains = localhost:my.dom.example
7771 .endd
7772 Named lists are referenced by giving their name preceded by a plus sign, so,
7773 for example, a router that is intended to handle local domains would be
7774 configured with the line
7775 .code
7776 domains = +local_domains
7777 .endd
7778 The first router in a configuration is often one that handles all domains
7779 except the local ones, using a configuration with a negated item like this:
7780 .code
7781 dnslookup:
7782   driver = dnslookup
7783   domains = ! +local_domains
7784   transport = remote_smtp
7785   no_more
7786 .endd
7787 The four kinds of named list are created by configuration lines starting with
7788 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7789 respectively. Then there follows the name that you are defining, followed by an
7790 equals sign and the list itself. For example:
7791 .code
7792 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7793 addresslist bad_senders = cdb;/etc/badsenders
7794 .endd
7795 A named list may refer to other named lists:
7796 .code
7797 domainlist  dom1 = first.example : second.example
7798 domainlist  dom2 = +dom1 : third.example
7799 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7800 .endd
7801 &*Warning*&: If the last item in a referenced list is a negative one, the
7802 effect may not be what you intended, because the negation does not propagate
7803 out to the higher level. For example, consider:
7804 .code
7805 domainlist  dom1 = !a.b
7806 domainlist  dom2 = +dom1 : *.b
7807 .endd
7808 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7809 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7810 means it matches the second list as well. The effect is not the same as
7811 .code
7812 domainlist  dom2 = !a.b : *.b
7813 .endd
7814 where &'x.y'& does not match. It's best to avoid negation altogether in
7815 referenced lists if you can.
7816
7817 Named lists may have a performance advantage. When Exim is routing an
7818 address or checking an incoming message, it caches the result of tests on named
7819 lists. So, if you have a setting such as
7820 .code
7821 domains = +local_domains
7822 .endd
7823 on several of your routers
7824 or in several ACL statements,
7825 the actual test is done only for the first one. However, the caching works only
7826 if there are no expansions within the list itself or any sublists that it
7827 references. In other words, caching happens only for lists that are known to be
7828 the same each time they are referenced.
7829
7830 By default, there may be up to 16 named lists of each type. This limit can be
7831 extended by changing a compile-time variable. The use of domain and host lists
7832 is recommended for concepts such as local domains, relay domains, and relay
7833 hosts. The default configuration is set up like this.
7834
7835
7836
7837 .section "Named lists compared with macros" "SECID78"
7838 .cindex "list" "named compared with macro"
7839 .cindex "macro" "compared with named list"
7840 At first sight, named lists might seem to be no different from macros in the
7841 configuration file. However, macros are just textual substitutions. If you
7842 write
7843 .code
7844 ALIST = host1 : host2
7845 auth_advertise_hosts = !ALIST
7846 .endd
7847 it probably won't do what you want, because that is exactly the same as
7848 .code
7849 auth_advertise_hosts = !host1 : host2
7850 .endd
7851 Notice that the second host name is not negated. However, if you use a host
7852 list, and write
7853 .code
7854 hostlist alist = host1 : host2
7855 auth_advertise_hosts = ! +alist
7856 .endd
7857 the negation applies to the whole list, and so that is equivalent to
7858 .code
7859 auth_advertise_hosts = !host1 : !host2
7860 .endd
7861
7862
7863 .section "Named list caching" "SECID79"
7864 .cindex "list" "caching of named"
7865 .cindex "caching" "named lists"
7866 While processing a message, Exim caches the result of checking a named list if
7867 it is sure that the list is the same each time. In practice, this means that
7868 the cache operates only if the list contains no $ characters, which guarantees
7869 that it will not change when it is expanded. Sometimes, however, you may have
7870 an expanded list that you know will be the same each time within a given
7871 message. For example:
7872 .code
7873 domainlist special_domains = \
7874            ${lookup{$sender_host_address}cdb{/some/file}}
7875 .endd
7876 This provides a list of domains that depends only on the sending host's IP
7877 address. If this domain list is referenced a number of times (for example,
7878 in several ACL lines, or in several routers) the result of the check is not
7879 cached by default, because Exim does not know that it is going to be the
7880 same list each time.
7881
7882 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7883 cache the result anyway. For example:
7884 .code
7885 domainlist_cache special_domains = ${lookup{...
7886 .endd
7887 If you do this, you should be absolutely sure that caching is going to do
7888 the right thing in all cases. When in doubt, leave it out.
7889
7890
7891
7892 .section "Domain lists" "SECTdomainlist"
7893 .cindex "domain list" "patterns for"
7894 .cindex "list" "domain list"
7895 Domain lists contain patterns that are to be matched against a mail domain.
7896 The following types of item may appear in domain lists:
7897
7898 .ilist
7899 .cindex "primary host name"
7900 .cindex "host name" "matched in domain list"
7901 .oindex "&%primary_hostname%&"
7902 .cindex "domain list" "matching primary host name"
7903 .cindex "@ in a domain list"
7904 If a pattern consists of a single @ character, it matches the local host name,
7905 as set by the &%primary_hostname%& option (or defaulted). This makes it
7906 possible to use the same configuration file on several different hosts that
7907 differ only in their names.
7908 .next
7909 .cindex "@[] in a domain list"
7910 .cindex "domain list" "matching local IP interfaces"
7911 .cindex "domain literal"
7912 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7913 in square brackets (as in an email address that contains a domain literal), but
7914 only if that IP address is recognized as local for email routing purposes. The
7915 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7916 control which of a host's several IP addresses are treated as local.
7917 In today's Internet, the use of domain literals is controversial.
7918 .next
7919 .cindex "@mx_any"
7920 .cindex "@mx_primary"
7921 .cindex "@mx_secondary"
7922 .cindex "domain list" "matching MX pointers to local host"
7923 If a pattern consists of the string &`@mx_any`& it matches any domain that
7924 has an MX record pointing to the local host or to any host that is listed in
7925 .oindex "&%hosts_treat_as_local%&"
7926 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7927 are similar, except that the first matches only when a primary MX target is the
7928 local host, and the second only when no primary MX target is the local host,
7929 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7930 preference value &-- there may of course be more than one of them.
7931
7932 The MX lookup that takes place when matching a pattern of this type is
7933 performed with the resolver options for widening names turned off. Thus, for
7934 example, a single-component domain will &'not'& be expanded by adding the
7935 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7936 options of the &(dnslookup)& router for a discussion of domain widening.
7937
7938 Sometimes you may want to ignore certain IP addresses when using one of these
7939 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7940 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7941 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7942 on a router). For example:
7943 .code
7944 domains = @mx_any/ignore=127.0.0.1
7945 .endd
7946 This example matches any domain that has an MX record pointing to one of
7947 the local host's IP addresses other than 127.0.0.1.
7948
7949 The list of IP addresses is in fact processed by the same code that processes
7950 host lists, so it may contain CIDR-coded network specifications and it may also
7951 contain negative items.
7952
7953 Because the list of IP addresses is a sublist within a domain list, you have to
7954 be careful about delimiters if there is more than one address. Like any other
7955 list, the default delimiter can be changed. Thus, you might have:
7956 .code
7957 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7958           an.other.domain : ...
7959 .endd
7960 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7961 involved, it is easiest to change the delimiter for the main list as well:
7962 .code
7963 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7964           an.other.domain ? ...
7965 .endd
7966 .next
7967 .cindex "asterisk" "in domain list"
7968 .cindex "domain list" "asterisk in"
7969 .cindex "domain list" "matching &""ends with""&"
7970 If a pattern starts with an asterisk, the remaining characters of the pattern
7971 are compared with the terminating characters of the domain. The use of &"*"& in
7972 domain lists differs from its use in partial matching lookups. In a domain
7973 list, the character following the asterisk need not be a dot, whereas partial
7974 matching works only in terms of dot-separated components. For example, a domain
7975 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7976 &'cipher.key.ex'&.
7977
7978 .next
7979 .cindex "regular expressions" "in domain list"
7980 .cindex "domain list" "matching regular expression"
7981 If a pattern starts with a circumflex character, it is treated as a regular
7982 expression, and matched against the domain using a regular expression matching
7983 function. The circumflex is treated as part of the regular expression.
7984 Email domains are case-independent, so this regular expression match is by
7985 default case-independent, but you can make it case-dependent by starting it
7986 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7987 are given in chapter &<<CHAPregexp>>&.
7988
7989 &*Warning*&: Because domain lists are expanded before being processed, you
7990 must escape any backslash and dollar characters in the regular expression, or
7991 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7992 it is not to be expanded (unless you really do want to build a regular
7993 expression by expansion, of course).
7994 .next
7995 .cindex "lookup" "in domain list"
7996 .cindex "domain list" "matching by lookup"
7997 If a pattern starts with the name of a single-key lookup type followed by a
7998 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7999 must be a file name in a suitable format for the lookup type. For example, for
8000 &"cdb;"& it must be an absolute path:
8001 .code
8002 domains = cdb;/etc/mail/local_domains.cdb
8003 .endd
8004 The appropriate type of lookup is done on the file using the domain name as the
8005 key. In most cases, the data that is looked up is not used; Exim is interested
8006 only in whether or not the key is present in the file. However, when a lookup
8007 is used for the &%domains%& option on a router
8008 or a &%domains%& condition in an ACL statement, the data is preserved in the
8009 &$domain_data$& variable and can be referred to in other router options or
8010 other statements in the same ACL.
8011
8012 .next
8013 Any of the single-key lookup type names may be preceded by
8014 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8015 .code
8016 domains = partial-dbm;/partial/domains
8017 .endd
8018 This causes partial matching logic to be invoked; a description of how this
8019 works is given in section &<<SECTpartiallookup>>&.
8020
8021 .next
8022 .cindex "asterisk" "in lookup type"
8023 Any of the single-key lookup types may be followed by an asterisk. This causes
8024 a default lookup for a key consisting of a single asterisk to be done if the
8025 original lookup fails. This is not a useful feature when using a domain list to
8026 select particular domains (because any domain would match), but it might have
8027 value if the result of the lookup is being used via the &$domain_data$&
8028 expansion variable.
8029 .next
8030 If the pattern starts with the name of a query-style lookup type followed by a
8031 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8032 pattern must be an appropriate query for the lookup type, as described in
8033 chapter &<<CHAPfdlookup>>&. For example:
8034 .code
8035 hold_domains = mysql;select domain from holdlist \
8036   where domain = '${quote_mysql:$domain}';
8037 .endd
8038 In most cases, the data that is looked up is not used (so for an SQL query, for
8039 example, it doesn't matter what field you select). Exim is interested only in
8040 whether or not the query succeeds. However, when a lookup is used for the
8041 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8042 variable and can be referred to in other options.
8043 .next
8044 .cindex "domain list" "matching literal domain name"
8045 If none of the above cases apply, a caseless textual comparison is made
8046 between the pattern and the domain.
8047 .endlist
8048
8049 Here is an example that uses several different kinds of pattern:
8050 .code
8051 domainlist funny_domains = \
8052   @ : \
8053   lib.unseen.edu : \
8054   *.foundation.fict.example : \
8055   \N^[1-2]\d{3}\.fict\.example$\N : \
8056   partial-dbm;/opt/data/penguin/book : \
8057   nis;domains.byname : \
8058   nisplus;[name=$domain,status=local],domains.org_dir
8059 .endd
8060 There are obvious processing trade-offs among the various matching modes. Using
8061 an asterisk is faster than a regular expression, and listing a few names
8062 explicitly probably is too. The use of a file or database lookup is expensive,
8063 but may be the only option if hundreds of names are required. Because the
8064 patterns are tested in order, it makes sense to put the most commonly matched
8065 patterns earlier.
8066
8067
8068
8069 .section "Host lists" "SECThostlist"
8070 .cindex "host list" "patterns in"
8071 .cindex "list" "host list"
8072 Host lists are used to control what remote hosts are allowed to do. For
8073 example, some hosts may be allowed to use the local host as a relay, and some
8074 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8075 two different ways, by name or by IP address. In a host list, some types of
8076 pattern are matched to a host name, and some are matched to an IP address.
8077 You need to be particularly careful with this when single-key lookups are
8078 involved, to ensure that the right value is being used as the key.
8079
8080
8081 .section "Special host list patterns" "SECID80"
8082 .cindex "empty item in hosts list"
8083 .cindex "host list" "empty string in"
8084 If a host list item is the empty string, it matches only when no remote host is
8085 involved. This is the case when a message is being received from a local
8086 process using SMTP on the standard input, that is, when a TCP/IP connection is
8087 not used.
8088
8089 .cindex "asterisk" "in host list"
8090 The special pattern &"*"& in a host list matches any host or no host. Neither
8091 the IP address nor the name is actually inspected.
8092
8093
8094
8095 .section "Host list patterns that match by IP address" "SECThoslispatip"
8096 .cindex "host list" "matching IP addresses"
8097 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8098 the incoming address actually appears in the IPv6 host as
8099 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8100 list, it is converted into a traditional IPv4 address first. (Not all operating
8101 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8102 concerns.)
8103
8104 The following types of pattern in a host list check the remote host by
8105 inspecting its IP address:
8106
8107 .ilist
8108 If the pattern is a plain domain name (not a regular expression, not starting
8109 with *, not a lookup of any kind), Exim calls the operating system function
8110 to find the associated IP address(es). Exim uses the newer
8111 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8112 This typically causes a forward DNS lookup of the name. The result is compared
8113 with the IP address of the subject host.
8114
8115 If there is a temporary problem (such as a DNS timeout) with the host name
8116 lookup, a temporary error occurs. For example, if the list is being used in an
8117 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8118 temporary SMTP error code. If no IP address can be found for the host name,
8119 what happens is described in section &<<SECTbehipnot>>& below.
8120
8121 .next
8122 .cindex "@ in a host list"
8123 If the pattern is &"@"&, the primary host name is substituted and used as a
8124 domain name, as just described.
8125
8126 .next
8127 If the pattern is an IP address, it is matched against the IP address of the
8128 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8129 IPv6 addresses can be given in colon-separated format, but the colons have to
8130 be doubled so as not to be taken as item separators when the default list
8131 separator is used. IPv6 addresses are recognized even when Exim is compiled
8132 without IPv6 support. This means that if they appear in a host list on an
8133 IPv4-only host, Exim will not treat them as host names. They are just addresses
8134 that can never match a client host.
8135
8136 .next
8137 .cindex "@[] in a host list"
8138 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8139 the local host. For example, if the local host is an IPv4 host with one
8140 interface address 10.45.23.56, these two ACL statements have the same effect:
8141 .code
8142 accept hosts = 127.0.0.1 : 10.45.23.56
8143 accept hosts = @[]
8144 .endd
8145 .next
8146 .cindex "CIDR notation"
8147 If the pattern is an IP address followed by a slash and a mask length (for
8148 example 10.11.42.0/24), it is matched against the IP address of the subject
8149 host under the given mask. This allows, an entire network of hosts to be
8150 included (or excluded) by a single item. The mask uses CIDR notation; it
8151 specifies the number of address bits that must match, starting from the most
8152 significant end of the address.
8153
8154 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8155 of a range of addresses. It is the number of bits in the network portion of the
8156 address. The above example specifies a 24-bit netmask, so it matches all 256
8157 addresses in the 10.11.42.0 network. An item such as
8158 .code
8159 192.168.23.236/31
8160 .endd
8161 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8162 32 for an IPv4 address is the same as no mask at all; just a single address
8163 matches.
8164
8165 Here is another example which shows an IPv4 and an IPv6 network:
8166 .code
8167 recipient_unqualified_hosts = 192.168.0.0/16: \
8168                               3ffe::ffff::836f::::/48
8169 .endd
8170 The doubling of list separator characters applies only when these items
8171 appear inline in a host list. It is not required when indirecting via a file.
8172 For example:
8173 .code
8174 recipient_unqualified_hosts = /opt/exim/unqualnets
8175 .endd
8176 could make use of a file containing
8177 .code
8178 172.16.0.0/12
8179 3ffe:ffff:836f::/48
8180 .endd
8181 to have exactly the same effect as the previous example. When listing IPv6
8182 addresses inline, it is usually more convenient to use the facility for
8183 changing separator characters. This list contains the same two networks:
8184 .code
8185 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8186                                  3ffe:ffff:836f::/48
8187 .endd
8188 The separator is changed to semicolon by the leading &"<;"& at the start of the
8189 list.
8190 .endlist
8191
8192
8193
8194 .section "Host list patterns for single-key lookups by host address" &&&
8195          "SECThoslispatsikey"
8196 .cindex "host list" "lookup of IP address"
8197 When a host is to be identified by a single-key lookup of its complete IP
8198 address, the pattern takes this form:
8199 .display
8200 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8201 .endd
8202 For example:
8203 .code
8204 hosts_lookup = net-cdb;/hosts-by-ip.db
8205 .endd
8206 The text form of the IP address of the subject host is used as the lookup key.
8207 IPv6 addresses are converted to an unabbreviated form, using lower case
8208 letters, with dots as separators because colon is the key terminator in
8209 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8210 quoting the keys, but this is a facility that was added later.] The data
8211 returned by the lookup is not used.
8212
8213 .cindex "IP address" "masking"
8214 .cindex "host list" "masked IP address"
8215 Single-key lookups can also be performed using masked IP addresses, using
8216 patterns of this form:
8217 .display
8218 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8219 .endd
8220 For example:
8221 .code
8222 net24-dbm;/networks.db
8223 .endd
8224 The IP address of the subject host is masked using <&'number'&> as the mask
8225 length. A textual string is constructed from the masked value, followed by the
8226 mask, and this is used as the lookup key. For example, if the host's IP address
8227 is 192.168.34.6, the key that is looked up for the above example is
8228 &"192.168.34.0/24"&.
8229
8230 When an IPv6 address is converted to a string, dots are normally used instead
8231 of colons, so that keys in &(lsearch)& files need not contain colons (which
8232 terminate &(lsearch)& keys). This was implemented some time before the ability
8233 to quote keys was made available in &(lsearch)& files. However, the more
8234 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8235 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8236 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8237 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8238 addresses are always used.
8239
8240 Ideally, it would be nice to tidy up this anomalous situation by changing to
8241 colons in all cases, given that quoting is now available for &(lsearch)&.
8242 However, this would be an incompatible change that might break some existing
8243 configurations.
8244
8245 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8246 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8247 the former case the key strings include the mask value, whereas in the latter
8248 case the IP address is used on its own.
8249
8250
8251
8252 .section "Host list patterns that match by host name" "SECThoslispatnam"
8253 .cindex "host" "lookup failures"
8254 .cindex "unknown host name"
8255 .cindex "host list" "matching host name"
8256 There are several types of pattern that require Exim to know the name of the
8257 remote host. These are either wildcard patterns or lookups by name. (If a
8258 complete hostname is given without any wildcarding, it is used to find an IP
8259 address to match against, as described in section &<<SECThoslispatip>>&
8260 above.)
8261
8262 If the remote host name is not already known when Exim encounters one of these
8263 patterns, it has to be found from the IP address.
8264 Although many sites on the Internet are conscientious about maintaining reverse
8265 DNS data for their hosts, there are also many that do not do this.
8266 Consequently, a name cannot always be found, and this may lead to unwanted
8267 effects. Take care when configuring host lists with wildcarded name patterns.
8268 Consider what will happen if a name cannot be found.
8269
8270 Because of the problems of determining host names from IP addresses, matching
8271 against host names is not as common as matching against IP addresses.
8272
8273 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8274 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8275 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8276 are done can be changed by setting the &%host_lookup_order%& option. For
8277 security, once Exim has found one or more names, it looks up the IP addresses
8278 for these names and compares them with the IP address that it started with.
8279 Only those names whose IP addresses match are accepted. Any other names are
8280 discarded. If no names are left, Exim behaves as if the host name cannot be
8281 found. In the most common case there is only one name and one IP address.
8282
8283 There are some options that control what happens if a host name cannot be
8284 found. These are described in section &<<SECTbehipnot>>& below.
8285
8286 .cindex "host" "alias for"
8287 .cindex "alias for host"
8288 As a result of aliasing, hosts may have more than one name. When processing any
8289 of the following types of pattern, all the host's names are checked:
8290
8291 .ilist
8292 .cindex "asterisk" "in host list"
8293 If a pattern starts with &"*"& the remainder of the item must match the end of
8294 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8295 &'.b.c'&. This special simple form is provided because this is a very common
8296 requirement. Other kinds of wildcarding require the use of a regular
8297 expression.
8298 .next
8299 .cindex "regular expressions" "in host list"
8300 .cindex "host list" "regular expression in"
8301 If the item starts with &"^"& it is taken to be a regular expression which is
8302 matched against the host name. Host names are case-independent, so this regular
8303 expression match is by default case-independent, but you can make it
8304 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8305 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8306 example,
8307 .code
8308 ^(a|b)\.c\.d$
8309 .endd
8310 is a regular expression that matches either of the two hosts &'a.c.d'& or
8311 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8312 that backslash and dollar characters are not misinterpreted as part of the
8313 string expansion. The simplest way to do this is to use &`\N`& to mark that
8314 part of the string as non-expandable. For example:
8315 .code
8316 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8317 .endd
8318 &*Warning*&: If you want to match a complete host name, you must include the
8319 &`$`& terminating metacharacter in the regular expression, as in the above
8320 example. Without it, a match at the start of the host name is all that is
8321 required.
8322 .endlist
8323
8324
8325
8326
8327 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8328 .cindex "host" "lookup failures, permanent"
8329 While processing a host list, Exim may need to look up an IP address from a
8330 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8331 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8332 behaviour when it fails to find the information it is seeking is the same.
8333
8334 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8335 apply to temporary DNS errors, whose handling is described in the next section.
8336
8337 .cindex "&`+include_unknown`&"
8338 .cindex "&`+ignore_unknown`&"
8339 Exim parses a host list from left to right. If it encounters a permanent
8340 lookup failure in any item in the host list before it has found a match,
8341 Exim treats it as a failure and the default behavior is as if the host
8342 does not match the list. This may not always be what you want to happen.
8343 To change Exim's behaviour, the special items &`+include_unknown`& or
8344 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8345 not recognized in an indirected file).
8346
8347 .ilist
8348 If any item that follows &`+include_unknown`& requires information that
8349 cannot found, Exim behaves as if the host does match the list. For example,
8350 .code
8351 host_reject_connection = +include_unknown:*.enemy.ex
8352 .endd
8353 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8354 any hosts whose name it cannot find.
8355
8356 .next
8357 If any item that follows &`+ignore_unknown`& requires information that cannot
8358 be found, Exim ignores that item and proceeds to the rest of the list. For
8359 example:
8360 .code
8361 accept hosts = +ignore_unknown : friend.example : \
8362                192.168.4.5
8363 .endd
8364 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8365 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8366 name can be found for 192.168.4.5, it is rejected.
8367 .endlist
8368
8369 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8370 list. The effect of each one lasts until the next, or until the end of the
8371 list.
8372
8373 .section "Mixing wildcarded host names and addresses in host lists" &&&
8374          "SECTmixwilhos"
8375 .cindex "host list" "mixing names and addresses in"
8376
8377 This section explains the host/ip processing logic with the same concepts
8378 as the previous section, but specifically addresses what happens when a
8379 wildcarded hostname is one of the items in the hostlist.
8380
8381 .ilist
8382 If you have name lookups or wildcarded host names and
8383 IP addresses in the same host list, you should normally put the IP
8384 addresses first. For example, in an ACL you could have:
8385 .code
8386 accept hosts = 10.9.8.7 : *.friend.example
8387 .endd
8388 The reason you normally would order it this way lies in the
8389 left-to-right way that Exim processes lists.  It can test IP addresses
8390 without doing any DNS lookups, but when it reaches an item that requires
8391 a host name, it fails if it cannot find a host name to compare with the
8392 pattern. If the above list is given in the opposite order, the
8393 &%accept%& statement fails for a host whose name cannot be found, even
8394 if its IP address is 10.9.8.7.
8395
8396 .next
8397 If you really do want to do the name check first, and still recognize the IP
8398 address, you can rewrite the ACL like this:
8399 .code
8400 accept hosts = *.friend.example
8401 accept hosts = 10.9.8.7
8402 .endd
8403 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8404 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8405 &`+ignore_unknown`&, which was discussed in depth in the first example in
8406 this section.
8407 .endlist
8408
8409
8410 .section "Temporary DNS errors when looking up host information" &&&
8411          "SECTtemdnserr"
8412 .cindex "host" "lookup failures, temporary"
8413 .cindex "&`+include_defer`&"
8414 .cindex "&`+ignore_defer`&"
8415 A temporary DNS lookup failure normally causes a defer action (except when
8416 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8417 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8418 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8419 section. These options should be used with care, probably only in non-critical
8420 host lists such as whitelists.
8421
8422
8423
8424 .section "Host list patterns for single-key lookups by host name" &&&
8425          "SECThoslispatnamsk"
8426 .cindex "unknown host name"
8427 .cindex "host list" "matching host name"
8428 If a pattern is of the form
8429 .display
8430 <&'single-key-search-type'&>;<&'search-data'&>
8431 .endd
8432 for example
8433 .code
8434 dbm;/host/accept/list
8435 .endd
8436 a single-key lookup is performed, using the host name as its key. If the
8437 lookup succeeds, the host matches the item. The actual data that is looked up
8438 is not used.
8439
8440 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8441 keys in the file, not IP addresses. If you want to do lookups based on IP
8442 addresses, you must precede the search type with &"net-"& (see section
8443 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8444 two items in the same list, one doing an address lookup and one doing a name
8445 lookup, both using the same file.
8446
8447
8448
8449 .section "Host list patterns for query-style lookups" "SECID81"
8450 If a pattern is of the form
8451 .display
8452 <&'query-style-search-type'&>;<&'query'&>
8453 .endd
8454 the query is obeyed, and if it succeeds, the host matches the item. The actual
8455 data that is looked up is not used. The variables &$sender_host_address$& and
8456 &$sender_host_name$& can be used in the query. For example:
8457 .code
8458 hosts_lookup = pgsql;\
8459   select ip from hostlist where ip='$sender_host_address'
8460 .endd
8461 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8462 can use the &%sg%& expansion item to change this if you need to. If you want to
8463 use masked IP addresses in database queries, you can use the &%mask%& expansion
8464 operator.
8465
8466 If the query contains a reference to &$sender_host_name$&, Exim automatically
8467 looks up the host name if it has not already done so. (See section
8468 &<<SECThoslispatnam>>& for comments on finding host names.)
8469
8470 Historical note: prior to release 4.30, Exim would always attempt to find a
8471 host name before running the query, unless the search type was preceded by
8472 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8473 still recognized for query-style lookups, but its presence or absence has no
8474 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8475 See section &<<SECThoslispatsikey>>&.)
8476
8477
8478
8479
8480
8481 .section "Address lists" "SECTaddresslist"
8482 .cindex "list" "address list"
8483 .cindex "address list" "empty item"
8484 .cindex "address list" "patterns"
8485 Address lists contain patterns that are matched against mail addresses. There
8486 is one special case to be considered: the sender address of a bounce message is
8487 always empty. You can test for this by providing an empty item in an address
8488 list. For example, you can set up a router to process bounce messages by
8489 using this option setting:
8490 .code
8491 senders = :
8492 .endd
8493 The presence of the colon creates an empty item. If you do not provide any
8494 data, the list is empty and matches nothing. The empty sender can also be
8495 detected by a regular expression that matches an empty string,
8496 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8497
8498 Non-empty items in an address list can be straightforward email addresses. For
8499 example:
8500 .code
8501 senders = jbc@askone.example : hs@anacreon.example
8502 .endd
8503 A certain amount of wildcarding is permitted. If a pattern contains an @
8504 character, but is not a regular expression and does not begin with a
8505 semicolon-terminated lookup type (described below), the local part of the
8506 subject address is compared with the local part of the pattern, which may start
8507 with an asterisk. If the local parts match, the domain is checked in exactly
8508 the same way as for a pattern in a domain list. For example, the domain can be
8509 wildcarded, refer to a named list, or be a lookup:
8510 .code
8511 deny senders = *@*.spamming.site:\
8512                *@+hostile_domains:\
8513                bozo@partial-lsearch;/list/of/dodgy/sites:\
8514                *@dbm;/bad/domains.db
8515 .endd
8516 .cindex "local part" "starting with !"
8517 .cindex "address list" "local part starting with !"
8518 If a local part that begins with an exclamation mark is required, it has to be
8519 specified using a regular expression, because otherwise the exclamation mark is
8520 treated as a sign of negation, as is standard in lists.
8521
8522 If a non-empty pattern that is not a regular expression or a lookup does not
8523 contain an @ character, it is matched against the domain part of the subject
8524 address. The only two formats that are recognized this way are a literal
8525 domain, or a domain pattern that starts with *. In both these cases, the effect
8526 is the same as if &`*@`& preceded the pattern. For example:
8527 .code
8528 deny senders = enemy.domain : *.enemy.domain
8529 .endd
8530
8531 The following kinds of more complicated address list pattern can match any
8532 address, including the empty address that is characteristic of bounce message
8533 senders:
8534
8535 .ilist
8536 .cindex "regular expressions" "in address list"
8537 .cindex "address list" "regular expression in"
8538 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8539 done against the complete address, with the pattern as the regular expression.
8540 You must take care that backslash and dollar characters are not misinterpreted
8541 as part of the string expansion. The simplest way to do this is to use &`\N`&
8542 to mark that part of the string as non-expandable. For example:
8543 .code
8544 deny senders = \N^.*this.*@example\.com$\N : \
8545                \N^\d{8}.+@spamhaus.example$\N : ...
8546 .endd
8547 The &`\N`& sequences are removed by the expansion, so these items do indeed
8548 start with &"^"& by the time they are being interpreted as address patterns.
8549
8550 .next
8551 .cindex "address list" "lookup for complete address"
8552 Complete addresses can be looked up by using a pattern that starts with a
8553 lookup type terminated by a semicolon, followed by the data for the lookup. For
8554 example:
8555 .code
8556 deny senders = cdb;/etc/blocked.senders : \
8557   mysql;select address from blocked where \
8558   address='${quote_mysql:$sender_address}'
8559 .endd
8560 Both query-style and single-key lookup types can be used. For a single-key
8561 lookup type, Exim uses the complete address as the key. However, empty keys are
8562 not supported for single-key lookups, so a match against the empty address
8563 always fails. This restriction does not apply to query-style lookups.
8564
8565 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8566 cannot be used, and is ignored if specified, with an entry being written to the
8567 panic log.
8568 .cindex "*@ with single-key lookup"
8569 However, you can configure lookup defaults, as described in section
8570 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8571 default. For example, with this lookup:
8572 .code
8573 accept senders = lsearch*@;/some/file
8574 .endd
8575 the file could contains lines like this:
8576 .code
8577 user1@domain1.example
8578 *@domain2.example
8579 .endd
8580 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8581 that are tried is:
8582 .code
8583 nimrod@jaeger.example
8584 *@jaeger.example
8585 *
8586 .endd
8587 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8588 would mean that every address matches, thus rendering the test useless.
8589
8590 &*Warning 2*&: Do not confuse these two kinds of item:
8591 .code
8592 deny recipients = dbm*@;/some/file
8593 deny recipients = *@dbm;/some/file
8594 .endd
8595 The first does a whole address lookup, with defaulting, as just described,
8596 because it starts with a lookup type. The second matches the local part and
8597 domain independently, as described in a bullet point below.
8598 .endlist
8599
8600
8601 The following kinds of address list pattern can match only non-empty addresses.
8602 If the subject address is empty, a match against any of these pattern types
8603 always fails.
8604
8605
8606 .ilist
8607 .cindex "@@ with single-key lookup"
8608 .cindex "address list" "@@ lookup type"
8609 .cindex "address list" "split local part and domain"
8610 If a pattern starts with &"@@"& followed by a single-key lookup item
8611 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8612 split into a local part and a domain. The domain is looked up in the file. If
8613 it is not found, there is no match. If it is found, the data that is looked up
8614 from the file is treated as a colon-separated list of local part patterns, each
8615 of which is matched against the subject local part in turn.
8616
8617 .cindex "asterisk" "in address list"
8618 The lookup may be a partial one, and/or one involving a search for a default
8619 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8620 patterns that are looked up can be regular expressions or begin with &"*"&, or
8621 even be further lookups. They may also be independently negated. For example,
8622 with
8623 .code
8624 deny senders = @@dbm;/etc/reject-by-domain
8625 .endd
8626 the data from which the DBM file is built could contain lines like
8627 .code
8628 baddomain.com:  !postmaster : *
8629 .endd
8630 to reject all senders except &%postmaster%& from that domain.
8631
8632 .cindex "local part" "starting with !"
8633 If a local part that actually begins with an exclamation mark is required, it
8634 has to be specified using a regular expression. In &(lsearch)& files, an entry
8635 may be split over several lines by indenting the second and subsequent lines,
8636 but the separating colon must still be included at line breaks. White space
8637 surrounding the colons is ignored. For example:
8638 .code
8639 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8640   spammer3 : spammer4
8641 .endd
8642 As in all colon-separated lists in Exim, a colon can be included in an item by
8643 doubling.
8644
8645 If the last item in the list starts with a right angle-bracket, the remainder
8646 of the item is taken as a new key to look up in order to obtain a continuation
8647 list of local parts. The new key can be any sequence of characters. Thus one
8648 might have entries like
8649 .code
8650 aol.com: spammer1 : spammer 2 : >*
8651 xyz.com: spammer3 : >*
8652 *:       ^\d{8}$
8653 .endd
8654 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8655 local parts for all domains, in addition to the specific local parts listed for
8656 each domain. Of course, using this feature costs another lookup each time a
8657 chain is followed, but the effort needed to maintain the data is reduced.
8658
8659 .cindex "loop" "in lookups"
8660 It is possible to construct loops using this facility, and in order to catch
8661 them, the chains may be no more than fifty items long.
8662
8663 .next
8664 The @@<&'lookup'&> style of item can also be used with a query-style
8665 lookup, but in this case, the chaining facility is not available. The lookup
8666 can only return a single list of local parts.
8667 .endlist
8668
8669 &*Warning*&: There is an important difference between the address list items
8670 in these two examples:
8671 .code
8672 senders = +my_list
8673 senders = *@+my_list
8674 .endd
8675 In the first one, &`my_list`& is a named address list, whereas in the second
8676 example it is a named domain list.
8677
8678
8679
8680
8681 .section "Case of letters in address lists" "SECTcasletadd"
8682 .cindex "case of local parts"
8683 .cindex "address list" "case forcing"
8684 .cindex "case forcing in address lists"
8685 Domains in email addresses are always handled caselessly, but for local parts
8686 case may be significant on some systems (see &%caseful_local_part%& for how
8687 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8688 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8689 blocking lists should be done in a case-independent manner. Since most address
8690 lists in Exim are used for this kind of control, Exim attempts to do this by
8691 default.
8692
8693 The domain portion of an address is always lowercased before matching it to an
8694 address list. The local part is lowercased by default, and any string
8695 comparisons that take place are done caselessly. This means that the data in
8696 the address list itself, in files included as plain file names, and in any file
8697 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8698 keys in files that are looked up by a search type other than &(lsearch)& (which
8699 works caselessly) must be in lower case, because these lookups are not
8700 case-independent.
8701
8702 .cindex "&`+caseful`&"
8703 To allow for the possibility of caseful address list matching, if an item in
8704 an address list is the string &"+caseful"&, the original case of the local
8705 part is restored for any comparisons that follow, and string comparisons are no
8706 longer case-independent. This does not affect the domain, which remains in
8707 lower case. However, although independent matches on the domain alone are still
8708 performed caselessly, regular expressions that match against an entire address
8709 become case-sensitive after &"+caseful"& has been seen.
8710
8711
8712
8713 .section "Local part lists" "SECTlocparlis"
8714 .cindex "list" "local part list"
8715 .cindex "local part" "list"
8716 Case-sensitivity in local part lists is handled in the same way as for address
8717 lists, as just described. The &"+caseful"& item can be used if required. In a
8718 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8719 set false, the subject is lowercased and the matching is initially
8720 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8721 matching in the local part list, but not elsewhere in the router. If
8722 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8723 option is case-sensitive from the start.
8724
8725 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8726 comments are handled in the same way as address lists &-- they are recognized
8727 only if the # is preceded by white space or the start of the line.
8728 Otherwise, local part lists are matched in the same way as domain lists, except
8729 that the special items that refer to the local host (&`@`&, &`@[]`&,
8730 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8731 Refer to section &<<SECTdomainlist>>& for details of the other available item
8732 types.
8733 .ecindex IIDdohoadli
8734
8735
8736
8737
8738 . ////////////////////////////////////////////////////////////////////////////
8739 . ////////////////////////////////////////////////////////////////////////////
8740
8741 .chapter "String expansions" "CHAPexpand"
8742 .scindex IIDstrexp "expansion" "of strings"
8743 Many strings in Exim's run time configuration are expanded before use. Some of
8744 them are expanded every time they are used; others are expanded only once.
8745
8746 When a string is being expanded it is copied verbatim from left to right except
8747 when a dollar or backslash character is encountered. A dollar specifies the
8748 start of a portion of the string that is interpreted and replaced as described
8749 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8750 escape character, as described in the following section.
8751
8752 Whether a string is expanded depends upon the context.  Usually this is solely
8753 dependent upon the option for which a value is sought; in this documentation,
8754 options for which string expansion is performed are marked with &dagger; after
8755 the data type.  ACL rules always expand strings.  A couple of expansion
8756 conditions do not expand some of the brace-delimited branches, for security
8757 reasons.
8758
8759
8760
8761 .section "Literal text in expanded strings" "SECTlittext"
8762 .cindex "expansion" "including literal text"
8763 An uninterpreted dollar can be included in an expanded string by putting a
8764 backslash in front of it. A backslash can be used to prevent any special
8765 character being treated specially in an expansion, including backslash itself.
8766 If the string appears in quotes in the configuration file, two backslashes are
8767 required because the quotes themselves cause interpretation of backslashes when
8768 the string is read in (see section &<<SECTstrings>>&).
8769
8770 .cindex "expansion" "non-expandable substrings"
8771 A portion of the string can specified as non-expandable by placing it between
8772 two occurrences of &`\N`&. This is particularly useful for protecting regular
8773 expressions, which often contain backslashes and dollar signs. For example:
8774 .code
8775 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8776 .endd
8777 On encountering the first &`\N`&, the expander copies subsequent characters
8778 without interpretation until it reaches the next &`\N`& or the end of the
8779 string.
8780
8781
8782
8783 .section "Character escape sequences in expanded strings" "SECID82"
8784 .cindex "expansion" "escape sequences"
8785 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8786 expanded string is recognized as an escape sequence for the character newline,
8787 carriage return, or tab, respectively. A backslash followed by up to three
8788 octal digits is recognized as an octal encoding for a single character, and a
8789 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8790 encoding.
8791
8792 These escape sequences are also recognized in quoted strings when they are read
8793 in. Their interpretation in expansions as well is useful for unquoted strings,
8794 and for other cases such as looked-up strings that are then expanded.
8795
8796
8797 .section "Testing string expansions" "SECID83"
8798 .cindex "expansion" "testing"
8799 .cindex "testing" "string expansion"
8800 .oindex "&%-be%&"
8801 Many expansions can be tested by calling Exim with the &%-be%& option. This
8802 takes the command arguments, or lines from the standard input if there are no
8803 arguments, runs them through the string expansion code, and writes the results
8804 to the standard output. Variables based on configuration values are set up, but
8805 since no message is being processed, variables such as &$local_part$& have no
8806 value. Nevertheless the &%-be%& option can be useful for checking out file and
8807 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8808 and &%nhash%&.
8809
8810 Exim gives up its root privilege when it is called with the &%-be%& option, and
8811 instead runs under the uid and gid it was called with, to prevent users from
8812 using &%-be%& for reading files to which they do not have access.
8813
8814 .oindex "&%-bem%&"
8815 If you want to test expansions that include variables whose values are taken
8816 from a message, there are two other options that can be used. The &%-bem%&
8817 option is like &%-be%& except that it is followed by a file name. The file is
8818 read as a message before doing the test expansions. For example:
8819 .code
8820 exim -bem /tmp/test.message '$h_subject:'
8821 .endd
8822 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8823 Exim message identifier. For example:
8824 .code
8825 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8826 .endd
8827 This loads the message from Exim's spool before doing the test expansions, and
8828 is therefore restricted to admin users.
8829
8830
8831 .section "Forced expansion failure" "SECTforexpfai"
8832 .cindex "expansion" "forced failure"
8833 A number of expansions that are described in the following section have
8834 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8835 (which are sometimes called &"curly brackets"&). Which of the two strings is
8836 used depends on some condition that is evaluated as part of the expansion. If,
8837 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8838 the entire string expansion fails in a way that can be detected by the code
8839 that requested the expansion. This is called &"forced expansion failure"&, and
8840 its consequences depend on the circumstances. In some cases it is no different
8841 from any other expansion failure, but in others a different action may be
8842 taken. Such variations are mentioned in the documentation of the option that is
8843 being expanded.
8844
8845
8846
8847
8848 .section "Expansion items" "SECTexpansionitems"
8849 The following items are recognized in expanded strings. White space may be used
8850 between sub-items that are keywords or substrings enclosed in braces inside an
8851 outer set of braces, to improve readability. &*Warning*&: Within braces,
8852 white space is significant.
8853
8854 .vlist
8855 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8856 .cindex "expansion" "variables"
8857 Substitute the contents of the named variable, for example:
8858 .code
8859 $local_part
8860 ${domain}
8861 .endd
8862 The second form can be used to separate the name from subsequent alphanumeric
8863 characters. This form (using braces) is available only for variables; it does
8864 &'not'& apply to message headers. The names of the variables are given in
8865 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8866 given, the expansion fails.
8867
8868 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8869 .cindex "expansion" "operators"
8870 The string is first itself expanded, and then the operation specified by
8871 <&'op'&> is applied to it. For example:
8872 .code
8873 ${lc:$local_part}
8874 .endd
8875 The string starts with the first character after the colon, which may be
8876 leading white space. A list of operators is given in section &<<SECTexpop>>&
8877 below. The operator notation is used for simple expansion items that have just
8878 one argument, because it reduces the number of braces and therefore makes the
8879 string easier to understand.
8880
8881 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8882 This item inserts &"basic"& header lines. It is described with the &%header%&
8883 expansion item below.
8884
8885
8886 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8887 .cindex "expansion" "calling an acl"
8888 .cindex "&%acl%&" "call from expansion"
8889 The name and zero to nine argument strings are first expanded separately.  The expanded
8890 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8891 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8892 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8893 and may use the variables; if another acl expansion is used the values
8894 are restored after it returns.  If the ACL sets
8895 a value using a "message =" modifier and returns accept or deny, the value becomes
8896 the result of the expansion.
8897 If no message is set and the ACL returns accept or deny
8898 the expansion result is an empty string.
8899 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8900
8901
8902 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8903        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8904 .cindex "expansion" "extracting cerificate fields"
8905 .cindex "&%certextract%&" "certificate fields"
8906 .cindex "certificate" "extracting fields"
8907 The <&'certificate'&> must be a variable of type certificate.
8908 The field name is expanded and used to retrive the relevant field from
8909 the certificate.  Supported fields are:
8910 .display
8911 &`version        `&
8912 &`serial_number  `&
8913 &`subject        `& RFC4514 DN
8914 &`issuer         `& RFC4514 DN
8915 &`notbefore      `& time
8916 &`notafter       `& time
8917 &`sig_algorithm  `&
8918 &`signature      `&
8919 &`subj_altname   `& tagged list
8920 &`ocsp_uri       `& list
8921 &`crl_uri        `& list
8922 .endd
8923 If the field is found,
8924 <&'string2'&> is expanded, and replaces the whole item;
8925 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8926 variable &$value$& contains the value that has been extracted. Afterwards, it
8927 is restored to any previous value it might have had.
8928
8929 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8930 key is not found. If {<&'string2'&>} is also omitted, the value that was
8931 extracted is used.
8932
8933 Some field names take optional modifiers, appended and separated by commas.
8934
8935 The field selectors marked as "RFC4514" above
8936 output a Distinguished Name string which is
8937 not quite
8938 parseable by Exim as a comma-separated tagged list
8939 (the exceptions being elements containin commas).
8940 RDN elements of a single type may be selected by
8941 a modifier of the type label; if so the expansion
8942 result is a list (newline-separated by default).
8943 The separator may be changed by another modifer of
8944 a right angle-bracket followed immediately by the new separator.
8945 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8946
8947 The field selectors marked as "time" above
8948 take an optional modifier of "int"
8949 for which the result is the number of seconds since epoch.
8950 Otherwise the result is a human-readable string
8951 in the timezone selected by the main "timezone" option.
8952
8953 The field selectors marked as "list" above return a list,
8954 newline-separated by default,
8955 (embedded separator characters in elements are doubled).
8956 The separator may be changed by a modifier of
8957 a right angle-bracket followed immediately by the new separator.
8958
8959 The field selectors marked as "tagged" above
8960 prefix each list element with a type string and an equals sign.
8961 Elements of only one type may be selected by a modifier
8962 which is one of "dns", "uri" or "mail";
8963 if so the elenment tags are omitted.
8964
8965 If not otherwise noted field values are presented in human-readable form.
8966
8967 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8968        {*&<&'arg'&>&*}...}*&"
8969 .cindex &%dlfunc%&
8970 This expansion dynamically loads and then calls a locally-written C function.
8971 This functionality is available only if Exim is compiled with
8972 .code
8973 EXPAND_DLFUNC=yes
8974 .endd
8975 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8976 object so that it doesn't reload the same object file in the same Exim process
8977 (but of course Exim does start new processes frequently).
8978
8979 There may be from zero to eight arguments to the function. When compiling
8980 a local function that is to be called in this way, &_local_scan.h_& should be
8981 included. The Exim variables and functions that are defined by that API
8982 are also available for dynamically loaded functions. The function itself
8983 must have the following type:
8984 .code
8985 int dlfunction(uschar **yield, int argc, uschar *argv[])
8986 .endd
8987 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8988 function should return one of the following values:
8989
8990 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8991 into the expanded string that is being built.
8992
8993 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8994 from &'yield'&, if it is set.
8995
8996 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8997 taken from &'yield'& if it is set.
8998
8999 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9000
9001 When compiling a function that is to be used in this way with gcc,
9002 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9003 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9004
9005 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9006        {*&<&'string3'&>&*}}*&"
9007 .cindex "expansion" "extracting substrings by key"
9008 .cindex "&%extract%&" "substrings by key"
9009 The key and <&'string1'&> are first expanded separately. Leading and trailing
9010 white space is removed from the key (but not from any of the strings). The key
9011 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9012 form:
9013 .display
9014 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9015 .endd
9016 .vindex "&$value$&"
9017 where the equals signs and spaces (but not both) are optional. If any of the
9018 values contain white space, they must be enclosed in double quotes, and any
9019 values that are enclosed in double quotes are subject to escape processing as
9020 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9021 for the value that corresponds to the key. The search is case-insensitive. If
9022 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9023 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9024 variable &$value$& contains the value that has been extracted. Afterwards, it
9025 is restored to any previous value it might have had.
9026
9027 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9028 key is not found. If {<&'string2'&>} is also omitted, the value that was
9029 extracted is used. Thus, for example, these two expansions are identical, and
9030 yield &"2001"&:
9031 .code
9032 ${extract{gid}{uid=1984 gid=2001}}
9033 ${extract{gid}{uid=1984 gid=2001}{$value}}
9034 .endd
9035 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9036 appear, for example:
9037 .code
9038 ${extract{Z}{A=... B=...}{$value} fail }
9039 .endd
9040 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9041 {<&'string2'&>} must be present for &"fail"& to be recognized.
9042
9043
9044 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9045         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9046 .cindex "expansion" "extracting substrings by number"
9047 .cindex "&%extract%&" "substrings by number"
9048 The <&'number'&> argument must consist entirely of decimal digits,
9049 apart from leading and trailing white space, which is ignored.
9050 This is what distinguishes this form of &%extract%& from the previous kind. It
9051 behaves in the same way, except that, instead of extracting a named field, it
9052 extracts from <&'string1'&> the field whose number is given as the first
9053 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9054 <&'string3'&> as before.
9055
9056 The fields in the string are separated by any one of the characters in the
9057 separator string. These may include space or tab characters.
9058 The first field is numbered one. If the number is negative, the fields are
9059 counted from the end of the string, with the rightmost one numbered -1. If the
9060 number given is zero, the entire string is returned. If the modulus of the
9061 number is greater than the number of fields in the string, the result is the
9062 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9063 provided. For example:
9064 .code
9065 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9066 .endd
9067 yields &"42"&, and
9068 .code
9069 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9070 .endd
9071 yields &"99"&. Two successive separators mean that the field between them is
9072 empty (for example, the fifth field above).
9073
9074
9075 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9076 .cindex "list" "selecting by condition"
9077 .cindex "expansion" "selecting from list by condition"
9078 .vindex "&$item$&"
9079 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9080 default, but the separator can be changed in the usual way. For each item
9081 in this list, its value is place in &$item$&, and then the condition is
9082 evaluated. If the condition is true, &$item$& is added to the output as an
9083 item in a new list; if the condition is false, the item is discarded. The
9084 separator used for the output list is the same as the one used for the
9085 input, but a separator setting is not included in the output. For example:
9086 .code
9087 ${filter{a:b:c}{!eq{$item}{b}}
9088 .endd
9089 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9090 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9091
9092
9093 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9094 .cindex "hash function" "textual"
9095 .cindex "expansion" "textual hash"
9096 This is a textual hashing function, and was the first to be implemented in
9097 early versions of Exim. In current releases, there are other hashing functions
9098 (numeric, MD5, and SHA-1), which are described below.
9099
9100 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9101 <&'n'&>. If you are using fixed values for these numbers, that is, if
9102 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9103 use the simpler operator notation that avoids some of the braces:
9104 .code
9105 ${hash_<n>_<m>:<string>}
9106 .endd
9107 The second number is optional (in both notations). If <&'n'&> is greater than
9108 or equal to the length of the string, the expansion item returns the string.
9109 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9110 function to the string. The new string consists of characters taken from the
9111 first <&'m'&> characters of the string
9112 .code
9113 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9114 .endd
9115 If <&'m'&> is not present the value 26 is used, so that only lower case
9116 letters appear. For example:
9117 .display
9118 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9119 &`$hash{5}{monty}}           `&   yields  &`monty`&
9120 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9121 .endd
9122
9123 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9124         &*$h_*&<&'header&~name'&>&*:*&" &&&
9125        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9126         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9127        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9128         &*$rh_*&<&'header&~name'&>&*:*&"
9129 .cindex "expansion" "header insertion"
9130 .vindex "&$header_$&"
9131 .vindex "&$bheader_$&"
9132 .vindex "&$rheader_$&"
9133 .cindex "header lines" "in expansion strings"
9134 .cindex "header lines" "character sets"
9135 .cindex "header lines" "decoding"
9136 Substitute the contents of the named message header line, for example
9137 .code
9138 $header_reply-to:
9139 .endd
9140 The newline that terminates a header line is not included in the expansion, but
9141 internal newlines (caused by splitting the header line over several physical
9142 lines) may be present.
9143
9144 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9145 the data in the header line is interpreted.
9146
9147 .ilist
9148 .cindex "white space" "in header lines"
9149 &%rheader%& gives the original &"raw"& content of the header line, with no
9150 processing at all, and without the removal of leading and trailing white space.
9151
9152 .next
9153 .cindex "base64 encoding" "in header lines"
9154 &%bheader%& removes leading and trailing white space, and then decodes base64
9155 or quoted-printable MIME &"words"& within the header text, but does no
9156 character set translation. If decoding of what looks superficially like a MIME
9157 &"word"& fails, the raw string is returned. If decoding
9158 .cindex "binary zero" "in header line"
9159 produces a binary zero character, it is replaced by a question mark &-- this is
9160 what Exim does for binary zeros that are actually received in header lines.
9161
9162 .next
9163 &%header%& tries to translate the string as decoded by &%bheader%& to a
9164 standard character set. This is an attempt to produce the same string as would
9165 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9166 returned. Translation is attempted only on operating systems that support the
9167 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9168 a system Makefile or in &_Local/Makefile_&.
9169 .endlist ilist
9170
9171 In a filter file, the target character set for &%header%& can be specified by a
9172 command of the following form:
9173 .code
9174 headers charset "UTF-8"
9175 .endd
9176 This command affects all references to &$h_$& (or &$header_$&) expansions in
9177 subsequently obeyed filter commands. In the absence of this command, the target
9178 character set in a filter is taken from the setting of the &%headers_charset%&
9179 option in the runtime configuration. The value of this option defaults to the
9180 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9181 ISO-8859-1.
9182
9183 Header names follow the syntax of RFC 2822, which states that they may contain
9184 any printing characters except space and colon. Consequently, curly brackets
9185 &'do not'& terminate header names, and should not be used to enclose them as
9186 if they were variables. Attempting to do so causes a syntax error.
9187
9188 Only header lines that are common to all copies of a message are visible to
9189 this mechanism. These are the original header lines that are received with the
9190 message, and any that are added by an ACL statement or by a system
9191 filter. Header lines that are added to a particular copy of a message by a
9192 router or transport are not accessible.
9193
9194 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9195 before the DATA ACL, because the header structure is not set up until the
9196 message is received. Header lines that are added in a RCPT ACL (for example)
9197 are saved until the message's incoming header lines are available, at which
9198 point they are added. When a DATA ACL is running, however, header lines added
9199 by earlier ACLs are visible.
9200
9201 Upper case and lower case letters are synonymous in header names. If the
9202 following character is white space, the terminating colon may be omitted, but
9203 this is not recommended, because you may then forget it when it is needed. When
9204 white space terminates the header name, it is included in the expanded string.
9205 If the message does not contain the given header, the expansion item is
9206 replaced by an empty string. (See the &%def%& condition in section
9207 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9208
9209 If there is more than one header with the same name, they are all concatenated
9210 to form the substitution string, up to a maximum length of 64K. Unless
9211 &%rheader%& is being used, leading and trailing white space is removed from
9212 each header before concatenation, and a completely empty header is ignored. A
9213 newline character is then inserted between non-empty headers, but there is no
9214 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9215 those headers that contain lists of addresses, a comma is also inserted at the
9216 junctions between headers. This does not happen for the &%rheader%& expansion.
9217
9218
9219 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9220 .cindex "expansion" "hmac hashing"
9221 .cindex &%hmac%&
9222 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9223 shared secret and some text into a message authentication code, as specified in
9224 RFC 2104. This differs from &`${md5:secret_text...}`& or
9225 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9226 cryptographic hash, allowing for authentication that is not possible with MD5
9227 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9228 present. For example:
9229 .code
9230 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9231 .endd
9232 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9233 produces:
9234 .code
9235 dd97e3ba5d1a61b5006108f8c8252953
9236 .endd
9237 As an example of how this might be used, you might put in the main part of
9238 an Exim configuration:
9239 .code
9240 SPAMSCAN_SECRET=cohgheeLei2thahw
9241 .endd
9242 In a router or a transport you could then have:
9243 .code
9244 headers_add = \
9245   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9246   ${hmac{md5}{SPAMSCAN_SECRET}\
9247   {${primary_hostname},${message_exim_id},$h_message-id:}}
9248 .endd
9249 Then given a message, you can check where it was scanned by looking at the
9250 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9251 this header line is authentic by recomputing the authentication code from the
9252 host name, message ID and the &'Message-id:'& header line. This can be done
9253 using Exim's &%-be%& option, or by other means, for example by using the
9254 &'hmac_md5_hex()'& function in Perl.
9255
9256
9257 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9258 .cindex "expansion" "conditional"
9259 .cindex "&%if%&, expansion item"
9260 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9261 item; otherwise <&'string2'&> is used. The available conditions are described
9262 in section &<<SECTexpcond>>& below. For example:
9263 .code
9264 ${if eq {$local_part}{postmaster} {yes}{no} }
9265 .endd
9266 The second string need not be present; if it is not and the condition is not
9267 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9268 be present instead of the second string (without any curly brackets). In this
9269 case, the expansion is forced to fail if the condition is not true (see section
9270 &<<SECTforexpfai>>&).
9271
9272 If both strings are omitted, the result is the string &`true`& if the condition
9273 is true, and the empty string if the condition is false. This makes it less
9274 cumbersome to write custom ACL and router conditions. For example, instead of
9275 .code
9276 condition = ${if >{$acl_m4}{3}{true}{false}}
9277 .endd
9278 you can use
9279 .code
9280 condition = ${if >{$acl_m4}{3}}
9281 .endd
9282
9283 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9284 .cindex "expansion" "string truncation"
9285 .cindex "&%length%& expansion item"
9286 The &%length%& item is used to extract the initial portion of a string. Both
9287 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9288 you are using a fixed value for the number, that is, if <&'string1'&> does not
9289 change when expanded, you can use the simpler operator notation that avoids
9290 some of the braces:
9291 .code
9292 ${length_<n>:<string>}
9293 .endd
9294 The result of this item is either the first <&'n'&> characters or the whole
9295 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9296 &%strlen%&, which gives the length of a string.
9297
9298
9299 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9300         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9301 .cindex "expansion" "extracting list elements by number"
9302 .cindex "&%listextract%&" "extract list elements by number"
9303 .cindex "list" "extracting elements by number"
9304 The <&'number'&> argument must consist entirely of decimal digits,
9305 apart from an optional leading minus,
9306 and leading and trailing white space (which is ignored).
9307
9308 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9309 default, but the separator can be changed in the usual way.
9310
9311 The first field of the list is numbered one.
9312 If the number is negative, the fields are
9313 counted from the end of the list, with the rightmost one numbered -1.
9314 The numbered element of the list is extracted and placed in &$value$&,
9315 then <&'string2'&> is expanded as the result.
9316
9317 If the modulus of the
9318 number is zero or greater than the number of fields in the string,
9319 the result is the expansion of <&'string3'&>.
9320
9321 For example:
9322 .code
9323 ${listextract{2}{x:42:99}}
9324 .endd
9325 yields &"42"&, and
9326 .code
9327 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9328 .endd
9329 yields &"result: 99"&.
9330
9331 If {<&'string3'&>} is omitted, an empty string is used for string3.
9332 If {<&'string2'&>} is also omitted, the value that was
9333 extracted is used.
9334 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9335
9336
9337 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9338         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9339 This is the first of one of two different types of lookup item, which are both
9340 described in the next item.
9341
9342 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9343         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9344 .cindex "expansion" "lookup in"
9345 .cindex "file" "lookups"
9346 .cindex "lookup" "in expanded string"
9347 The two forms of lookup item specify data lookups in files and databases, as
9348 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9349 lookups, and the second is used for query-style lookups. The <&'key'&>,
9350 <&'file'&>, and <&'query'&> strings are expanded before use.
9351
9352 If there is any white space in a lookup item which is part of a filter command,
9353 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9354 other place where white space is significant, the lookup item must be enclosed
9355 in double quotes. The use of data lookups in users' filter files may be locked
9356 out by the system administrator.
9357
9358 .vindex "&$value$&"
9359 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9360 During its expansion, the variable &$value$& contains the data returned by the
9361 lookup. Afterwards it reverts to the value it had previously (at the outer
9362 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9363 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9364 string on failure. If <&'string2'&> is provided, it can itself be a nested
9365 lookup, thus providing a mechanism for looking up a default value when the
9366 original lookup fails.
9367
9368 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9369 data for the outer lookup while the parameters of the second lookup are
9370 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9371 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9372 appear, and in this case, if the lookup fails, the entire expansion is forced
9373 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9374 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9375 successful lookup, and nothing in the case of failure.
9376
9377 For single-key lookups, the string &"partial"& is permitted to precede the
9378 search type in order to do partial matching, and * or *@ may follow a search
9379 type to request default lookups if the key does not match (see sections
9380 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9381
9382 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9383 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9384 and non-wild parts of the key during the expansion of the replacement text.
9385 They return to their previous values at the end of the lookup item.
9386
9387 This example looks up the postmaster alias in the conventional alias file:
9388 .code
9389 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9390 .endd
9391 This example uses NIS+ to look up the full name of the user corresponding to
9392 the local part of an address, forcing the expansion to fail if it is not found:
9393 .code
9394 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9395   {$value}fail}
9396 .endd
9397
9398
9399 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9400 .cindex "expansion" "list creation"
9401 .vindex "&$item$&"
9402 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9403 default, but the separator can be changed in the usual way. For each item
9404 in this list, its value is place in &$item$&, and then <&'string2'&> is
9405 expanded and added to the output as an item in a new list. The separator used
9406 for the output list is the same as the one used for the input, but a separator
9407 setting is not included in the output. For example:
9408 .code
9409 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9410 .endd
9411 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9412 value of &$item$& is restored to what it was before. See also the &*filter*&
9413 and &*reduce*& expansion items.
9414
9415 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9416 .cindex "expansion" "numeric hash"
9417 .cindex "hash function" "numeric"
9418 The three strings are expanded; the first two must yield numbers. Call them
9419 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9420 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9421 can use the simpler operator notation that avoids some of the braces:
9422 .code
9423 ${nhash_<n>_<m>:<string>}
9424 .endd
9425 The second number is optional (in both notations). If there is only one number,
9426 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9427 processed by a div/mod hash function that returns two numbers, separated by a
9428 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9429 example,
9430 .code
9431 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9432 .endd
9433 returns the string &"6/33"&.
9434
9435
9436
9437 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9438 .cindex "Perl" "use in expanded string"
9439 .cindex "expansion" "calling Perl from"
9440 This item is available only if Exim has been built to include an embedded Perl
9441 interpreter. The subroutine name and the arguments are first separately
9442 expanded, and then the Perl subroutine is called with those arguments. No
9443 additional arguments need be given; the maximum number permitted, including the
9444 name of the subroutine, is nine.
9445
9446 The return value of the subroutine is inserted into the expanded string, unless
9447 the return value is &%undef%&. In that case, the expansion fails in the same
9448 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9449 Whatever you return is evaluated in a scalar context. For example, if you
9450 return the name of a Perl vector, the return value is the size of the vector,
9451 not its contents.
9452
9453 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9454 with the error message that was passed to &%die%&. More details of the embedded
9455 Perl facility are given in chapter &<<CHAPperl>>&.
9456
9457 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9458 out the use of this expansion item in filter files.
9459
9460
9461 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9462 .cindex "&%prvs%& expansion item"
9463 The first argument is a complete email address and the second is secret
9464 keystring. The third argument, specifying a key number, is optional. If absent,
9465 it defaults to 0. The result of the expansion is a prvs-signed email address,
9466 to be typically used with the &%return_path%& option on an &(smtp)& transport
9467 as part of a bounce address tag validation (BATV) scheme. For more discussion
9468 and an example, see section &<<SECTverifyPRVS>>&.
9469
9470 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9471         {*&<&'string'&>&*}}*&"
9472 .cindex "&%prvscheck%& expansion item"
9473 This expansion item is the complement of the &%prvs%& item. It is used for
9474 checking prvs-signed addresses. If the expansion of the first argument does not
9475 yield a syntactically valid prvs-signed address, the whole item expands to the
9476 empty string. When the first argument does expand to a syntactically valid
9477 prvs-signed address, the second argument is expanded, with the prvs-decoded
9478 version of the address and the key number extracted from the address in the
9479 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9480
9481 These two variables can be used in the expansion of the second argument to
9482 retrieve the secret. The validity of the prvs-signed address is then checked
9483 against the secret. The result is stored in the variable &$prvscheck_result$&,
9484 which is empty for failure or &"1"& for success.
9485
9486 The third argument is optional; if it is missing, it defaults to an empty
9487 string. This argument is now expanded. If the result is an empty string, the
9488 result of the expansion is the decoded version of the address. This is the case
9489 whether or not the signature was valid. Otherwise, the result of the expansion
9490 is the expansion of the third argument.
9491
9492 All three variables can be used in the expansion of the third argument.
9493 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9494 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9495
9496 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9497 .cindex "expansion" "inserting an entire file"
9498 .cindex "file" "inserting into expansion"
9499 .cindex "&%readfile%& expansion item"
9500 The file name and end-of-line string are first expanded separately. The file is
9501 then read, and its contents replace the entire item. All newline characters in
9502 the file are replaced by the end-of-line string if it is present. Otherwise,
9503 newlines are left in the string.
9504 String expansion is not applied to the contents of the file. If you want this,
9505 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9506 the string expansion fails.
9507
9508 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9509 locks out the use of this expansion item in filter files.
9510
9511
9512
9513 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9514         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9515 .cindex "expansion" "inserting from a socket"
9516 .cindex "socket, use of in expansion"
9517 .cindex "&%readsocket%& expansion item"
9518 This item inserts data from a Unix domain or Internet socket into the expanded
9519 string. The minimal way of using it uses just two arguments, as in these
9520 examples:
9521 .code
9522 ${readsocket{/socket/name}{request string}}
9523 ${readsocket{inet:some.host:1234}{request string}}
9524 .endd
9525 For a Unix domain socket, the first substring must be the path to the socket.
9526 For an Internet socket, the first substring must contain &`inet:`& followed by
9527 a host name or IP address, followed by a colon and a port, which can be a
9528 number or the name of a TCP port in &_/etc/services_&. An IP address may
9529 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9530 example:
9531 .code
9532 ${readsocket{inet:[::1]:1234}{request string}}
9533 .endd
9534 Only a single host name may be given, but if looking it up yields more than
9535 one IP address, they are each tried in turn until a connection is made. For
9536 both kinds of socket, Exim makes a connection, writes the request string
9537 (unless it is an empty string) and reads from the socket until an end-of-file
9538 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9539 extend what can be done. Firstly, you can vary the timeout. For example:
9540 .code
9541 ${readsocket{/socket/name}{request string}{3s}}
9542 .endd
9543 A fourth argument allows you to change any newlines that are in the data
9544 that is read, in the same way as for &%readfile%& (see above). This example
9545 turns them into spaces:
9546 .code
9547 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9548 .endd
9549 As with all expansions, the substrings are expanded before the processing
9550 happens. Errors in these sub-expansions cause the expansion to fail. In
9551 addition, the following errors can occur:
9552
9553 .ilist
9554 Failure to create a socket file descriptor;
9555 .next
9556 Failure to connect the socket;
9557 .next
9558 Failure to write the request string;
9559 .next
9560 Timeout on reading from the socket.
9561 .endlist
9562
9563 By default, any of these errors causes the expansion to fail. However, if
9564 you supply a fifth substring, it is expanded and used when any of the above
9565 errors occurs. For example:
9566 .code
9567 ${readsocket{/socket/name}{request string}{3s}{\n}\
9568   {socket failure}}
9569 .endd
9570 You can test for the existence of a Unix domain socket by wrapping this
9571 expansion in &`${if exists`&, but there is a race condition between that test
9572 and the actual opening of the socket, so it is safer to use the fifth argument
9573 if you want to be absolutely sure of avoiding an expansion error for a
9574 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9575
9576 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9577 locks out the use of this expansion item in filter files.
9578
9579
9580 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9581 .cindex "expansion" "reducing a list to a scalar"
9582 .cindex "list" "reducing to a scalar"
9583 .vindex "&$value$&"
9584 .vindex "&$item$&"
9585 This operation reduces a list to a single, scalar string. After expansion,
9586 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9587 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9588 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9589 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9590 them. The result of that expansion is assigned to &$value$& before the next
9591 iteration. When the end of the list is reached, the final value of &$value$& is
9592 added to the expansion output. The &*reduce*& expansion item can be used in a
9593 number of ways. For example, to add up a list of numbers:
9594 .code
9595 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9596 .endd
9597 The result of that expansion would be &`6`&. The maximum of a list of numbers
9598 can be found:
9599 .code
9600 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9601 .endd
9602 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9603 restored to what they were before. See also the &*filter*& and &*map*&
9604 expansion items.
9605
9606 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9607 This item inserts &"raw"& header lines. It is described with the &%header%&
9608 expansion item above.
9609
9610 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9611         {*&<&'string2'&>&*}}*&"
9612 .cindex "expansion" "running a command"
9613 .cindex "&%run%& expansion item"
9614 The command and its arguments are first expanded as one string. The string is
9615 split apart into individual arguments by spaces, and then the command is run
9616 in a separate process, but under the same uid and gid.  As in other command
9617 executions from Exim, a shell is not used by default. If the command requires
9618 a shell, you must explicitly code it.
9619
9620 Since the arguments are split by spaces, when there is a variable expansion
9621 which has an empty result, it will cause the situation that the argument will
9622 simply be omitted when the program is actually executed by Exim. If the
9623 script/program requires a specific number of arguments and the expanded
9624 variable could possibly result in this empty expansion, the variable must be
9625 quoted. This is more difficult if the expanded variable itself could result
9626 in a string containing quotes, because it would interfere with the quotes
9627 around the command arguments. A possible guard against this is to wrap the
9628 variable in the &%sg%& operator to change any quote marks to some other
9629 character.
9630
9631 The standard input for the command exists, but is empty. The standard output
9632 and standard error are set to the same file descriptor.
9633 .cindex "return code" "from &%run%& expansion"
9634 .vindex "&$value$&"
9635 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9636 and replaces the entire item; during this expansion, the standard output/error
9637 from the command is in the variable &$value$&. If the command fails,
9638 <&'string2'&>, if present, is expanded and used. Once again, during the
9639 expansion, the standard output/error from the command is in the variable
9640 &$value$&.
9641
9642 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9643 can be the word &"fail"& (not in braces) to force expansion failure if the
9644 command does not succeed. If both strings are omitted, the result is contents
9645 of the standard output/error on success, and nothing on failure.
9646
9647 .vindex "&$run_in_acl$&"
9648 The standard output/error of the command is put in the variable &$value$&.
9649 In this ACL example, the output of a command is logged for the admin to
9650 troubleshoot:
9651 .code
9652 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9653       log_message  = Output of id: $value
9654 .endd
9655 If the command requires shell idioms, such as the > redirect operator, the
9656 shell must be invoked directly, such as with:
9657 .code
9658 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9659 .endd
9660
9661 .vindex "&$runrc$&"
9662 The return code from the command is put in the variable &$runrc$&, and this
9663 remains set afterwards, so in a filter file you can do things like this:
9664 .code
9665 if "${run{x y z}{}}$runrc" is 1 then ...
9666   elif $runrc is 2 then ...
9667   ...
9668 endif
9669 .endd
9670 If execution of the command fails (for example, the command does not exist),
9671 the return code is 127 &-- the same code that shells use for non-existent
9672 commands.
9673
9674 &*Warning*&: In a router or transport, you cannot assume the order in which
9675 option values are expanded, except for those preconditions whose order of
9676 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9677 by the expansion of one option, and use it in another.
9678
9679 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9680 out the use of this expansion item in filter files.
9681
9682
9683 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9684 .cindex "expansion" "string substitution"
9685 .cindex "&%sg%& expansion item"
9686 This item works like Perl's substitution operator (s) with the global (/g)
9687 option; hence its name. However, unlike the Perl equivalent, Exim does not
9688 modify the subject string; instead it returns the modified string for insertion
9689 into the overall expansion. The item takes three arguments: the subject string,
9690 a regular expression, and a substitution string. For example:
9691 .code
9692 ${sg{abcdefabcdef}{abc}{xyz}}
9693 .endd
9694 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9695 if any $ or \ characters are required in the regular expression or in the
9696 substitution string, they have to be escaped. For example:
9697 .code
9698 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9699 .endd
9700 yields &"defabc"&, and
9701 .code
9702 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9703 .endd
9704 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9705 the regular expression from string expansion.
9706
9707
9708
9709 .new
9710 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9711 .cindex sorting a list
9712 .cindex list sorting
9713 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9714 default, but the separator can be changed in the usual way.
9715 The <&'comparator'&> argument is interpreted as the operator
9716 of a two-argument expansion condition.
9717 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9718 The comparison should return true when applied to two values
9719 if the first value should sort before the second value.
9720 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9721 the element being placed in &$item$&,
9722 to give values for comparison.
9723
9724 The item result is a sorted list,
9725 with the original list separator,
9726 of the list elements (in full) of the original.
9727
9728 Examples:
9729 .code
9730 ${sort{3:2:1:4}{<}{$item}}
9731 .endd
9732 sorts a list of numbers, and
9733 .code
9734 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9735 .endd
9736 will sort an MX lookup into priority order.
9737 .wen
9738
9739
9740 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9741 .cindex "&%substr%& expansion item"
9742 .cindex "substring extraction"
9743 .cindex "expansion" "substring extraction"
9744 The three strings are expanded; the first two must yield numbers. Call them
9745 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9746 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9747 can use the simpler operator notation that avoids some of the braces:
9748 .code
9749 ${substr_<n>_<m>:<string>}
9750 .endd
9751 The second number is optional (in both notations).
9752 If it is absent in the simpler format, the preceding underscore must also be
9753 omitted.
9754
9755 The &%substr%& item can be used to extract more general substrings than
9756 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9757 length required. For example
9758 .code
9759 ${substr{3}{2}{$local_part}}
9760 .endd
9761 If the starting offset is greater than the string length the result is the
9762 null string; if the length plus starting offset is greater than the string
9763 length, the result is the right-hand part of the string, starting from the
9764 given offset. The first character in the string has offset zero.
9765
9766 The &%substr%& expansion item can take negative offset values to count
9767 from the right-hand end of its operand. The last character is offset -1, the
9768 second-last is offset -2, and so on. Thus, for example,
9769 .code
9770 ${substr{-5}{2}{1234567}}
9771 .endd
9772 yields &"34"&. If the absolute value of a negative offset is greater than the
9773 length of the string, the substring starts at the beginning of the string, and
9774 the length is reduced by the amount of overshoot. Thus, for example,
9775 .code
9776 ${substr{-5}{2}{12}}
9777 .endd
9778 yields an empty string, but
9779 .code
9780 ${substr{-3}{2}{12}}
9781 .endd
9782 yields &"1"&.
9783
9784 When the second number is omitted from &%substr%&, the remainder of the string
9785 is taken if the offset is positive. If it is negative, all characters in the
9786 string preceding the offset point are taken. For example, an offset of -1 and
9787 no length, as in these semantically identical examples:
9788 .code
9789 ${substr_-1:abcde}
9790 ${substr{-1}{abcde}}
9791 .endd
9792 yields all but the last character of the string, that is, &"abcd"&.
9793
9794
9795
9796 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9797         {*&<&'replacements'&>&*}}*&"
9798 .cindex "expansion" "character translation"
9799 .cindex "&%tr%& expansion item"
9800 This item does single-character translation on its subject string. The second
9801 argument is a list of characters to be translated in the subject string. Each
9802 matching character is replaced by the corresponding character from the
9803 replacement list. For example
9804 .code
9805 ${tr{abcdea}{ac}{13}}
9806 .endd
9807 yields &`1b3de1`&. If there are duplicates in the second character string, the
9808 last occurrence is used. If the third string is shorter than the second, its
9809 last character is replicated. However, if it is empty, no translation takes
9810 place.
9811 .endlist
9812
9813
9814
9815 .section "Expansion operators" "SECTexpop"
9816 .cindex "expansion" "operators"
9817 For expansion items that perform transformations on a single argument string,
9818 the &"operator"& notation is used because it is simpler and uses fewer braces.
9819 The substring is first expanded before the operation is applied to it. The
9820 following operations can be performed:
9821
9822 .vlist
9823 .vitem &*${address:*&<&'string'&>&*}*&
9824 .cindex "expansion" "RFC 2822 address handling"
9825 .cindex "&%address%& expansion item"
9826 The string is interpreted as an RFC 2822 address, as it might appear in a
9827 header line, and the effective address is extracted from it. If the string does
9828 not parse successfully, the result is empty.
9829
9830
9831 .vitem &*${addresses:*&<&'string'&>&*}*&
9832 .cindex "expansion" "RFC 2822 address handling"
9833 .cindex "&%addresses%& expansion item"
9834 The string (after expansion) is interpreted as a list of addresses in RFC
9835 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9836 operative address (&'local-part@domain'&) is extracted from each item, and the
9837 result of the expansion is a colon-separated list, with appropriate
9838 doubling of colons should any happen to be present in the email addresses.
9839 Syntactically invalid RFC2822 address items are omitted from the output.
9840
9841 It is possible to specify a character other than colon for the output
9842 separator by starting the string with > followed by the new separator
9843 character. For example:
9844 .code
9845 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9846 .endd
9847 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9848 expansion item, which extracts the working address from a single RFC2822
9849 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9850 processing lists.
9851
9852 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9853 a strict interpretation of header line formatting.  Exim parses the bare,
9854 unquoted portion of an email address and if it finds a comma, treats it as an
9855 email address seperator. For the example header line:
9856 .code
9857 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9858 .endd
9859 The first example below demonstrates that Q-encoded email addresses are parsed
9860 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9861 It does not see the comma because it's still encoded as "=2C".  The second
9862 example below is passed the contents of &`$header_from:`&, meaning it gets
9863 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9864 The third example shows that the presence of a comma is skipped when it is
9865 quoted.
9866 .code
9867 # exim -be '${addresses:From: \
9868 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9869 user@example.com
9870 # exim -be '${addresses:From: Last, First <user@example.com>}'
9871 Last:user@example.com
9872 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9873 user@example.com
9874 .endd
9875
9876 .vitem &*${base62:*&<&'digits'&>&*}*&
9877 .cindex "&%base62%& expansion item"
9878 .cindex "expansion" "conversion to base 62"
9879 The string must consist entirely of decimal digits. The number is converted to
9880 base 62 and output as a string of six characters, including leading zeros. In
9881 the few operating environments where Exim uses base 36 instead of base 62 for
9882 its message identifiers (because those systems do not have case-sensitive file
9883 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9884 be absolutely clear: this is &'not'& base64 encoding.
9885
9886 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9887 .cindex "&%base62d%& expansion item"
9888 .cindex "expansion" "conversion to base 62"
9889 The string must consist entirely of base-62 digits, or, in operating
9890 environments where Exim uses base 36 instead of base 62 for its message
9891 identifiers, base-36 digits. The number is converted to decimal and output as a
9892 string.
9893
9894
9895 .vitem &*${domain:*&<&'string'&>&*}*&
9896 .cindex "domain" "extraction"
9897 .cindex "expansion" "domain extraction"
9898 The string is interpreted as an RFC 2822 address and the domain is extracted
9899 from it. If the string does not parse successfully, the result is empty.
9900
9901
9902 .vitem &*${escape:*&<&'string'&>&*}*&
9903 .cindex "expansion" "escaping non-printing characters"
9904 .cindex "&%escape%& expansion item"
9905 If the string contains any non-printing characters, they are converted to
9906 escape sequences starting with a backslash. Whether characters with the most
9907 significant bit set (so-called &"8-bit characters"&) count as printing or not
9908 is controlled by the &%print_topbitchars%& option.
9909
9910
9911 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9912 .cindex "expansion" "expression evaluation"
9913 .cindex "expansion" "arithmetic expression"
9914 .cindex "&%eval%& expansion item"
9915 These items supports simple arithmetic and bitwise logical operations in
9916 expansion strings. The string (after expansion) must be a conventional
9917 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9918 logical operators, and parentheses. All operations are carried out using
9919 integer arithmetic. The operator priorities are as follows (the same as in the
9920 C programming language):
9921 .table2 70pt 300pt
9922 .irow &'highest:'& "not (~), negate (-)"
9923 .irow ""   "multiply (*), divide (/), remainder (%)"
9924 .irow ""   "plus (+), minus (-)"
9925 .irow ""   "shift-left (<<), shift-right (>>)"
9926 .irow ""   "and (&&)"
9927 .irow ""   "xor (^)"
9928 .irow &'lowest:'&  "or (|)"
9929 .endtable
9930 Binary operators with the same priority are evaluated from left to right. White
9931 space is permitted before or after operators.
9932
9933 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9934 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9935 decimal, even if they start with a leading zero; hexadecimal numbers are not
9936 permitted. This can be useful when processing numbers extracted from dates or
9937 times, which often do have leading zeros.
9938
9939 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9940 or 1024*1024*1024,
9941 respectively. Negative numbers are supported. The result of the computation is
9942 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9943
9944 .display
9945 &`${eval:1+1}            `&  yields 2
9946 &`${eval:1+2*3}          `&  yields 7
9947 &`${eval:(1+2)*3}        `&  yields 9
9948 &`${eval:2+42%5}         `&  yields 4
9949 &`${eval:0xc&amp;5}          `&  yields 4
9950 &`${eval:0xc|5}          `&  yields 13
9951 &`${eval:0xc^5}          `&  yields 9
9952 &`${eval:0xc>>1}         `&  yields 6
9953 &`${eval:0xc<<1}         `&  yields 24
9954 &`${eval:~255&amp;0x1234}    `&  yields 4608
9955 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9956 .endd
9957
9958 As a more realistic example, in an ACL you might have
9959 .code
9960 deny   message = Too many bad recipients
9961        condition =                    \
9962          ${if and {                   \
9963            {>{$rcpt_count}{10}}       \
9964            {                          \
9965            <                          \
9966              {$recipients_count}      \
9967              {${eval:$rcpt_count/2}}  \
9968            }                          \
9969          }{yes}{no}}
9970 .endd
9971 The condition is true if there have been more than 10 RCPT commands and
9972 fewer than half of them have resulted in a valid recipient.
9973
9974
9975 .vitem &*${expand:*&<&'string'&>&*}*&
9976 .cindex "expansion" "re-expansion of substring"
9977 The &%expand%& operator causes a string to be expanded for a second time. For
9978 example,
9979 .code
9980 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9981 .endd
9982 first looks up a string in a file while expanding the operand for &%expand%&,
9983 and then re-expands what it has found.
9984
9985
9986 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9987 .cindex "Unicode"
9988 .cindex "UTF-8" "conversion from"
9989 .cindex "expansion" "UTF-8 conversion"
9990 .cindex "&%from_utf8%& expansion item"
9991 The world is slowly moving towards Unicode, although there are no standards for
9992 email yet. However, other applications (including some databases) are starting
9993 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9994 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9995 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9996 the result is an undefined sequence of bytes.
9997
9998 Unicode code points with values less than 256 are compatible with ASCII and
9999 ISO-8859-1 (also known as Latin-1).
10000 For example, character 169 is the copyright symbol in both cases, though the
10001 way it is encoded is different. In UTF-8, more than one byte is needed for
10002 characters with code values greater than 127, whereas ISO-8859-1 is a
10003 single-byte encoding (but thereby limited to 256 characters). This makes
10004 translation from UTF-8 to ISO-8859-1 straightforward.
10005
10006
10007 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10008 .cindex "hash function" "textual"
10009 .cindex "expansion" "textual hash"
10010 The &%hash%& operator is a simpler interface to the hashing function that can
10011 be used when the two parameters are fixed numbers (as opposed to strings that
10012 change when expanded). The effect is the same as
10013 .code
10014 ${hash{<n>}{<m>}{<string>}}
10015 .endd
10016 See the description of the general &%hash%& item above for details. The
10017 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10018
10019
10020
10021 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10022 .cindex "base64 encoding" "conversion from hex"
10023 .cindex "expansion" "hex to base64"
10024 .cindex "&%hex2b64%& expansion item"
10025 This operator converts a hex string into one that is base64 encoded. This can
10026 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10027
10028
10029
10030 .vitem &*${hexquote:*&<&'string'&>&*}*&
10031 .cindex "quoting" "hex-encoded unprintable characters"
10032 .cindex "&%hexquote%& expansion item"
10033 This operator converts non-printable characters in a string into a hex
10034 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10035 as is, and other byte values are converted to &`\xNN`&, for example a
10036 byte value 127 is converted to &`\x7f`&.
10037
10038
10039 .vitem &*${lc:*&<&'string'&>&*}*&
10040 .cindex "case forcing in strings"
10041 .cindex "string" "case forcing"
10042 .cindex "lower casing"
10043 .cindex "expansion" "case forcing"
10044 .cindex "&%lc%& expansion item"
10045 This forces the letters in the string into lower-case, for example:
10046 .code
10047 ${lc:$local_part}
10048 .endd
10049
10050 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10051 .cindex "expansion" "string truncation"
10052 .cindex "&%length%& expansion item"
10053 The &%length%& operator is a simpler interface to the &%length%& function that
10054 can be used when the parameter is a fixed number (as opposed to a string that
10055 changes when expanded). The effect is the same as
10056 .code
10057 ${length{<number>}{<string>}}
10058 .endd
10059 See the description of the general &%length%& item above for details. Note that
10060 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10061 when &%length%& is used as an operator.
10062
10063
10064 .vitem &*${listcount:*&<&'string'&>&*}*&
10065 .cindex "expansion" "list item count"
10066 .cindex "list" "item count"
10067 .cindex "list" "count of items"
10068 .cindex "&%listcount%& expansion item"
10069 The string is interpreted as a list and the number of items is returned.
10070
10071
10072 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10073 .cindex "expansion" "named list"
10074 .cindex "&%listnamed%& expansion item"
10075 The name is interpreted as a named list and the content of the list is returned,
10076 expanding any referenced lists, re-quoting as needed for colon-separation.
10077 If the optional type is given it must be one of "a", "d", "h" or "l"
10078 and selects address-, domain-, host- or localpart- lists to search among respectively.
10079 Otherwise all types are searched in an undefined order and the first
10080 matching list is returned.
10081
10082
10083 .vitem &*${local_part:*&<&'string'&>&*}*&
10084 .cindex "expansion" "local part extraction"
10085 .cindex "&%local_part%& expansion item"
10086 The string is interpreted as an RFC 2822 address and the local part is
10087 extracted from it. If the string does not parse successfully, the result is
10088 empty.
10089
10090
10091 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10092 .cindex "masked IP address"
10093 .cindex "IP address" "masking"
10094 .cindex "CIDR notation"
10095 .cindex "expansion" "IP address masking"
10096 .cindex "&%mask%& expansion item"
10097 If the form of the string to be operated on is not an IP address followed by a
10098 slash and an integer (that is, a network address in CIDR notation), the
10099 expansion fails. Otherwise, this operator converts the IP address to binary,
10100 masks off the least significant bits according to the bit count, and converts
10101 the result back to text, with mask appended. For example,
10102 .code
10103 ${mask:10.111.131.206/28}
10104 .endd
10105 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10106 be mostly used for looking up masked addresses in files, the result for an IPv6
10107 address uses dots to separate components instead of colons, because colon
10108 terminates a key string in lsearch files. So, for example,
10109 .code
10110 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10111 .endd
10112 returns the string
10113 .code
10114 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10115 .endd
10116 Letters in IPv6 addresses are always output in lower case.
10117
10118
10119 .vitem &*${md5:*&<&'string'&>&*}*&
10120 .cindex "MD5 hash"
10121 .cindex "expansion" "MD5 hash"
10122 .cindex "certificate fingerprint"
10123 .cindex "&%md5%& expansion item"
10124 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10125 as a 32-digit hexadecimal number, in which any letters are in lower case.
10126
10127
10128 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10129 .cindex "expansion" "numeric hash"
10130 .cindex "hash function" "numeric"
10131 The &%nhash%& operator is a simpler interface to the numeric hashing function
10132 that can be used when the two parameters are fixed numbers (as opposed to
10133 strings that change when expanded). The effect is the same as
10134 .code
10135 ${nhash{<n>}{<m>}{<string>}}
10136 .endd
10137 See the description of the general &%nhash%& item above for details.
10138
10139
10140 .vitem &*${quote:*&<&'string'&>&*}*&
10141 .cindex "quoting" "in string expansions"
10142 .cindex "expansion" "quoting"
10143 .cindex "&%quote%& expansion item"
10144 The &%quote%& operator puts its argument into double quotes if it
10145 is an empty string or
10146 contains anything other than letters, digits, underscores, dots, and hyphens.
10147 Any occurrences of double quotes and backslashes are escaped with a backslash.
10148 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10149 respectively For example,
10150 .code
10151 ${quote:ab"*"cd}
10152 .endd
10153 becomes
10154 .code
10155 "ab\"*\"cd"
10156 .endd
10157 The place where this is useful is when the argument is a substitution from a
10158 variable or a message header.
10159
10160 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10161 .cindex "&%quote_local_part%& expansion item"
10162 This operator is like &%quote%&, except that it quotes the string only if
10163 required to do so by the rules of RFC 2822 for quoting local parts. For
10164 example, a plus sign would not cause quoting (but it would for &%quote%&).
10165 If you are creating a new email address from the contents of &$local_part$&
10166 (or any other unknown data), you should always use this operator.
10167
10168
10169 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10170 .cindex "quoting" "lookup-specific"
10171 This operator applies lookup-specific quoting rules to the string. Each
10172 query-style lookup type has its own quoting rules which are described with
10173 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10174 .code
10175 ${quote_ldap:two * two}
10176 .endd
10177 returns
10178 .code
10179 two%20%5C2A%20two
10180 .endd
10181 For single-key lookup types, no quoting is ever necessary and this operator
10182 yields an unchanged string.
10183
10184
10185 .vitem &*${randint:*&<&'n'&>&*}*&
10186 .cindex "random number"
10187 This operator returns a somewhat random number which is less than the
10188 supplied number and is at least 0.  The quality of this randomness depends
10189 on how Exim was built; the values are not suitable for keying material.
10190 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10191 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10192 for versions of GnuTLS with that function.
10193 Otherwise, the implementation may be arc4random(), random() seeded by
10194 srandomdev() or srandom(), or a custom implementation even weaker than
10195 random().
10196
10197
10198 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10199 .cindex "expansion" "IP address"
10200 This operator reverses an IP address; for IPv4 addresses, the result is in
10201 dotted-quad decimal form, while for IPv6 addreses the result is in
10202 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10203 for DNS.  For example,
10204 .code
10205 ${reverse_ip:192.0.2.4}
10206 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10207 .endd
10208 returns
10209 .code
10210 4.2.0.192
10211 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
10212 .endd
10213
10214
10215 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10216 .cindex "expansion" "RFC 2047"
10217 .cindex "RFC 2047" "expansion operator"
10218 .cindex "&%rfc2047%& expansion item"
10219 This operator encodes text according to the rules of RFC 2047. This is an
10220 encoding that is used in header lines to encode non-ASCII characters. It is
10221 assumed that the input string is in the encoding specified by the
10222 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10223 contains only characters in the range 33&--126, and no instances of the
10224 characters
10225 .code
10226 ? = ( ) < > @ , ; : \ " . [ ] _
10227 .endd
10228 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10229 string, using as many &"encoded words"& as necessary to encode all the
10230 characters.
10231
10232
10233 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10234 .cindex "expansion" "RFC 2047"
10235 .cindex "RFC 2047" "decoding"
10236 .cindex "&%rfc2047d%& expansion item"
10237 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10238 bytes are replaced by question marks. Characters are converted into the
10239 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10240 not recognized unless &%check_rfc2047_length%& is set false.
10241
10242 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10243 access a header line, RFC 2047 decoding is done automatically. You do not need
10244 to use this operator as well.
10245
10246
10247
10248 .vitem &*${rxquote:*&<&'string'&>&*}*&
10249 .cindex "quoting" "in regular expressions"
10250 .cindex "regular expressions" "quoting"
10251 .cindex "&%rxquote%& expansion item"
10252 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10253 characters in its argument. This is useful when substituting the values of
10254 variables or headers inside regular expressions.
10255
10256
10257 .vitem &*${sha1:*&<&'string'&>&*}*&
10258 .cindex "SHA-1 hash"
10259 .cindex "expansion" "SHA-1 hashing"
10260 .cindex "certificate fingerprint"
10261 .cindex "&%sha2%& expansion item"
10262 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10263 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10264
10265
10266 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10267 .cindex "SHA-256 hash"
10268 .cindex "certificate fingerprint"
10269 .cindex "expansion" "SHA-256 hashing"
10270 .cindex "&%sha256%& expansion item"
10271 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10272 certificate,
10273 and returns
10274 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10275 Only arguments which are a single variable of certificate type are supported.
10276
10277
10278 .vitem &*${stat:*&<&'string'&>&*}*&
10279 .cindex "expansion" "statting a file"
10280 .cindex "file" "extracting characteristics"
10281 .cindex "&%stat%& expansion item"
10282 The string, after expansion, must be a file path. A call to the &[stat()]&
10283 function is made for this path. If &[stat()]& fails, an error occurs and the
10284 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10285 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10286 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10287 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10288 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10289 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10290 can extract individual fields using the &%extract%& expansion item.
10291
10292 The use of the &%stat%& expansion in users' filter files can be locked out by
10293 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10294 systems for files larger than 2GB.
10295
10296 .vitem &*${str2b64:*&<&'string'&>&*}*&
10297 .cindex "expansion" "base64 encoding"
10298 .cindex "base64 encoding" "in string expansion"
10299 .cindex "&%str2b64%& expansion item"
10300 This operator converts a string into one that is base64 encoded.
10301
10302
10303
10304 .vitem &*${strlen:*&<&'string'&>&*}*&
10305 .cindex "expansion" "string length"
10306 .cindex "string" "length in expansion"
10307 .cindex "&%strlen%& expansion item"
10308 The item is replace by the length of the expanded string, expressed as a
10309 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10310
10311
10312 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10313 .cindex "&%substr%& expansion item"
10314 .cindex "substring extraction"
10315 .cindex "expansion" "substring expansion"
10316 The &%substr%& operator is a simpler interface to the &%substr%& function that
10317 can be used when the two parameters are fixed numbers (as opposed to strings
10318 that change when expanded). The effect is the same as
10319 .code
10320 ${substr{<start>}{<length>}{<string>}}
10321 .endd
10322 See the description of the general &%substr%& item above for details. The
10323 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10324
10325 .vitem &*${time_eval:*&<&'string'&>&*}*&
10326 .cindex "&%time_eval%& expansion item"
10327 .cindex "time interval" "decoding"
10328 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10329 seconds.
10330
10331 .vitem &*${time_interval:*&<&'string'&>&*}*&
10332 .cindex "&%time_interval%& expansion item"
10333 .cindex "time interval" "formatting"
10334 The argument (after sub-expansion) must be a sequence of decimal digits that
10335 represents an interval of time as a number of seconds. It is converted into a
10336 number of larger units and output in Exim's normal time format, for example,
10337 &`1w3d4h2m6s`&.
10338
10339 .vitem &*${uc:*&<&'string'&>&*}*&
10340 .cindex "case forcing in strings"
10341 .cindex "string" "case forcing"
10342 .cindex "upper casing"
10343 .cindex "expansion" "case forcing"
10344 .cindex "&%uc%& expansion item"
10345 This forces the letters in the string into upper-case.
10346
10347 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10348 .cindex "correction of invalid utf-8 sequences in strings"
10349 .cindex "utf-8" "utf-8 sequences"
10350 .cindex "incorrect utf-8"
10351 .cindex "expansion" "utf-8 forcing"
10352 .cindex "&%utf8clean%& expansion item"
10353 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10354 .endlist
10355
10356
10357
10358
10359
10360
10361 .section "Expansion conditions" "SECTexpcond"
10362 .scindex IIDexpcond "expansion" "conditions"
10363 The following conditions are available for testing by the &%${if%& construct
10364 while expanding strings:
10365
10366 .vlist
10367 .vitem &*!*&<&'condition'&>
10368 .cindex "expansion" "negating a condition"
10369 .cindex "negation" "in expansion condition"
10370 Preceding any condition with an exclamation mark negates the result of the
10371 condition.
10372
10373 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10374 .cindex "numeric comparison"
10375 .cindex "expansion" "numeric comparison"
10376 There are a number of symbolic operators for doing numeric comparisons. They
10377 are:
10378 .display
10379 &`=   `&   equal
10380 &`==  `&   equal
10381 &`>   `&   greater
10382 &`>=  `&   greater or equal
10383 &`<   `&   less
10384 &`<=  `&   less or equal
10385 .endd
10386 For example:
10387 .code
10388 ${if >{$message_size}{10M} ...
10389 .endd
10390 Note that the general negation operator provides for inequality testing. The
10391 two strings must take the form of optionally signed decimal integers,
10392 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10393 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10394 As a special case, the numerical value of an empty string is taken as
10395 zero.
10396
10397 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10398 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10399 10M, not if 10M is larger than &$message_size$&.
10400
10401
10402 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10403         {*&<&'arg2'&>&*}...}*&
10404 .cindex "expansion" "calling an acl"
10405 .cindex "&%acl%&" "expansion condition"
10406 The name and zero to nine argument strings are first expanded separately.  The expanded
10407 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10408 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10409 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10410 and may use the variables; if another acl expansion is used the values
10411 are restored after it returns.  If the ACL sets
10412 a value using a "message =" modifier the variable $value becomes
10413 the result of the expansion, otherwise it is empty.
10414 If the ACL returns accept the condition is true; if deny, false.
10415 If the ACL returns defer the result is a forced-fail.
10416
10417 .vitem &*bool&~{*&<&'string'&>&*}*&
10418 .cindex "expansion" "boolean parsing"
10419 .cindex "&%bool%& expansion condition"
10420 This condition turns a string holding a true or false representation into
10421 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10422 (case-insensitively); also integer numbers map to true if non-zero,
10423 false if zero.
10424 An empty string is treated as false.
10425 Leading and trailing whitespace is ignored;
10426 thus a string consisting only of whitespace is false.
10427 All other string values will result in expansion failure.
10428
10429 When combined with ACL variables, this expansion condition will let you
10430 make decisions in one place and act on those decisions in another place.
10431 For example:
10432 .code
10433 ${if bool{$acl_m_privileged_sender} ...
10434 .endd
10435
10436
10437 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10438 .cindex "expansion" "boolean parsing"
10439 .cindex "&%bool_lax%& expansion condition"
10440 Like &%bool%&, this condition turns a string into a boolean state.  But
10441 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10442 loose definition that the Router &%condition%& option uses.  The empty string
10443 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10444 true.  Leading and trailing whitespace is ignored.
10445
10446 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10447
10448 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10449 .cindex "expansion" "encrypted comparison"
10450 .cindex "encrypted strings, comparing"
10451 .cindex "&%crypteq%& expansion condition"
10452 This condition is included in the Exim binary if it is built to support any
10453 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10454 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10455 included in the binary.
10456
10457 The &%crypteq%& condition has two arguments. The first is encrypted and
10458 compared against the second, which is already encrypted. The second string may
10459 be in the LDAP form for storing encrypted strings, which starts with the
10460 encryption type in curly brackets, followed by the data. If the second string
10461 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10462 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10463 Typically this will be a field from a password file. An example of an encrypted
10464 string in LDAP form is:
10465 .code
10466 {md5}CY9rzUYh03PK3k6DJie09g==
10467 .endd
10468 If such a string appears directly in an expansion, the curly brackets have to
10469 be quoted, because they are part of the expansion syntax. For example:
10470 .code
10471 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10472 .endd
10473 The following encryption types (whose names are matched case-independently) are
10474 supported:
10475
10476 .ilist
10477 .cindex "MD5 hash"
10478 .cindex "base64 encoding" "in encrypted password"
10479 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10480 printable characters to compare with the remainder of the second string. If the
10481 length of the comparison string is 24, Exim assumes that it is base64 encoded
10482 (as in the above example). If the length is 32, Exim assumes that it is a
10483 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10484 comparison fails.
10485
10486 .next
10487 .cindex "SHA-1 hash"
10488 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10489 printable characters to compare with the remainder of the second string. If the
10490 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10491 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10492 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10493
10494 .next
10495 .cindex "&[crypt()]&"
10496 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10497 only the first eight characters of the password. However, in modern operating
10498 systems this is no longer true, and in many cases the entire password is used,
10499 whatever its length.
10500
10501 .next
10502 .cindex "&[crypt16()]&"
10503 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10504 use up to 16 characters of the password in some operating systems. Again, in
10505 modern operating systems, more characters may be used.
10506 .endlist
10507 Exim has its own version of &[crypt16()]&, which is just a double call to
10508 &[crypt()]&. For operating systems that have their own version, setting
10509 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10510 operating system version instead of its own. This option is set by default in
10511 the OS-dependent &_Makefile_& for those operating systems that are known to
10512 support &[crypt16()]&.
10513
10514 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10515 it was not using the same algorithm as some operating systems' versions. It
10516 turns out that as well as &[crypt16()]& there is a function called
10517 &[bigcrypt()]& in some operating systems. This may or may not use the same
10518 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10519
10520 However, since there is now a move away from the traditional &[crypt()]&
10521 functions towards using SHA1 and other algorithms, tidying up this area of
10522 Exim is seen as very low priority.
10523
10524 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10525 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10526 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10527 default is &`{crypt}`&. Whatever the default, you can always use either
10528 function by specifying it explicitly in curly brackets.
10529
10530 .vitem &*def:*&<&'variable&~name'&>
10531 .cindex "expansion" "checking for empty variable"
10532 .cindex "&%def%& expansion condition"
10533 The &%def%& condition must be followed by the name of one of the expansion
10534 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10535 variable does not contain the empty string. For example:
10536 .code
10537 ${if def:sender_ident {from $sender_ident}}
10538 .endd
10539 Note that the variable name is given without a leading &%$%& character. If the
10540 variable does not exist, the expansion fails.
10541
10542 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10543         &~&*def:h_*&<&'header&~name'&>&*:*&"
10544 .cindex "expansion" "checking header line existence"
10545 This condition is true if a message is being processed and the named header
10546 exists in the message. For example,
10547 .code
10548 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10549 .endd
10550 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10551 the header name must be terminated by a colon if white space does not follow.
10552
10553 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10554        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10555 .cindex "string" "comparison"
10556 .cindex "expansion" "string comparison"
10557 .cindex "&%eq%& expansion condition"
10558 .cindex "&%eqi%& expansion condition"
10559 The two substrings are first expanded. The condition is true if the two
10560 resulting strings are identical. For &%eq%& the comparison includes the case of
10561 letters, whereas for &%eqi%& the comparison is case-independent.
10562
10563 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10564 .cindex "expansion" "file existence test"
10565 .cindex "file" "existence test"
10566 .cindex "&%exists%&, expansion condition"
10567 The substring is first expanded and then interpreted as an absolute path. The
10568 condition is true if the named file (or directory) exists. The existence test
10569 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10570 users' filter files may be locked out by the system administrator.
10571
10572 .vitem &*first_delivery*&
10573 .cindex "delivery" "first"
10574 .cindex "first delivery"
10575 .cindex "expansion" "first delivery test"
10576 .cindex "&%first_delivery%& expansion condition"
10577 This condition, which has no data, is true during a message's first delivery
10578 attempt. It is false during any subsequent delivery attempts.
10579
10580
10581 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10582        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10583 .cindex "list" "iterative conditions"
10584 .cindex "expansion" "&*forall*& condition"
10585 .cindex "expansion" "&*forany*& condition"
10586 .vindex "&$item$&"
10587 These conditions iterate over a list. The first argument is expanded to form
10588 the list. By default, the list separator is a colon, but it can be changed by
10589 the normal method. The second argument is interpreted as a condition that is to
10590 be applied to each item in the list in turn. During the interpretation of the
10591 condition, the current list item is placed in a variable called &$item$&.
10592 .ilist
10593 For &*forany*&, interpretation stops if the condition is true for any item, and
10594 the result of the whole condition is true. If the condition is false for all
10595 items in the list, the overall condition is false.
10596 .next
10597 For &*forall*&, interpretation stops if the condition is false for any item,
10598 and the result of the whole condition is false. If the condition is true for
10599 all items in the list, the overall condition is true.
10600 .endlist
10601 Note that negation of &*forany*& means that the condition must be false for all
10602 items for the overall condition to succeed, and negation of &*forall*& means
10603 that the condition must be false for at least one item. In this example, the
10604 list separator is changed to a comma:
10605 .code
10606 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10607 .endd
10608 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10609 being processed, to enable these expansion items to be nested.
10610
10611 To scan a named list, expand it with the &*listnamed*& operator.
10612
10613
10614 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10615        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10616 .cindex "string" "comparison"
10617 .cindex "expansion" "string comparison"
10618 .cindex "&%ge%& expansion condition"
10619 .cindex "&%gei%& expansion condition"
10620 The two substrings are first expanded. The condition is true if the first
10621 string is lexically greater than or equal to the second string. For &%ge%& the
10622 comparison includes the case of letters, whereas for &%gei%& the comparison is
10623 case-independent.
10624
10625 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10626        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10627 .cindex "string" "comparison"
10628 .cindex "expansion" "string comparison"
10629 .cindex "&%gt%& expansion condition"
10630 .cindex "&%gti%& expansion condition"
10631 The two substrings are first expanded. The condition is true if the first
10632 string is lexically greater than the second string. For &%gt%& the comparison
10633 includes the case of letters, whereas for &%gti%& the comparison is
10634 case-independent.
10635
10636 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10637        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10638 .cindex "string" "comparison"
10639 .cindex "list" "iterative conditions"
10640 Both strings are expanded; the second string is treated as a list of simple
10641 strings; if the first string is a member of the second, then the condition
10642 is true.
10643
10644 These are simpler to use versions of the more powerful &*forany*& condition.
10645 Examples, and the &*forany*& equivalents:
10646 .code
10647 ${if inlist{needle}{foo:needle:bar}}
10648   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10649 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10650   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10651 .endd
10652
10653 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10654        &*isip4&~{*&<&'string'&>&*}*& &&&
10655        &*isip6&~{*&<&'string'&>&*}*&
10656 .cindex "IP address" "testing string format"
10657 .cindex "string" "testing for IP address"
10658 .cindex "&%isip%& expansion condition"
10659 .cindex "&%isip4%& expansion condition"
10660 .cindex "&%isip6%& expansion condition"
10661 The substring is first expanded, and then tested to see if it has the form of
10662 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10663 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10664
10665 For an IPv4 address, the test is for four dot-separated components, each of
10666 which consists of from one to three digits. For an IPv6 address, up to eight
10667 colon-separated components are permitted, each containing from one to four
10668 hexadecimal digits. There may be fewer than eight components if an empty
10669 component (adjacent colons) is present. Only one empty component is permitted.
10670
10671 &*Note*&: The checks are just on the form of the address; actual numerical
10672 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10673 check. The main use of these tests is to distinguish between IP addresses and
10674 host names, or between IPv4 and IPv6 addresses. For example, you could use
10675 .code
10676 ${if isip4{$sender_host_address}...
10677 .endd
10678 to test which IP version an incoming SMTP connection is using.
10679
10680 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10681 .cindex "LDAP" "use for authentication"
10682 .cindex "expansion" "LDAP authentication test"
10683 .cindex "&%ldapauth%& expansion condition"
10684 This condition supports user authentication using LDAP. See section
10685 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10686 queries. For this use, the query must contain a user name and password. The
10687 query itself is not used, and can be empty. The condition is true if the
10688 password is not empty, and the user name and password are accepted by the LDAP
10689 server. An empty password is rejected without calling LDAP because LDAP binds
10690 with an empty password are considered anonymous regardless of the username, and
10691 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10692 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10693 this can be used.
10694
10695
10696 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10697        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10698 .cindex "string" "comparison"
10699 .cindex "expansion" "string comparison"
10700 .cindex "&%le%& expansion condition"
10701 .cindex "&%lei%& expansion condition"
10702 The two substrings are first expanded. The condition is true if the first
10703 string is lexically less than or equal to the second string. For &%le%& the
10704 comparison includes the case of letters, whereas for &%lei%& the comparison is
10705 case-independent.
10706
10707 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10708        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10709 .cindex "string" "comparison"
10710 .cindex "expansion" "string comparison"
10711 .cindex "&%lt%& expansion condition"
10712 .cindex "&%lti%& expansion condition"
10713 The two substrings are first expanded. The condition is true if the first
10714 string is lexically less than the second string. For &%lt%& the comparison
10715 includes the case of letters, whereas for &%lti%& the comparison is
10716 case-independent.
10717
10718
10719 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10720 .cindex "expansion" "regular expression comparison"
10721 .cindex "regular expressions" "match in expanded string"
10722 .cindex "&%match%& expansion condition"
10723 The two substrings are first expanded. The second is then treated as a regular
10724 expression and applied to the first. Because of the pre-expansion, if the
10725 regular expression contains dollar, or backslash characters, they must be
10726 escaped. Care must also be taken if the regular expression contains braces
10727 (curly brackets). A closing brace must be escaped so that it is not taken as a
10728 premature termination of <&'string2'&>. The easiest approach is to use the
10729 &`\N`& feature to disable expansion of the regular expression.
10730 For example,
10731 .code
10732 ${if match {$local_part}{\N^\d{3}\N} ...
10733 .endd
10734 If the whole expansion string is in double quotes, further escaping of
10735 backslashes is also required.
10736
10737 The condition is true if the regular expression match succeeds.
10738 The regular expression is not required to begin with a circumflex
10739 metacharacter, but if there is no circumflex, the expression is not anchored,
10740 and it may match anywhere in the subject, not just at the start. If you want
10741 the pattern to match at the end of the subject, you must include the &`$`&
10742 metacharacter at an appropriate point.
10743
10744 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10745 At the start of an &%if%& expansion the values of the numeric variable
10746 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10747 succeeds causes them to be reset to the substrings of that condition and they
10748 will have these values during the expansion of the success string. At the end
10749 of the &%if%& expansion, the previous values are restored. After testing a
10750 combination of conditions using &%or%&, the subsequent values of the numeric
10751 variables are those of the condition that succeeded.
10752
10753 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10754 .cindex "&%match_address%& expansion condition"
10755 See &*match_local_part*&.
10756
10757 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10758 .cindex "&%match_domain%& expansion condition"
10759 See &*match_local_part*&.
10760
10761 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10762 .cindex "&%match_ip%& expansion condition"
10763 This condition matches an IP address to a list of IP address patterns. It must
10764 be followed by two argument strings. The first (after expansion) must be an IP
10765 address or an empty string. The second (not expanded) is a restricted host
10766 list that can match only an IP address, not a host name. For example:
10767 .code
10768 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10769 .endd
10770 The specific types of host list item that are permitted in the list are:
10771
10772 .ilist
10773 An IP address, optionally with a CIDR mask.
10774 .next
10775 A single asterisk, which matches any IP address.
10776 .next
10777 An empty item, which matches only if the IP address is empty. This could be
10778 useful for testing for a locally submitted message or one from specific hosts
10779 in a single test such as
10780 . ==== As this is a nested list, any displays it contains must be indented
10781 . ==== as otherwise they are too far to the left. This comment applies to
10782 . ==== the use of xmlto plus fop. There's no problem when formatting with
10783 . ==== sdop, with or without the extra indent.
10784 .code
10785   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10786 .endd
10787 where the first item in the list is the empty string.
10788 .next
10789 The item @[] matches any of the local host's interface addresses.
10790 .next
10791 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10792 even if &`net-`& is not specified. There is never any attempt to turn the IP
10793 address into a host name. The most common type of linear search for
10794 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10795 masks. For example:
10796 .code
10797   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10798 .endd
10799 It is of course possible to use other kinds of lookup, and in such a case, you
10800 do need to specify the &`net-`& prefix if you want to specify a specific
10801 address mask, for example:
10802 .code
10803   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10804 .endd
10805 However, unless you are combining a &%match_ip%& condition with others, it is
10806 just as easy to use the fact that a lookup is itself a condition, and write:
10807 .code
10808   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10809 .endd
10810 .endlist ilist
10811
10812 Note that <&'string2'&> is not itself subject to string expansion, unless
10813 Exim was built with the EXPAND_LISTMATCH_RHS option.
10814
10815 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10816
10817 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10818 .cindex "domain list" "in expansion condition"
10819 .cindex "address list" "in expansion condition"
10820 .cindex "local part" "list, in expansion condition"
10821 .cindex "&%match_local_part%& expansion condition"
10822 This condition, together with &%match_address%& and &%match_domain%&, make it
10823 possible to test domain, address, and local part lists within expansions. Each
10824 condition requires two arguments: an item and a list to match. A trivial
10825 example is:
10826 .code
10827 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10828 .endd
10829 In each case, the second argument may contain any of the allowable items for a
10830 list of the appropriate type. Also, because the second argument (after
10831 expansion) is a standard form of list, it is possible to refer to a named list.
10832 Thus, you can use conditions like this:
10833 .code
10834 ${if match_domain{$domain}{+local_domains}{...
10835 .endd
10836 .cindex "&`+caseful`&"
10837 For address lists, the matching starts off caselessly, but the &`+caseful`&
10838 item can be used, as in all address lists, to cause subsequent items to
10839 have their local parts matched casefully. Domains are always matched
10840 caselessly.
10841
10842 Note that <&'string2'&> is not itself subject to string expansion, unless
10843 Exim was built with the EXPAND_LISTMATCH_RHS option.
10844
10845 &*Note*&: Host lists are &'not'& supported in this way. This is because
10846 hosts have two identities: a name and an IP address, and it is not clear
10847 how to specify cleanly how such a test would work. However, IP addresses can be
10848 matched using &%match_ip%&.
10849
10850 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10851 .cindex "PAM authentication"
10852 .cindex "AUTH" "with PAM"
10853 .cindex "Solaris" "PAM support"
10854 .cindex "expansion" "PAM authentication test"
10855 .cindex "&%pam%& expansion condition"
10856 &'Pluggable Authentication Modules'&
10857 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10858 available in the latest releases of Solaris and in some GNU/Linux
10859 distributions. The Exim support, which is intended for use in conjunction with
10860 the SMTP AUTH command, is available only if Exim is compiled with
10861 .code
10862 SUPPORT_PAM=yes
10863 .endd
10864 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10865 in some releases of GNU/Linux &%-ldl%& is also needed.
10866
10867 The argument string is first expanded, and the result must be a
10868 colon-separated list of strings. Leading and trailing white space is ignored.
10869 The PAM module is initialized with the service name &"exim"& and the user name
10870 taken from the first item in the colon-separated data string (<&'string1'&>).
10871 The remaining items in the data string are passed over in response to requests
10872 from the authentication function. In the simple case there will only be one
10873 request, for a password, so the data consists of just two strings.
10874
10875 There can be problems if any of the strings are permitted to contain colon
10876 characters. In the usual way, these have to be doubled to avoid being taken as
10877 separators. If the data is being inserted from a variable, the &%sg%& expansion
10878 item can be used to double any existing colons. For example, the configuration
10879 of a LOGIN authenticator might contain this setting:
10880 .code
10881 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10882 .endd
10883 For a PLAIN authenticator you could use:
10884 .code
10885 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10886 .endd
10887 In some operating systems, PAM authentication can be done only from a process
10888 running as root. Since Exim is running as the Exim user when receiving
10889 messages, this means that PAM cannot be used directly in those systems.
10890 A patched version of the &'pam_unix'& module that comes with the
10891 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10892 The patched module allows one special uid/gid combination, in addition to root,
10893 to authenticate. If you build the patched module to allow the Exim user and
10894 group, PAM can then be used from an Exim authenticator.
10895
10896
10897 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10898 .cindex "&'pwcheck'& daemon"
10899 .cindex "Cyrus"
10900 .cindex "expansion" "&'pwcheck'& authentication test"
10901 .cindex "&%pwcheck%& expansion condition"
10902 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10903 This is one way of making it possible for passwords to be checked by a process
10904 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10905 deprecated. Its replacement is &'saslauthd'& (see below).
10906
10907 The pwcheck support is not included in Exim by default. You need to specify
10908 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10909 building Exim. For example:
10910 .code
10911 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10912 .endd
10913 You do not need to install the full Cyrus software suite in order to use
10914 the pwcheck daemon. You can compile and install just the daemon alone
10915 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10916 access to the &_/var/pwcheck_& directory.
10917
10918 The &%pwcheck%& condition takes one argument, which must be the user name and
10919 password, separated by a colon. For example, in a LOGIN authenticator
10920 configuration, you might have this:
10921 .code
10922 server_condition = ${if pwcheck{$auth1:$auth2}}
10923 .endd
10924 Again, for a PLAIN authenticator configuration, this would be:
10925 .code
10926 server_condition = ${if pwcheck{$auth2:$auth3}}
10927 .endd
10928 .vitem &*queue_running*&
10929 .cindex "queue runner" "detecting when delivering from"
10930 .cindex "expansion" "queue runner test"
10931 .cindex "&%queue_running%& expansion condition"
10932 This condition, which has no data, is true during delivery attempts that are
10933 initiated by queue runner processes, and false otherwise.
10934
10935
10936 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10937 .cindex "Radius"
10938 .cindex "expansion" "Radius authentication"
10939 .cindex "&%radius%& expansion condition"
10940 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10941 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10942 the Radius client configuration file in order to build Exim with Radius
10943 support.
10944
10945 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10946 library, using the original API. If you are using release 0.4.0 or later of
10947 this library, you need to set
10948 .code
10949 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10950 .endd
10951 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10952 &%libradius%& library that comes with FreeBSD. To do this, set
10953 .code
10954 RADIUS_LIB_TYPE=RADLIB
10955 .endd
10956 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10957 You may also have to supply a suitable setting in EXTRALIBS so that the
10958 Radius library can be found when Exim is linked.
10959
10960 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10961 Radius client library, which calls the Radius server. The condition is true if
10962 the authentication is successful. For example:
10963 .code
10964 server_condition = ${if radius{<arguments>}}
10965 .endd
10966
10967
10968 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10969         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10970 .cindex "&'saslauthd'& daemon"
10971 .cindex "Cyrus"
10972 .cindex "expansion" "&'saslauthd'& authentication test"
10973 .cindex "&%saslauthd%& expansion condition"
10974 This condition supports user authentication using the Cyrus &'saslauthd'&
10975 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10976 Using this daemon is one way of making it possible for passwords to be checked
10977 by a process that is not running as root.
10978
10979 The saslauthd support is not included in Exim by default. You need to specify
10980 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10981 building Exim. For example:
10982 .code
10983 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10984 .endd
10985 You do not need to install the full Cyrus software suite in order to use
10986 the saslauthd daemon. You can compile and install just the daemon alone
10987 from the Cyrus SASL library.
10988
10989 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10990 two are mandatory. For example:
10991 .code
10992 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10993 .endd
10994 The service and the realm are optional (which is why the arguments are enclosed
10995 in their own set of braces). For details of the meaning of the service and
10996 realm, and how to run the daemon, consult the Cyrus documentation.
10997 .endlist vlist
10998
10999
11000
11001 .section "Combining expansion conditions" "SECID84"
11002 .cindex "expansion" "combining conditions"
11003 Several conditions can be tested at once by combining them using the &%and%&
11004 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11005 conditions on their own, and precede their lists of sub-conditions. Each
11006 sub-condition must be enclosed in braces within the overall braces that contain
11007 the list. No repetition of &%if%& is used.
11008
11009
11010 .vlist
11011 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11012 .cindex "&""or""& expansion condition"
11013 .cindex "expansion" "&""or""& of conditions"
11014 The sub-conditions are evaluated from left to right. The condition is true if
11015 any one of the sub-conditions is true.
11016 For example,
11017 .code
11018 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11019 .endd
11020 When a true sub-condition is found, the following ones are parsed but not
11021 evaluated. If there are several &"match"& sub-conditions the values of the
11022 numeric variables afterwards are taken from the first one that succeeds.
11023
11024 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11025 .cindex "&""and""& expansion condition"
11026 .cindex "expansion" "&""and""& of conditions"
11027 The sub-conditions are evaluated from left to right. The condition is true if
11028 all of the sub-conditions are true. If there are several &"match"&
11029 sub-conditions, the values of the numeric variables afterwards are taken from
11030 the last one. When a false sub-condition is found, the following ones are
11031 parsed but not evaluated.
11032 .endlist
11033 .ecindex IIDexpcond
11034
11035
11036
11037
11038 .section "Expansion variables" "SECTexpvar"
11039 .cindex "expansion" "variables, list of"
11040 This section contains an alphabetical list of all the expansion variables. Some
11041 of them are available only when Exim is compiled with specific options such as
11042 support for TLS or the content scanning extension.
11043
11044 .vlist
11045 .vitem "&$0$&, &$1$&, etc"
11046 .cindex "numerical variables (&$1$& &$2$& etc)"
11047 When a &%match%& expansion condition succeeds, these variables contain the
11048 captured substrings identified by the regular expression during subsequent
11049 processing of the success string of the containing &%if%& expansion item.
11050 However, they do not retain their values afterwards; in fact, their previous
11051 values are restored at the end of processing an &%if%& item. The numerical
11052 variables may also be set externally by some other matching process which
11053 precedes the expansion of the string. For example, the commands available in
11054 Exim filter files include an &%if%& command with its own regular expression
11055 matching condition.
11056
11057 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11058 Within an acl condition, expansion condition or expansion item
11059 any arguments are copied to these variables,
11060 any unused variables being made empty.
11061
11062 .vitem "&$acl_c...$&"
11063 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11064 can be given any name that starts with &$acl_c$& and is at least six characters
11065 long, but the sixth character must be either a digit or an underscore. For
11066 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11067 variables persist throughout the lifetime of an SMTP connection. They can be
11068 used to pass information between ACLs and between different invocations of the
11069 same ACL. When a message is received, the values of these variables are saved
11070 with the message, and can be accessed by filters, routers, and transports
11071 during subsequent delivery.
11072
11073 .vitem "&$acl_m...$&"
11074 These variables are like the &$acl_c...$& variables, except that their values
11075 are reset after a message has been received. Thus, if several messages are
11076 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11077 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11078 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11079 message is received, the values of these variables are saved with the message,
11080 and can be accessed by filters, routers, and transports during subsequent
11081 delivery.
11082
11083 .vitem &$acl_narg$&
11084 Within an acl condition, expansion condition or expansion item
11085 this variable has the number of arguments.
11086
11087 .vitem &$acl_verify_message$&
11088 .vindex "&$acl_verify_message$&"
11089 After an address verification has failed, this variable contains the failure
11090 message. It retains its value for use in subsequent modifiers. The message can
11091 be preserved by coding like this:
11092 .code
11093 warn !verify = sender
11094      set acl_m0 = $acl_verify_message
11095 .endd
11096 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11097 &%log_message%& modifiers, to include information about the verification
11098 failure.
11099
11100 .vitem &$address_data$&
11101 .vindex "&$address_data$&"
11102 This variable is set by means of the &%address_data%& option in routers. The
11103 value then remains with the address while it is processed by subsequent routers
11104 and eventually a transport. If the transport is handling multiple addresses,
11105 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11106 for more details. &*Note*&: The contents of &$address_data$& are visible in
11107 user filter files.
11108
11109 If &$address_data$& is set when the routers are called from an ACL to verify
11110 a recipient address, the final value is still in the variable for subsequent
11111 conditions and modifiers of the ACL statement. If routing the address caused it
11112 to be redirected to just one address, the child address is also routed as part
11113 of the verification, and in this case the final value of &$address_data$& is
11114 from the child's routing.
11115
11116 If &$address_data$& is set when the routers are called from an ACL to verify a
11117 sender address, the final value is also preserved, but this time in
11118 &$sender_address_data$&, to distinguish it from data from a recipient
11119 address.
11120
11121 In both cases (recipient and sender verification), the value does not persist
11122 after the end of the current ACL statement. If you want to preserve
11123 these values for longer, you can save them in ACL variables.
11124
11125 .vitem &$address_file$&
11126 .vindex "&$address_file$&"
11127 When, as a result of aliasing, forwarding, or filtering, a message is directed
11128 to a specific file, this variable holds the name of the file when the transport
11129 is running. At other times, the variable is empty. For example, using the
11130 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11131 .code
11132 /home/r2d2/savemail
11133 .endd
11134 then when the &(address_file)& transport is running, &$address_file$&
11135 contains the text string &`/home/r2d2/savemail`&.
11136 .cindex "Sieve filter" "value of &$address_file$&"
11137 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11138 then up to the transport configuration to generate an appropriate absolute path
11139 to the relevant file.
11140
11141 .vitem &$address_pipe$&
11142 .vindex "&$address_pipe$&"
11143 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11144 this variable holds the pipe command when the transport is running.
11145
11146 .vitem "&$auth1$& &-- &$auth3$&"
11147 .vindex "&$auth1$&, &$auth2$&, etc"
11148 These variables are used in SMTP authenticators (see chapters
11149 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11150
11151 .vitem &$authenticated_id$&
11152 .cindex "authentication" "id"
11153 .vindex "&$authenticated_id$&"
11154 When a server successfully authenticates a client it may be configured to
11155 preserve some of the authentication information in the variable
11156 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11157 user/password authenticator configuration might preserve the user name for use
11158 in the routers. Note that this is not the same information that is saved in
11159 &$sender_host_authenticated$&.
11160 When a message is submitted locally (that is, not over a TCP connection)
11161 the value of &$authenticated_id$& is normally the login name of the calling
11162 process. However, a trusted user can override this by means of the &%-oMai%&
11163 command line option.
11164
11165 .vitem &$authenticated_fail_id$&
11166 .cindex "authentication" "fail" "id"
11167 .vindex "&$authenticated_fail_id$&"
11168 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11169 will contain the failed authentication id. If more than one authentication
11170 id is attempted, it will contain only the last one. The variable is
11171 available for processing in the ACL's, generally the quit or notquit ACL.
11172 A message to a local recipient could still be accepted without requiring
11173 authentication, which means this variable could also be visible in all of
11174 the ACL's as well.
11175
11176
11177 .vitem &$authenticated_sender$&
11178 .cindex "sender" "authenticated"
11179 .cindex "authentication" "sender"
11180 .cindex "AUTH" "on MAIL command"
11181 .vindex "&$authenticated_sender$&"
11182 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11183 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11184 described in section &<<SECTauthparamail>>&. Unless the data is the string
11185 &"<>"&, it is set as the authenticated sender of the message, and the value is
11186 available during delivery in the &$authenticated_sender$& variable. If the
11187 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11188
11189 .vindex "&$qualify_domain$&"
11190 When a message is submitted locally (that is, not over a TCP connection), the
11191 value of &$authenticated_sender$& is an address constructed from the login
11192 name of the calling process and &$qualify_domain$&, except that a trusted user
11193 can override this by means of the &%-oMas%& command line option.
11194
11195
11196 .vitem &$authentication_failed$&
11197 .cindex "authentication" "failure"
11198 .vindex "&$authentication_failed$&"
11199 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11200 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11201 possible to distinguish between &"did not try to authenticate"&
11202 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11203 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11204 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11205 negative response to an AUTH command, including (for example) an attempt to use
11206 an undefined mechanism.
11207
11208 .vitem &$av_failed$&
11209 .cindex "content scanning" "AV scanner failure"
11210 This variable is available when Exim is compiled with the content-scanning
11211 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11212 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11213 the ACL malware condition.
11214
11215 .vitem &$body_linecount$&
11216 .cindex "message body" "line count"
11217 .cindex "body of message" "line count"
11218 .vindex "&$body_linecount$&"
11219 When a message is being received or delivered, this variable contains the
11220 number of lines in the message's body. See also &$message_linecount$&.
11221
11222 .vitem &$body_zerocount$&
11223 .cindex "message body" "binary zero count"
11224 .cindex "body of message" "binary zero count"
11225 .cindex "binary zero" "in message body"
11226 .vindex "&$body_zerocount$&"
11227 When a message is being received or delivered, this variable contains the
11228 number of binary zero bytes (ASCII NULs) in the message's body.
11229
11230 .vitem &$bounce_recipient$&
11231 .vindex "&$bounce_recipient$&"
11232 This is set to the recipient address of a bounce message while Exim is creating
11233 it. It is useful if a customized bounce message text file is in use (see
11234 chapter &<<CHAPemsgcust>>&).
11235
11236 .vitem &$bounce_return_size_limit$&
11237 .vindex "&$bounce_return_size_limit$&"
11238 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11239 up to a multiple of 1000. It is useful when a customized error message text
11240 file is in use (see chapter &<<CHAPemsgcust>>&).
11241
11242 .vitem &$caller_gid$&
11243 .cindex "gid (group id)" "caller"
11244 .vindex "&$caller_gid$&"
11245 The real group id under which the process that called Exim was running. This is
11246 not the same as the group id of the originator of a message (see
11247 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11248 incarnation normally contains the Exim gid.
11249
11250 .vitem &$caller_uid$&
11251 .cindex "uid (user id)" "caller"
11252 .vindex "&$caller_uid$&"
11253 The real user id under which the process that called Exim was running. This is
11254 not the same as the user id of the originator of a message (see
11255 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11256 incarnation normally contains the Exim uid.
11257
11258 .vitem &$compile_date$&
11259 .vindex "&$compile_date$&"
11260 The date on which the Exim binary was compiled.
11261
11262 .vitem &$compile_number$&
11263 .vindex "&$compile_number$&"
11264 The building process for Exim keeps a count of the number
11265 of times it has been compiled. This serves to distinguish different
11266 compilations of the same version of the program.
11267
11268 .vitem &$config_dir$&
11269 .vindex "&$config_dir$&"
11270 The directory name of the main configuration file. That is, the content of
11271 &$config_file$& with the last component stripped. The value does not
11272 contain the trailing slash. If &$config_file$& does not contain a slash,
11273 &$config_dir$& is ".".
11274
11275 .vitem &$config_file$&
11276 .vindex "&$config_file$&"
11277 The name of the main configuration file Exim is using.
11278
11279 .vitem &$demime_errorlevel$&
11280 .vindex "&$demime_errorlevel$&"
11281 This variable is available when Exim is compiled with
11282 the content-scanning extension and the obsolete &%demime%& condition. For
11283 details, see section &<<SECTdemimecond>>&.
11284
11285 .vitem &$demime_reason$&
11286 .vindex "&$demime_reason$&"
11287 This variable is available when Exim is compiled with the
11288 content-scanning extension and the obsolete &%demime%& condition. For details,
11289 see section &<<SECTdemimecond>>&.
11290
11291 .vitem &$dnslist_domain$& &&&
11292        &$dnslist_matched$& &&&
11293        &$dnslist_text$& &&&
11294        &$dnslist_value$&
11295 .vindex "&$dnslist_domain$&"
11296 .vindex "&$dnslist_matched$&"
11297 .vindex "&$dnslist_text$&"
11298 .vindex "&$dnslist_value$&"
11299 .cindex "black list (DNS)"
11300 When a DNS (black) list lookup succeeds, these variables are set to contain
11301 the following data from the lookup: the list's domain name, the key that was
11302 looked up, the contents of any associated TXT record, and the value from the
11303 main A record. See section &<<SECID204>>& for more details.
11304
11305 .vitem &$domain$&
11306 .vindex "&$domain$&"
11307 When an address is being routed, or delivered on its own, this variable
11308 contains the domain. Uppercase letters in the domain are converted into lower
11309 case for &$domain$&.
11310
11311 Global address rewriting happens when a message is received, so the value of
11312 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11313 is set during user filtering, but not during system filtering, because a
11314 message may have many recipients and the system filter is called just once.
11315
11316 When more than one address is being delivered at once (for example, several
11317 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11318 have the same domain. Transports can be restricted to handling only one domain
11319 at a time if the value of &$domain$& is required at transport time &-- this is
11320 the default for local transports. For further details of the environment in
11321 which local transports are run, see chapter &<<CHAPenvironment>>&.
11322
11323 .oindex "&%delay_warning_condition%&"
11324 At the end of a delivery, if all deferred addresses have the same domain, it is
11325 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11326
11327 The &$domain$& variable is also used in some other circumstances:
11328
11329 .ilist
11330 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11331 the recipient address. The domain of the &'sender'& address is in
11332 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11333 normally set during the running of the MAIL ACL. However, if the sender address
11334 is verified with a callout during the MAIL ACL, the sender domain is placed in
11335 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11336 the &(smtp)& transport.
11337
11338 .next
11339 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11340 &$domain$& contains the domain portion of the address that is being rewritten;
11341 it can be used in the expansion of the replacement address, for example, to
11342 rewrite domains by file lookup.
11343
11344 .next
11345 With one important exception, whenever a domain list is being scanned,
11346 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11347 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11348 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11349 that, in a RCPT ACL, the sender domain list can be dependent on the
11350 recipient domain (which is what is in &$domain$& at this time).
11351
11352 .next
11353 .cindex "ETRN" "value of &$domain$&"
11354 .oindex "&%smtp_etrn_command%&"
11355 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11356 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11357 .endlist
11358
11359
11360 .vitem &$domain_data$&
11361 .vindex "&$domain_data$&"
11362 When the &%domains%& option on a router matches a domain by
11363 means of a lookup, the data read by the lookup is available during the running
11364 of the router as &$domain_data$&. In addition, if the driver routes the
11365 address to a transport, the value is available in that transport. If the
11366 transport is handling multiple addresses, the value from the first address is
11367 used.
11368
11369 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11370 domain by means of a lookup. The data read by the lookup is available during
11371 the rest of the ACL statement. In all other situations, this variable expands
11372 to nothing.
11373
11374 .vitem &$exim_gid$&
11375 .vindex "&$exim_gid$&"
11376 This variable contains the numerical value of the Exim group id.
11377
11378 .vitem &$exim_path$&
11379 .vindex "&$exim_path$&"
11380 This variable contains the path to the Exim binary.
11381
11382 .vitem &$exim_uid$&
11383 .vindex "&$exim_uid$&"
11384 This variable contains the numerical value of the Exim user id.
11385
11386 .vitem &$exim_version$&
11387 .vindex "&$exim_uid$&"
11388 This variable contains the version string of the Exim build.
11389 The first character is a major version number, currently 4.
11390 Then after a dot, the next group of digits is a minor version number.
11391 There may be other characters following the minor version.
11392
11393 .vitem &$found_extension$&
11394 .vindex "&$found_extension$&"
11395 This variable is available when Exim is compiled with the
11396 content-scanning extension and the obsolete &%demime%& condition. For details,
11397 see section &<<SECTdemimecond>>&.
11398
11399 .vitem &$header_$&<&'name'&>
11400 This is not strictly an expansion variable. It is expansion syntax for
11401 inserting the message header line with the given name. Note that the name must
11402 be terminated by colon or white space, because it may contain a wide variety of
11403 characters. Note also that braces must &'not'& be used.
11404
11405 .vitem &$headers_added$&
11406 .vindex "&$headers_added$&"
11407 Within an ACL this variable contains the headers added so far by
11408 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11409 The headers are a newline-separated list.
11410
11411 .vitem &$home$&
11412 .vindex "&$home$&"
11413 When the &%check_local_user%& option is set for a router, the user's home
11414 directory is placed in &$home$& when the check succeeds. In particular, this
11415 means it is set during the running of users' filter files. A router may also
11416 explicitly set a home directory for use by a transport; this can be overridden
11417 by a setting on the transport itself.
11418
11419 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11420 of the environment variable HOME.
11421
11422 .vitem &$host$&
11423 .vindex "&$host$&"
11424 If a router assigns an address to a transport (any transport), and passes a
11425 list of hosts with the address, the value of &$host$& when the transport starts
11426 to run is the name of the first host on the list. Note that this applies both
11427 to local and remote transports.
11428
11429 .cindex "transport" "filter"
11430 .cindex "filter" "transport filter"
11431 For the &(smtp)& transport, if there is more than one host, the value of
11432 &$host$& changes as the transport works its way through the list. In
11433 particular, when the &(smtp)& transport is expanding its options for encryption
11434 using TLS, or for specifying a transport filter (see chapter
11435 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11436 is connected.
11437
11438 When used in the client part of an authenticator configuration (see chapter
11439 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11440 client is connected.
11441
11442
11443 .vitem &$host_address$&
11444 .vindex "&$host_address$&"
11445 This variable is set to the remote host's IP address whenever &$host$& is set
11446 for a remote connection. It is also set to the IP address that is being checked
11447 when the &%ignore_target_hosts%& option is being processed.
11448
11449 .vitem &$host_data$&
11450 .vindex "&$host_data$&"
11451 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11452 result of the lookup is made available in the &$host_data$& variable. This
11453 allows you, for example, to do things like this:
11454 .code
11455 deny  hosts = net-lsearch;/some/file
11456 message = $host_data
11457 .endd
11458 .vitem &$host_lookup_deferred$&
11459 .cindex "host name" "lookup, failure of"
11460 .vindex "&$host_lookup_deferred$&"
11461 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11462 message comes from a remote host and there is an attempt to look up the host's
11463 name from its IP address, and the attempt is not successful, one of these
11464 variables is set to &"1"&.
11465
11466 .ilist
11467 If the lookup receives a definite negative response (for example, a DNS lookup
11468 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11469
11470 .next
11471 If there is any kind of problem during the lookup, such that Exim cannot
11472 tell whether or not the host name is defined (for example, a timeout for a DNS
11473 lookup), &$host_lookup_deferred$& is set to &"1"&.
11474 .endlist ilist
11475
11476 Looking up a host's name from its IP address consists of more than just a
11477 single reverse lookup. Exim checks that a forward lookup of at least one of the
11478 names it receives from a reverse lookup yields the original IP address. If this
11479 is not the case, Exim does not accept the looked up name(s), and
11480 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11481 IP address (for example, the existence of a PTR record in the DNS) is not
11482 sufficient on its own for the success of a host name lookup. If the reverse
11483 lookup succeeds, but there is a lookup problem such as a timeout when checking
11484 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11485 &"1"&. See also &$sender_host_name$&.
11486
11487 .vitem &$host_lookup_failed$&
11488 .vindex "&$host_lookup_failed$&"
11489 See &$host_lookup_deferred$&.
11490
11491 .vitem &$host_port$&
11492 .vindex "&$host_port$&"
11493 This variable is set to the remote host's TCP port whenever &$host$& is set
11494 for an outbound connection.
11495
11496
11497 .vitem &$inode$&
11498 .vindex "&$inode$&"
11499 The only time this variable is set is while expanding the &%directory_file%&
11500 option in the &(appendfile)& transport. The variable contains the inode number
11501 of the temporary file which is about to be renamed. It can be used to construct
11502 a unique name for the file.
11503
11504 .vitem &$interface_address$&
11505 .vindex "&$interface_address$&"
11506 This is an obsolete name for &$received_ip_address$&.
11507
11508 .vitem &$interface_port$&
11509 .vindex "&$interface_port$&"
11510 This is an obsolete name for &$received_port$&.
11511
11512 .vitem &$item$&
11513 .vindex "&$item$&"
11514 This variable is used during the expansion of &*forall*& and &*forany*&
11515 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11516 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11517 empty.
11518
11519 .vitem &$ldap_dn$&
11520 .vindex "&$ldap_dn$&"
11521 This variable, which is available only when Exim is compiled with LDAP support,
11522 contains the DN from the last entry in the most recently successful LDAP
11523 lookup.
11524
11525 .vitem &$load_average$&
11526 .vindex "&$load_average$&"
11527 This variable contains the system load average, multiplied by 1000 so that it
11528 is an integer. For example, if the load average is 0.21, the value of the
11529 variable is 210. The value is recomputed every time the variable is referenced.
11530
11531 .vitem &$local_part$&
11532 .vindex "&$local_part$&"
11533 When an address is being routed, or delivered on its own, this
11534 variable contains the local part. When a number of addresses are being
11535 delivered together (for example, multiple RCPT commands in an SMTP
11536 session), &$local_part$& is not set.
11537
11538 Global address rewriting happens when a message is received, so the value of
11539 &$local_part$& during routing and delivery is the value after rewriting.
11540 &$local_part$& is set during user filtering, but not during system filtering,
11541 because a message may have many recipients and the system filter is called just
11542 once.
11543
11544 .vindex "&$local_part_prefix$&"
11545 .vindex "&$local_part_suffix$&"
11546 If a local part prefix or suffix has been recognized, it is not included in the
11547 value of &$local_part$& during routing and subsequent delivery. The values of
11548 any prefix or suffix are in &$local_part_prefix$& and
11549 &$local_part_suffix$&, respectively.
11550
11551 When a message is being delivered to a file, pipe, or autoreply transport as a
11552 result of aliasing or forwarding, &$local_part$& is set to the local part of
11553 the parent address, not to the file name or command (see &$address_file$& and
11554 &$address_pipe$&).
11555
11556 When an ACL is running for a RCPT command, &$local_part$& contains the
11557 local part of the recipient address.
11558
11559 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11560 &$local_part$& contains the local part of the address that is being rewritten;
11561 it can be used in the expansion of the replacement address, for example.
11562
11563 In all cases, all quoting is removed from the local part. For example, for both
11564 the addresses
11565 .code
11566 "abc:xyz"@test.example
11567 abc\:xyz@test.example
11568 .endd
11569 the value of &$local_part$& is
11570 .code
11571 abc:xyz
11572 .endd
11573 If you use &$local_part$& to create another address, you should always wrap it
11574 inside a quoting operator. For example, in a &(redirect)& router you could
11575 have:
11576 .code
11577 data = ${quote_local_part:$local_part}@new.domain.example
11578 .endd
11579 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11580 to process local parts in a case-dependent manner in a router, you can set the
11581 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11582
11583 .vitem &$local_part_data$&
11584 .vindex "&$local_part_data$&"
11585 When the &%local_parts%& option on a router matches a local part by means of a
11586 lookup, the data read by the lookup is available during the running of the
11587 router as &$local_part_data$&. In addition, if the driver routes the address
11588 to a transport, the value is available in that transport. If the transport is
11589 handling multiple addresses, the value from the first address is used.
11590
11591 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11592 matches a local part by means of a lookup. The data read by the lookup is
11593 available during the rest of the ACL statement. In all other situations, this
11594 variable expands to nothing.
11595
11596 .vitem &$local_part_prefix$&
11597 .vindex "&$local_part_prefix$&"
11598 When an address is being routed or delivered, and a
11599 specific prefix for the local part was recognized, it is available in this
11600 variable, having been removed from &$local_part$&.
11601
11602 .vitem &$local_part_suffix$&
11603 .vindex "&$local_part_suffix$&"
11604 When an address is being routed or delivered, and a
11605 specific suffix for the local part was recognized, it is available in this
11606 variable, having been removed from &$local_part$&.
11607
11608 .vitem &$local_scan_data$&
11609 .vindex "&$local_scan_data$&"
11610 This variable contains the text returned by the &[local_scan()]& function when
11611 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11612
11613 .vitem &$local_user_gid$&
11614 .vindex "&$local_user_gid$&"
11615 See &$local_user_uid$&.
11616
11617 .vitem &$local_user_uid$&
11618 .vindex "&$local_user_uid$&"
11619 This variable and &$local_user_gid$& are set to the uid and gid after the
11620 &%check_local_user%& router precondition succeeds. This means that their values
11621 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11622 and &%condition%&), for the &%address_data%& expansion, and for any
11623 router-specific expansions. At all other times, the values in these variables
11624 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11625
11626 .vitem &$localhost_number$&
11627 .vindex "&$localhost_number$&"
11628 This contains the expanded value of the
11629 &%localhost_number%& option. The expansion happens after the main options have
11630 been read.
11631
11632 .vitem &$log_inodes$&
11633 .vindex "&$log_inodes$&"
11634 The number of free inodes in the disk partition where Exim's
11635 log files are being written. The value is recalculated whenever the variable is
11636 referenced. If the relevant file system does not have the concept of inodes,
11637 the value of is -1. See also the &%check_log_inodes%& option.
11638
11639 .vitem &$log_space$&
11640 .vindex "&$log_space$&"
11641 The amount of free space (as a number of kilobytes) in the disk
11642 partition where Exim's log files are being written. The value is recalculated
11643 whenever the variable is referenced. If the operating system does not have the
11644 ability to find the amount of free space (only true for experimental systems),
11645 the space value is -1. See also the &%check_log_space%& option.
11646
11647
11648 .vitem &$lookup_dnssec_authenticated$&
11649 .vindex "&$lookup_dnssec_authenticated$&"
11650 This variable is set after a DNS lookup done by
11651 a dnsdb lookup expansion, dnslookup router or smtp transport.
11652 It will be empty if &(DNSSEC)& was not requested,
11653 &"no"& if the result was not labelled as authenticated data
11654 and &"yes"& if it was.
11655
11656 .vitem &$mailstore_basename$&
11657 .vindex "&$mailstore_basename$&"
11658 This variable is set only when doing deliveries in &"mailstore"& format in the
11659 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11660 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11661 contains the basename of the files that are being written, that is, the name
11662 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11663 variable is empty.
11664
11665 .vitem &$malware_name$&
11666 .vindex "&$malware_name$&"
11667 This variable is available when Exim is compiled with the
11668 content-scanning extension. It is set to the name of the virus that was found
11669 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11670
11671 .vitem &$max_received_linelength$&
11672 .vindex "&$max_received_linelength$&"
11673 .cindex "maximum" "line length"
11674 .cindex "line length" "maximum"
11675 This variable contains the number of bytes in the longest line that was
11676 received as part of the message, not counting the line termination
11677 character(s).
11678
11679 .vitem &$message_age$&
11680 .cindex "message" "age of"
11681 .vindex "&$message_age$&"
11682 This variable is set at the start of a delivery attempt to contain the number
11683 of seconds since the message was received. It does not change during a single
11684 delivery attempt.
11685
11686 .vitem &$message_body$&
11687 .cindex "body of message" "expansion variable"
11688 .cindex "message body" "in expansion"
11689 .cindex "binary zero" "in message body"
11690 .vindex "&$message_body$&"
11691 .oindex "&%message_body_visible%&"
11692 This variable contains the initial portion of a message's body while it is
11693 being delivered, and is intended mainly for use in filter files. The maximum
11694 number of characters of the body that are put into the variable is set by the
11695 &%message_body_visible%& configuration option; the default is 500.
11696
11697 .oindex "&%message_body_newlines%&"
11698 By default, newlines are converted into spaces in &$message_body$&, to make it
11699 easier to search for phrases that might be split over a line break. However,
11700 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11701 zeros are always converted into spaces.
11702
11703 .vitem &$message_body_end$&
11704 .cindex "body of message" "expansion variable"
11705 .cindex "message body" "in expansion"
11706 .vindex "&$message_body_end$&"
11707 This variable contains the final portion of a message's
11708 body while it is being delivered. The format and maximum size are as for
11709 &$message_body$&.
11710
11711 .vitem &$message_body_size$&
11712 .cindex "body of message" "size"
11713 .cindex "message body" "size"
11714 .vindex "&$message_body_size$&"
11715 When a message is being delivered, this variable contains the size of the body
11716 in bytes. The count starts from the character after the blank line that
11717 separates the body from the header. Newlines are included in the count. See
11718 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11719
11720 .vitem &$message_exim_id$&
11721 .vindex "&$message_exim_id$&"
11722 When a message is being received or delivered, this variable contains the
11723 unique message id that is generated and used by Exim to identify the message.
11724 An id is not created for a message until after its header has been successfully
11725 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11726 line; it is the local id that Exim assigns to the message, for example:
11727 &`1BXTIK-0001yO-VA`&.
11728
11729 .vitem &$message_headers$&
11730 .vindex &$message_headers$&
11731 This variable contains a concatenation of all the header lines when a message
11732 is being processed, except for lines added by routers or transports. The header
11733 lines are separated by newline characters. Their contents are decoded in the
11734 same way as a header line that is inserted by &%bheader%&.
11735
11736 .vitem &$message_headers_raw$&
11737 .vindex &$message_headers_raw$&
11738 This variable is like &$message_headers$& except that no processing of the
11739 contents of header lines is done.
11740
11741 .vitem &$message_id$&
11742 This is an old name for &$message_exim_id$&. It is now deprecated.
11743
11744 .vitem &$message_linecount$&
11745 .vindex "&$message_linecount$&"
11746 This variable contains the total number of lines in the header and body of the
11747 message. Compare &$body_linecount$&, which is the count for the body only.
11748 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11749 number of lines received. Before delivery happens (that is, before filters,
11750 routers, and transports run) the count is increased to include the
11751 &'Received:'& header line that Exim standardly adds, and also any other header
11752 lines that are added by ACLs. The blank line that separates the message header
11753 from the body is not counted.
11754
11755 As with the special case of &$message_size$&, during the expansion of the
11756 appendfile transport's maildir_tag option in maildir format, the value of
11757 &$message_linecount$& is the precise size of the number of newlines in the
11758 file that has been written (minus one for the blank line between the
11759 header and the body).
11760
11761 Here is an example of the use of this variable in a DATA ACL:
11762 .code
11763 deny message   = Too many lines in message header
11764      condition = \
11765       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11766 .endd
11767 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11768 message has not yet been received.
11769
11770 .vitem &$message_size$&
11771 .cindex "size" "of message"
11772 .cindex "message" "size"
11773 .vindex "&$message_size$&"
11774 When a message is being processed, this variable contains its size in bytes. In
11775 most cases, the size includes those headers that were received with the
11776 message, but not those (such as &'Envelope-to:'&) that are added to individual
11777 deliveries as they are written. However, there is one special case: during the
11778 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11779 doing a delivery in maildir format, the value of &$message_size$& is the
11780 precise size of the file that has been written. See also
11781 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11782
11783 .cindex "RCPT" "value of &$message_size$&"
11784 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11785 contains the size supplied on the MAIL command, or -1 if no size was given. The
11786 value may not, of course, be truthful.
11787
11788 .vitem &$mime_$&&'xxx'&
11789 A number of variables whose names start with &$mime$& are
11790 available when Exim is compiled with the content-scanning extension. For
11791 details, see section &<<SECTscanmimepart>>&.
11792
11793 .vitem "&$n0$& &-- &$n9$&"
11794 These variables are counters that can be incremented by means
11795 of the &%add%& command in filter files.
11796
11797 .vitem &$original_domain$&
11798 .vindex "&$domain$&"
11799 .vindex "&$original_domain$&"
11800 When a top-level address is being processed for delivery, this contains the
11801 same value as &$domain$&. However, if a &"child"& address (for example,
11802 generated by an alias, forward, or filter file) is being processed, this
11803 variable contains the domain of the original address (lower cased). This
11804 differs from &$parent_domain$& only when there is more than one level of
11805 aliasing or forwarding. When more than one address is being delivered in a
11806 single transport run, &$original_domain$& is not set.
11807
11808 If a new address is created by means of a &%deliver%& command in a system
11809 filter, it is set up with an artificial &"parent"& address. This has the local
11810 part &'system-filter'& and the default qualify domain.
11811
11812 .vitem &$original_local_part$&
11813 .vindex "&$local_part$&"
11814 .vindex "&$original_local_part$&"
11815 When a top-level address is being processed for delivery, this contains the
11816 same value as &$local_part$&, unless a prefix or suffix was removed from the
11817 local part, because &$original_local_part$& always contains the full local
11818 part. When a &"child"& address (for example, generated by an alias, forward, or
11819 filter file) is being processed, this variable contains the full local part of
11820 the original address.
11821
11822 If the router that did the redirection processed the local part
11823 case-insensitively, the value in &$original_local_part$& is in lower case.
11824 This variable differs from &$parent_local_part$& only when there is more than
11825 one level of aliasing or forwarding. When more than one address is being
11826 delivered in a single transport run, &$original_local_part$& is not set.
11827
11828 If a new address is created by means of a &%deliver%& command in a system
11829 filter, it is set up with an artificial &"parent"& address. This has the local
11830 part &'system-filter'& and the default qualify domain.
11831
11832 .vitem &$originator_gid$&
11833 .cindex "gid (group id)" "of originating user"
11834 .cindex "sender" "gid"
11835 .vindex "&$caller_gid$&"
11836 .vindex "&$originator_gid$&"
11837 This variable contains the value of &$caller_gid$& that was set when the
11838 message was received. For messages received via the command line, this is the
11839 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11840 normally the gid of the Exim user.
11841
11842 .vitem &$originator_uid$&
11843 .cindex "uid (user id)" "of originating user"
11844 .cindex "sender" "uid"
11845 .vindex "&$caller_uid$&"
11846 .vindex "&$originaltor_uid$&"
11847 The value of &$caller_uid$& that was set when the message was received. For
11848 messages received via the command line, this is the uid of the sending user.
11849 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11850 user.
11851
11852 .vitem &$parent_domain$&
11853 .vindex "&$parent_domain$&"
11854 This variable is similar to &$original_domain$& (see
11855 above), except that it refers to the immediately preceding parent address.
11856
11857 .vitem &$parent_local_part$&
11858 .vindex "&$parent_local_part$&"
11859 This variable is similar to &$original_local_part$&
11860 (see above), except that it refers to the immediately preceding parent address.
11861
11862 .vitem &$pid$&
11863 .cindex "pid (process id)" "of current process"
11864 .vindex "&$pid$&"
11865 This variable contains the current process id.
11866
11867 .vitem &$pipe_addresses$&
11868 .cindex "filter" "transport filter"
11869 .cindex "transport" "filter"
11870 .vindex "&$pipe_addresses$&"
11871 This is not an expansion variable, but is mentioned here because the string
11872 &`$pipe_addresses`& is handled specially in the command specification for the
11873 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11874 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11875 It cannot be used in general expansion strings, and provokes an &"unknown
11876 variable"& error if encountered.
11877
11878 .vitem &$primary_hostname$&
11879 .vindex "&$primary_hostname$&"
11880 This variable contains the value set by &%primary_hostname%& in the
11881 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11882 a single-component name, Exim calls &[gethostbyname()]& (or
11883 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11884 qualified host name. See also &$smtp_active_hostname$&.
11885
11886
11887 .vitem &$prvscheck_address$&
11888 This variable is used in conjunction with the &%prvscheck%& expansion item,
11889 which is described in sections &<<SECTexpansionitems>>& and
11890 &<<SECTverifyPRVS>>&.
11891
11892 .vitem &$prvscheck_keynum$&
11893 This variable is used in conjunction with the &%prvscheck%& expansion item,
11894 which is described in sections &<<SECTexpansionitems>>& and
11895 &<<SECTverifyPRVS>>&.
11896
11897 .vitem &$prvscheck_result$&
11898 This variable is used in conjunction with the &%prvscheck%& expansion item,
11899 which is described in sections &<<SECTexpansionitems>>& and
11900 &<<SECTverifyPRVS>>&.
11901
11902 .vitem &$qualify_domain$&
11903 .vindex "&$qualify_domain$&"
11904 The value set for the &%qualify_domain%& option in the configuration file.
11905
11906 .vitem &$qualify_recipient$&
11907 .vindex "&$qualify_recipient$&"
11908 The value set for the &%qualify_recipient%& option in the configuration file,
11909 or if not set, the value of &$qualify_domain$&.
11910
11911 .vitem &$rcpt_count$&
11912 .vindex "&$rcpt_count$&"
11913 When a message is being received by SMTP, this variable contains the number of
11914 RCPT commands received for the current message. If this variable is used in a
11915 RCPT ACL, its value includes the current command.
11916
11917 .vitem &$rcpt_defer_count$&
11918 .vindex "&$rcpt_defer_count$&"
11919 .cindex "4&'xx'& responses" "count of"
11920 When a message is being received by SMTP, this variable contains the number of
11921 RCPT commands in the current message that have previously been rejected with a
11922 temporary (4&'xx'&) response.
11923
11924 .vitem &$rcpt_fail_count$&
11925 .vindex "&$rcpt_fail_count$&"
11926 When a message is being received by SMTP, this variable contains the number of
11927 RCPT commands in the current message that have previously been rejected with a
11928 permanent (5&'xx'&) response.
11929
11930 .vitem &$received_count$&
11931 .vindex "&$received_count$&"
11932 This variable contains the number of &'Received:'& header lines in the message,
11933 including the one added by Exim (so its value is always greater than zero). It
11934 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11935 delivering.
11936
11937 .vitem &$received_for$&
11938 .vindex "&$received_for$&"
11939 If there is only a single recipient address in an incoming message, this
11940 variable contains that address when the &'Received:'& header line is being
11941 built. The value is copied after recipient rewriting has happened, but before
11942 the &[local_scan()]& function is run.
11943
11944 .vitem &$received_ip_address$&
11945 .vindex "&$received_ip_address$&"
11946 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11947 variable is set to the address of the local IP interface, and &$received_port$&
11948 is set to the local port number. (The remote IP address and port are in
11949 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11950 the port value is -1 unless it has been set using the &%-oMi%& command line
11951 option.
11952
11953 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11954 could be used, for example, to make the file name for a TLS certificate depend
11955 on which interface and/or port is being used for the incoming connection. The
11956 values of &$received_ip_address$& and &$received_port$& are saved with any
11957 messages that are received, thus making these variables available at delivery
11958 time.
11959
11960 &*Note:*& There are no equivalent variables for outgoing connections, because
11961 the values are unknown (unless they are explicitly set by options of the
11962 &(smtp)& transport).
11963
11964 .vitem &$received_port$&
11965 .vindex "&$received_port$&"
11966 See &$received_ip_address$&.
11967
11968 .vitem &$received_protocol$&
11969 .vindex "&$received_protocol$&"
11970 When a message is being processed, this variable contains the name of the
11971 protocol by which it was received. Most of the names used by Exim are defined
11972 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11973 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11974 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11975 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11976 connection and the client was successfully authenticated.
11977
11978 Exim uses the protocol name &"smtps"& for the case when encryption is
11979 automatically set up on connection without the use of STARTTLS (see
11980 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11981 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11982 where the client initially uses EHLO, sets up an encrypted connection using
11983 STARTTLS, and then uses HELO afterwards.
11984
11985 The &%-oMr%& option provides a way of specifying a custom protocol name for
11986 messages that are injected locally by trusted callers. This is commonly used to
11987 identify messages that are being re-injected after some kind of scanning.
11988
11989 .vitem &$received_time$&
11990 .vindex "&$received_time$&"
11991 This variable contains the date and time when the current message was received,
11992 as a number of seconds since the start of the Unix epoch.
11993
11994 .vitem &$recipient_data$&
11995 .vindex "&$recipient_data$&"
11996 This variable is set after an indexing lookup success in an ACL &%recipients%&
11997 condition. It contains the data from the lookup, and the value remains set
11998 until the next &%recipients%& test. Thus, you can do things like this:
11999 .display
12000 &`require recipients  = cdb*@;/some/file`&
12001 &`deny    `&&'some further test involving'& &`$recipient_data`&
12002 .endd
12003 &*Warning*&: This variable is set only when a lookup is used as an indexing
12004 method in the address list, using the semicolon syntax as in the example above.
12005 The variable is not set for a lookup that is used as part of the string
12006 expansion that all such lists undergo before being interpreted.
12007
12008 .vitem &$recipient_verify_failure$&
12009 .vindex "&$recipient_verify_failure$&"
12010 In an ACL, when a recipient verification fails, this variable contains
12011 information about the failure. It is set to one of the following words:
12012
12013 .ilist
12014 &"qualify"&: The address was unqualified (no domain), and the message
12015 was neither local nor came from an exempted host.
12016
12017 .next
12018 &"route"&: Routing failed.
12019
12020 .next
12021 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12022 or before the MAIL command (that is, on initial connection, HELO, or
12023 MAIL).
12024
12025 .next
12026 &"recipient"&: The RCPT command in a callout was rejected.
12027 .next
12028
12029 &"postmaster"&: The postmaster check in a callout was rejected.
12030 .endlist
12031
12032 The main use of this variable is expected to be to distinguish between
12033 rejections of MAIL and rejections of RCPT.
12034
12035 .vitem &$recipients$&
12036 .vindex "&$recipients$&"
12037 This variable contains a list of envelope recipients for a message. A comma and
12038 a space separate the addresses in the replacement text. However, the variable
12039 is not generally available, to prevent exposure of Bcc recipients in
12040 unprivileged users' filter files. You can use &$recipients$& only in these
12041 cases:
12042
12043 .olist
12044 In a system filter file.
12045 .next
12046 In the ACLs associated with the DATA command and with non-SMTP messages, that
12047 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12048 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12049 &%acl_not_smtp_mime%&.
12050 .next
12051 From within a &[local_scan()]& function.
12052 .endlist
12053
12054
12055 .vitem &$recipients_count$&
12056 .vindex "&$recipients_count$&"
12057 When a message is being processed, this variable contains the number of
12058 envelope recipients that came with the message. Duplicates are not excluded
12059 from the count. While a message is being received over SMTP, the number
12060 increases for each accepted recipient. It can be referenced in an ACL.
12061
12062
12063 .vitem &$regex_match_string$&
12064 .vindex "&$regex_match_string$&"
12065 This variable is set to contain the matching regular expression after a
12066 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12067
12068
12069 .vitem &$reply_address$&
12070 .vindex "&$reply_address$&"
12071 When a message is being processed, this variable contains the contents of the
12072 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12073 contents of the &'From:'& header line. Apart from the removal of leading
12074 white space, the value is not processed in any way. In particular, no RFC 2047
12075 decoding or character code translation takes place.
12076
12077 .vitem &$return_path$&
12078 .vindex "&$return_path$&"
12079 When a message is being delivered, this variable contains the return path &--
12080 the sender field that will be sent as part of the envelope. It is not enclosed
12081 in <> characters. At the start of routing an address, &$return_path$& has the
12082 same value as &$sender_address$&, but if, for example, an incoming message to a
12083 mailing list has been expanded by a router which specifies a different address
12084 for bounce messages, &$return_path$& subsequently contains the new bounce
12085 address, whereas &$sender_address$& always contains the original sender address
12086 that was received with the message. In other words, &$sender_address$& contains
12087 the incoming envelope sender, and &$return_path$& contains the outgoing
12088 envelope sender.
12089
12090 .vitem &$return_size_limit$&
12091 .vindex "&$return_size_limit$&"
12092 This is an obsolete name for &$bounce_return_size_limit$&.
12093
12094 .vitem &$router_name$&
12095 .cindex "router" "name"
12096 .cindex "name" "of router"
12097 .vindex "&$router_name$&"
12098 During the running of a router this variable contains its name.
12099
12100 .vitem &$runrc$&
12101 .cindex "return code" "from &%run%& expansion"
12102 .vindex "&$runrc$&"
12103 This variable contains the return code from a command that is run by the
12104 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12105 assume the order in which option values are expanded, except for those
12106 preconditions whose order of testing is documented. Therefore, you cannot
12107 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12108 another.
12109
12110 .vitem &$self_hostname$&
12111 .oindex "&%self%&" "value of host name"
12112 .vindex "&$self_hostname$&"
12113 When an address is routed to a supposedly remote host that turns out to be the
12114 local host, what happens is controlled by the &%self%& generic router option.
12115 One of its values causes the address to be passed to another router. When this
12116 happens, &$self_hostname$& is set to the name of the local host that the
12117 original router encountered. In other circumstances its contents are null.
12118
12119 .vitem &$sender_address$&
12120 .vindex "&$sender_address$&"
12121 When a message is being processed, this variable contains the sender's address
12122 that was received in the message's envelope. The case of letters in the address
12123 is retained, in both the local part and the domain. For bounce messages, the
12124 value of this variable is the empty string. See also &$return_path$&.
12125
12126 .vitem &$sender_address_data$&
12127 .vindex "&$address_data$&"
12128 .vindex "&$sender_address_data$&"
12129 If &$address_data$& is set when the routers are called from an ACL to verify a
12130 sender address, the final value is preserved in &$sender_address_data$&, to
12131 distinguish it from data from a recipient address. The value does not persist
12132 after the end of the current ACL statement. If you want to preserve it for
12133 longer, you can save it in an ACL variable.
12134
12135 .vitem &$sender_address_domain$&
12136 .vindex "&$sender_address_domain$&"
12137 The domain portion of &$sender_address$&.
12138
12139 .vitem &$sender_address_local_part$&
12140 .vindex "&$sender_address_local_part$&"
12141 The local part portion of &$sender_address$&.
12142
12143 .vitem &$sender_data$&
12144 .vindex "&$sender_data$&"
12145 This variable is set after a lookup success in an ACL &%senders%& condition or
12146 in a router &%senders%& option. It contains the data from the lookup, and the
12147 value remains set until the next &%senders%& test. Thus, you can do things like
12148 this:
12149 .display
12150 &`require senders      = cdb*@;/some/file`&
12151 &`deny    `&&'some further test involving'& &`$sender_data`&
12152 .endd
12153 &*Warning*&: This variable is set only when a lookup is used as an indexing
12154 method in the address list, using the semicolon syntax as in the example above.
12155 The variable is not set for a lookup that is used as part of the string
12156 expansion that all such lists undergo before being interpreted.
12157
12158 .vitem &$sender_fullhost$&
12159 .vindex "&$sender_fullhost$&"
12160 When a message is received from a remote host, this variable contains the host
12161 name and IP address in a single string. It ends with the IP address in square
12162 brackets, followed by a colon and a port number if the logging of ports is
12163 enabled. The format of the rest of the string depends on whether the host
12164 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12165 looking up its IP address. (Looking up the IP address can be forced by the
12166 &%host_lookup%& option, independent of verification.) A plain host name at the
12167 start of the string is a verified host name; if this is not present,
12168 verification either failed or was not requested. A host name in parentheses is
12169 the argument of a HELO or EHLO command. This is omitted if it is identical to
12170 the verified host name or to the host's IP address in square brackets.
12171
12172 .vitem &$sender_helo_name$&
12173 .vindex "&$sender_helo_name$&"
12174 When a message is received from a remote host that has issued a HELO or EHLO
12175 command, the argument of that command is placed in this variable. It is also
12176 set if HELO or EHLO is used when a message is received using SMTP locally via
12177 the &%-bs%& or &%-bS%& options.
12178
12179 .vitem &$sender_host_address$&
12180 .vindex "&$sender_host_address$&"
12181 When a message is received from a remote host using SMTP,
12182 this variable contains that
12183 host's IP address. For locally non-SMTP submitted messages, it is empty.
12184
12185 .vitem &$sender_host_authenticated$&
12186 .vindex "&$sender_host_authenticated$&"
12187 This variable contains the name (not the public name) of the authenticator
12188 driver that successfully authenticated the client from which the message was
12189 received. It is empty if there was no successful authentication. See also
12190 &$authenticated_id$&.
12191
12192 .vitem &$sender_host_dnssec$&
12193 .vindex "&$sender_host_dnssec$&"
12194 If an attempt to populate &$sender_host_name$& has been made
12195 (by reference, &%hosts_lookup%& or
12196 otherwise) then this boolean will have been set true if, and only if, the
12197 resolver library states that the reverse DNS was authenticated data.  At all
12198 other times, this variable is false.
12199
12200 It is likely that you will need to coerce DNSSEC support on in the resolver
12201 library, by setting:
12202 .code
12203 dns_dnssec_ok = 1
12204 .endd
12205
12206 Exim does not perform DNSSEC validation itself, instead leaving that to a
12207 validating resolver (eg, unbound, or bind with suitable configuration).
12208
12209 Exim does not (currently) check to see if the forward DNS was also secured
12210 with DNSSEC, only the reverse DNS.
12211
12212 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12213 mechanism in the list, then this variable will be false.
12214
12215
12216 .vitem &$sender_host_name$&
12217 .vindex "&$sender_host_name$&"
12218 When a message is received from a remote host, this variable contains the
12219 host's name as obtained by looking up its IP address. For messages received by
12220 other means, this variable is empty.
12221
12222 .vindex "&$host_lookup_failed$&"
12223 If the host name has not previously been looked up, a reference to
12224 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12225 A looked up name is accepted only if it leads back to the original IP address
12226 via a forward lookup. If either the reverse or the forward lookup fails to find
12227 any data, or if the forward lookup does not yield the original IP address,
12228 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12229
12230 .vindex "&$host_lookup_deferred$&"
12231 However, if either of the lookups cannot be completed (for example, there is a
12232 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12233 &$host_lookup_failed$& remains set to &"0"&.
12234
12235 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12236 host name again if there is a subsequent reference to &$sender_host_name$&
12237 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12238 is set to &"1"&.
12239
12240 Exim does not automatically look up every calling host's name. If you want
12241 maximum efficiency, you should arrange your configuration so that it avoids
12242 these lookups altogether. The lookup happens only if one or more of the
12243 following are true:
12244
12245 .ilist
12246 A string containing &$sender_host_name$& is expanded.
12247 .next
12248 The calling host matches the list in &%host_lookup%&. In the default
12249 configuration, this option is set to *, so it must be changed if lookups are
12250 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12251 .next
12252 Exim needs the host name in order to test an item in a host list. The items
12253 that require this are described in sections &<<SECThoslispatnam>>& and
12254 &<<SECThoslispatnamsk>>&.
12255 .next
12256 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12257 In this case, the host name is required to compare with the name quoted in any
12258 EHLO or HELO commands that the client issues.
12259 .next
12260 The remote host issues a EHLO or HELO command that quotes one of the
12261 domains in &%helo_lookup_domains%&. The default value of this option is
12262 . ==== As this is a nested list, any displays it contains must be indented
12263 . ==== as otherwise they are too far to the left.
12264 .code
12265   helo_lookup_domains = @ : @[]
12266 .endd
12267 which causes a lookup if a remote host (incorrectly) gives the server's name or
12268 IP address in an EHLO or HELO command.
12269 .endlist
12270
12271
12272 .vitem &$sender_host_port$&
12273 .vindex "&$sender_host_port$&"
12274 When a message is received from a remote host, this variable contains the port
12275 number that was used on the remote host.
12276
12277 .vitem &$sender_ident$&
12278 .vindex "&$sender_ident$&"
12279 When a message is received from a remote host, this variable contains the
12280 identification received in response to an RFC 1413 request. When a message has
12281 been received locally, this variable contains the login name of the user that
12282 called Exim.
12283
12284 .vitem &$sender_rate_$&&'xxx'&
12285 A number of variables whose names begin &$sender_rate_$& are set as part of the
12286 &%ratelimit%& ACL condition. Details are given in section
12287 &<<SECTratelimiting>>&.
12288
12289 .vitem &$sender_rcvhost$&
12290 .cindex "DNS" "reverse lookup"
12291 .cindex "reverse DNS lookup"
12292 .vindex "&$sender_rcvhost$&"
12293 This is provided specifically for use in &'Received:'& headers. It starts with
12294 either the verified host name (as obtained from a reverse DNS lookup) or, if
12295 there is no verified host name, the IP address in square brackets. After that
12296 there may be text in parentheses. When the first item is a verified host name,
12297 the first thing in the parentheses is the IP address in square brackets,
12298 followed by a colon and a port number if port logging is enabled. When the
12299 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12300 the parentheses.
12301
12302 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12303 was used and its argument was not identical to the real host name or IP
12304 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12305 all three items are present in the parentheses, a newline and tab are inserted
12306 into the string, to improve the formatting of the &'Received:'& header.
12307
12308 .vitem &$sender_verify_failure$&
12309 .vindex "&$sender_verify_failure$&"
12310 In an ACL, when a sender verification fails, this variable contains information
12311 about the failure. The details are the same as for
12312 &$recipient_verify_failure$&.
12313
12314 .vitem &$sending_ip_address$&
12315 .vindex "&$sending_ip_address$&"
12316 This variable is set whenever an outgoing SMTP connection to another host has
12317 been set up. It contains the IP address of the local interface that is being
12318 used. This is useful if a host that has more than one IP address wants to take
12319 on different personalities depending on which one is being used. For incoming
12320 connections, see &$received_ip_address$&.
12321
12322 .vitem &$sending_port$&
12323 .vindex "&$sending_port$&"
12324 This variable is set whenever an outgoing SMTP connection to another host has
12325 been set up. It contains the local port that is being used. For incoming
12326 connections, see &$received_port$&.
12327
12328 .vitem &$smtp_active_hostname$&
12329 .vindex "&$smtp_active_hostname$&"
12330 During an incoming SMTP session, this variable contains the value of the active
12331 host name, as specified by the &%smtp_active_hostname%& option. The value of
12332 &$smtp_active_hostname$& is saved with any message that is received, so its
12333 value can be consulted during routing and delivery.
12334
12335 .vitem &$smtp_command$&
12336 .vindex "&$smtp_command$&"
12337 During the processing of an incoming SMTP command, this variable contains the
12338 entire command. This makes it possible to distinguish between HELO and EHLO in
12339 the HELO ACL, and also to distinguish between commands such as these:
12340 .code
12341 MAIL FROM:<>
12342 MAIL FROM: <>
12343 .endd
12344 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12345 command, the address in &$smtp_command$& is the original address before any
12346 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12347 the address after SMTP-time rewriting.
12348
12349 .vitem &$smtp_command_argument$&
12350 .cindex "SMTP" "command, argument for"
12351 .vindex "&$smtp_command_argument$&"
12352 While an ACL is running to check an SMTP command, this variable contains the
12353 argument, that is, the text that follows the command name, with leading white
12354 space removed. Following the introduction of &$smtp_command$&, this variable is
12355 somewhat redundant, but is retained for backwards compatibility.
12356
12357 .vitem &$smtp_count_at_connection_start$&
12358 .vindex "&$smtp_count_at_connection_start$&"
12359 This variable is set greater than zero only in processes spawned by the Exim
12360 daemon for handling incoming SMTP connections. The name is deliberately long,
12361 in order to emphasize what the contents are. When the daemon accepts a new
12362 connection, it increments this variable. A copy of the variable is passed to
12363 the child process that handles the connection, but its value is fixed, and
12364 never changes. It is only an approximation of how many incoming connections
12365 there actually are, because many other connections may come and go while a
12366 single connection is being processed. When a child process terminates, the
12367 daemon decrements its copy of the variable.
12368
12369 .vitem "&$sn0$& &-- &$sn9$&"
12370 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12371 that were current at the end of the system filter file. This allows a system
12372 filter file to set values that can be tested in users' filter files. For
12373 example, a system filter could set a value indicating how likely it is that a
12374 message is junk mail.
12375
12376 .vitem &$spam_$&&'xxx'&
12377 A number of variables whose names start with &$spam$& are available when Exim
12378 is compiled with the content-scanning extension. For details, see section
12379 &<<SECTscanspamass>>&.
12380
12381
12382 .vitem &$spool_directory$&
12383 .vindex "&$spool_directory$&"
12384 The name of Exim's spool directory.
12385
12386 .vitem &$spool_inodes$&
12387 .vindex "&$spool_inodes$&"
12388 The number of free inodes in the disk partition where Exim's spool files are
12389 being written. The value is recalculated whenever the variable is referenced.
12390 If the relevant file system does not have the concept of inodes, the value of
12391 is -1. See also the &%check_spool_inodes%& option.
12392
12393 .vitem &$spool_space$&
12394 .vindex "&$spool_space$&"
12395 The amount of free space (as a number of kilobytes) in the disk partition where
12396 Exim's spool files are being written. The value is recalculated whenever the
12397 variable is referenced. If the operating system does not have the ability to
12398 find the amount of free space (only true for experimental systems), the space
12399 value is -1. For example, to check in an ACL that there is at least 50
12400 megabytes free on the spool, you could write:
12401 .code
12402 condition = ${if > {$spool_space}{50000}}
12403 .endd
12404 See also the &%check_spool_space%& option.
12405
12406
12407 .vitem &$thisaddress$&
12408 .vindex "&$thisaddress$&"
12409 This variable is set only during the processing of the &%foranyaddress%&
12410 command in a filter file. Its use is explained in the description of that
12411 command, which can be found in the separate document entitled &'Exim's
12412 interfaces to mail filtering'&.
12413
12414 .vitem &$tls_in_bits$&
12415 .vindex "&$tls_in_bits$&"
12416 Contains an approximation of the TLS cipher's bit-strength
12417 on the inbound connection; the meaning of
12418 this depends upon the TLS implementation used.
12419 If TLS has not been negotiated, the value will be 0.
12420 The value of this is automatically fed into the Cyrus SASL authenticator
12421 when acting as a server, to specify the "external SSF" (a SASL term).
12422
12423 The deprecated &$tls_bits$& variable refers to the inbound side
12424 except when used in the context of an outbound SMTP delivery, when it refers to
12425 the outbound.
12426
12427 .vitem &$tls_out_bits$&
12428 .vindex "&$tls_out_bits$&"
12429 Contains an approximation of the TLS cipher's bit-strength
12430 on an outbound SMTP connection; the meaning of
12431 this depends upon the TLS implementation used.
12432 If TLS has not been negotiated, the value will be 0.
12433
12434 .vitem &$tls_in_ourcert$&
12435 .vindex "&$tls_in_ourcert$&"
12436 This variable refers to the certificate presented to the peer of an
12437 inbound connection when the message was received.
12438 It is only useful as the argument of a
12439 .new
12440 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12441 .wen
12442 or a &%def%& condition.
12443
12444 .vitem &$tls_in_peercert$&
12445 .vindex "&$tls_in_peercert$&"
12446 This variable refers to the certificate presented by the peer of an
12447 inbound connection when the message was received.
12448 It is only useful as the argument of a
12449 .new
12450 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12451 .wen
12452 or a &%def%& condition.
12453
12454 .vitem &$tls_out_ourcert$&
12455 .vindex "&$tls_out_ourcert$&"
12456 This variable refers to the certificate presented to the peer of an
12457 outbound connection.  It is only useful as the argument of a
12458 .new
12459 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12460 .wen
12461 or a &%def%& condition.
12462
12463 .vitem &$tls_out_peercert$&
12464 .vindex "&$tls_out_peercert$&"
12465 This variable refers to the certificate presented by the peer of an
12466 outbound connection.  It is only useful as the argument of a
12467 .new
12468 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12469 .wen
12470 or a &%def%& condition.
12471
12472 .vitem &$tls_in_certificate_verified$&
12473 .vindex "&$tls_in_certificate_verified$&"
12474 This variable is set to &"1"& if a TLS certificate was verified when the
12475 message was received, and &"0"& otherwise.
12476
12477 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12478 except when used in the context of an outbound SMTP delivery, when it refers to
12479 the outbound.
12480
12481 .vitem &$tls_out_certificate_verified$&
12482 .vindex "&$tls_out_certificate_verified$&"
12483 This variable is set to &"1"& if a TLS certificate was verified when an
12484 outbound SMTP connection was made,
12485 and &"0"& otherwise.
12486
12487 .vitem &$tls_in_cipher$&
12488 .vindex "&$tls_in_cipher$&"
12489 .vindex "&$tls_cipher$&"
12490 When a message is received from a remote host over an encrypted SMTP
12491 connection, this variable is set to the cipher suite that was negotiated, for
12492 example DES-CBC3-SHA. In other circumstances, in particular, for message
12493 received over unencrypted connections, the variable is empty. Testing
12494 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12495 non-encrypted connections during ACL processing.
12496
12497 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12498 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12499 becomes the same as &$tls_out_cipher$&.
12500
12501 .vitem &$tls_out_cipher$&
12502 .vindex "&$tls_out_cipher$&"
12503 This variable is
12504 cleared before any outgoing SMTP connection is made,
12505 and then set to the outgoing cipher suite if one is negotiated. See chapter
12506 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12507 details of the &(smtp)& transport.
12508
12509 .vitem &$tls_in_ocsp$&
12510 .vindex "&$tls_in_ocsp$&"
12511 When a message is received from a remote client connection
12512 the result of any OCSP request from the client is encoded in this variable:
12513 .code
12514 0 OCSP proof was not requested (default value)
12515 1 No response to request
12516 2 Response not verified
12517 3 Verification failed
12518 4 Verification succeeded
12519 .endd
12520
12521 .vitem &$tls_out_ocsp$&
12522 .vindex "&$tls_out_ocsp$&"
12523 When a message is sent to a remote host connection
12524 the result of any OCSP request made is encoded in this variable.
12525 See &$tls_in_ocsp$& for values.
12526
12527 .vitem &$tls_in_peerdn$&
12528 .vindex "&$tls_in_peerdn$&"
12529 .vindex "&$tls_peerdn$&"
12530 When a message is received from a remote host over an encrypted SMTP
12531 connection, and Exim is configured to request a certificate from the client,
12532 the value of the Distinguished Name of the certificate is made available in the
12533 &$tls_in_peerdn$& during subsequent processing.
12534
12535 The deprecated &$tls_peerdn$& variable refers to the inbound side
12536 except when used in the context of an outbound SMTP delivery, when it refers to
12537 the outbound.
12538
12539 .vitem &$tls_out_peerdn$&
12540 .vindex "&$tls_out_peerdn$&"
12541 When a message is being delivered to a remote host over an encrypted SMTP
12542 connection, and Exim is configured to request a certificate from the server,
12543 the value of the Distinguished Name of the certificate is made available in the
12544 &$tls_out_peerdn$& during subsequent processing.
12545
12546 .vitem &$tls_in_sni$&
12547 .vindex "&$tls_in_sni$&"
12548 .vindex "&$tls_sni$&"
12549 .cindex "TLS" "Server Name Indication"
12550 When a TLS session is being established, if the client sends the Server
12551 Name Indication extension, the value will be placed in this variable.
12552 If the variable appears in &%tls_certificate%& then this option and
12553 some others, described in &<<SECTtlssni>>&,
12554 will be re-expanded early in the TLS session, to permit
12555 a different certificate to be presented (and optionally a different key to be
12556 used) to the client, based upon the value of the SNI extension.
12557
12558 The deprecated &$tls_sni$& variable refers to the inbound side
12559 except when used in the context of an outbound SMTP delivery, when it refers to
12560 the outbound.
12561
12562 .vitem &$tls_out_sni$&
12563 .vindex "&$tls_out_sni$&"
12564 .cindex "TLS" "Server Name Indication"
12565 During outbound
12566 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12567 the transport.
12568
12569 .vitem &$tod_bsdinbox$&
12570 .vindex "&$tod_bsdinbox$&"
12571 The time of day and the date, in the format required for BSD-style mailbox
12572 files, for example: Thu Oct 17 17:14:09 1995.
12573
12574 .vitem &$tod_epoch$&
12575 .vindex "&$tod_epoch$&"
12576 The time and date as a number of seconds since the start of the Unix epoch.
12577
12578 .vitem &$tod_epoch_l$&
12579 .vindex "&$tod_epoch_l$&"
12580 The time and date as a number of microseconds since the start of the Unix epoch.
12581
12582 .vitem &$tod_full$&
12583 .vindex "&$tod_full$&"
12584 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12585 +0100. The timezone is always given as a numerical offset from UTC, with
12586 positive values used for timezones that are ahead (east) of UTC, and negative
12587 values for those that are behind (west).
12588
12589 .vitem &$tod_log$&
12590 .vindex "&$tod_log$&"
12591 The time and date in the format used for writing Exim's log files, for example:
12592 1995-10-12 15:32:29, but without a timezone.
12593
12594 .vitem &$tod_logfile$&
12595 .vindex "&$tod_logfile$&"
12596 This variable contains the date in the format yyyymmdd. This is the format that
12597 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12598 flag.
12599
12600 .vitem &$tod_zone$&
12601 .vindex "&$tod_zone$&"
12602 This variable contains the numerical value of the local timezone, for example:
12603 -0500.
12604
12605 .vitem &$tod_zulu$&
12606 .vindex "&$tod_zulu$&"
12607 This variable contains the UTC date and time in &"Zulu"& format, as specified
12608 by ISO 8601, for example: 20030221154023Z.
12609
12610 .vitem &$transport_name$&
12611 .cindex "transport" "name"
12612 .cindex "name" "of transport"
12613 .vindex "&$transport_name$&"
12614 During the running of a transport, this variable contains its name.
12615
12616 .vitem &$value$&
12617 .vindex "&$value$&"
12618 This variable contains the result of an expansion lookup, extraction operation,
12619 or external command, as described above. It is also used during a
12620 &*reduce*& expansion.
12621
12622 .vitem &$verify_mode$&
12623 .vindex "&$verify_mode$&"
12624 While a router or transport is being run in verify mode
12625 or for cutthrough delivery,
12626 contains "S" for sender-verification or "R" for recipient-verification.
12627 Otherwise, empty.
12628
12629 .vitem &$version_number$&
12630 .vindex "&$version_number$&"
12631 The version number of Exim.
12632
12633 .vitem &$warn_message_delay$&
12634 .vindex "&$warn_message_delay$&"
12635 This variable is set only during the creation of a message warning about a
12636 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12637
12638 .vitem &$warn_message_recipients$&
12639 .vindex "&$warn_message_recipients$&"
12640 This variable is set only during the creation of a message warning about a
12641 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12642 .endlist
12643 .ecindex IIDstrexp
12644
12645
12646
12647 . ////////////////////////////////////////////////////////////////////////////
12648 . ////////////////////////////////////////////////////////////////////////////
12649
12650 .chapter "Embedded Perl" "CHAPperl"
12651 .scindex IIDperl "Perl" "calling from Exim"
12652 Exim can be built to include an embedded Perl interpreter. When this is done,
12653 Perl subroutines can be called as part of the string expansion process. To make
12654 use of the Perl support, you need version 5.004 or later of Perl installed on
12655 your system. To include the embedded interpreter in the Exim binary, include
12656 the line
12657 .code
12658 EXIM_PERL = perl.o
12659 .endd
12660 in your &_Local/Makefile_& and then build Exim in the normal way.
12661
12662
12663 .section "Setting up so Perl can be used" "SECID85"
12664 .oindex "&%perl_startup%&"
12665 Access to Perl subroutines is via a global configuration option called
12666 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12667 no &%perl_startup%& option in the Exim configuration file then no Perl
12668 interpreter is started and there is almost no overhead for Exim (since none of
12669 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12670 option then the associated value is taken to be Perl code which is executed in
12671 a newly created Perl interpreter.
12672
12673 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12674 need backslashes before any characters to escape special meanings. The option
12675 should usually be something like
12676 .code
12677 perl_startup = do '/etc/exim.pl'
12678 .endd
12679 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12680 use from Exim. Exim can be configured either to start up a Perl interpreter as
12681 soon as it is entered, or to wait until the first time it is needed. Starting
12682 the interpreter at the beginning ensures that it is done while Exim still has
12683 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12684 fact used in a particular run. Also, note that this does not mean that Exim is
12685 necessarily running as root when Perl is called at a later time. By default,
12686 the interpreter is started only when it is needed, but this can be changed in
12687 two ways:
12688
12689 .ilist
12690 .oindex "&%perl_at_start%&"
12691 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12692 a startup when Exim is entered.
12693 .next
12694 The command line option &%-ps%& also requests a startup when Exim is entered,
12695 overriding the setting of &%perl_at_start%&.
12696 .endlist
12697
12698 There is also a command line option &%-pd%& (for delay) which suppresses the
12699 initial startup, even if &%perl_at_start%& is set.
12700
12701
12702 .section "Calling Perl subroutines" "SECID86"
12703 When the configuration file includes a &%perl_startup%& option you can make use
12704 of the string expansion item to call the Perl subroutines that are defined
12705 by the &%perl_startup%& code. The operator is used in any of the following
12706 forms:
12707 .code
12708 ${perl{foo}}
12709 ${perl{foo}{argument}}
12710 ${perl{foo}{argument1}{argument2} ... }
12711 .endd
12712 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12713 arguments may be passed. Passing more than this results in an expansion failure
12714 with an error message of the form
12715 .code
12716 Too many arguments passed to Perl subroutine "foo" (max is 8)
12717 .endd
12718 The return value of the Perl subroutine is evaluated in a scalar context before
12719 it is passed back to Exim to be inserted into the expanded string. If the
12720 return value is &'undef'&, the expansion is forced to fail in the same way as
12721 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12722 by obeying Perl's &%die%& function, the expansion fails with the error message
12723 that was passed to &%die%&.
12724
12725
12726 .section "Calling Exim functions from Perl" "SECID87"
12727 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12728 is available to call back into Exim's string expansion function. For example,
12729 the Perl code
12730 .code
12731 my $lp = Exim::expand_string('$local_part');
12732 .endd
12733 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12734 Note those are single quotes and not double quotes to protect against
12735 &$local_part$& being interpolated as a Perl variable.
12736
12737 If the string expansion is forced to fail by a &"fail"& item, the result of
12738 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12739 expansion string, the Perl call from the original expansion string fails with
12740 an appropriate error message, in the same way as if &%die%& were used.
12741
12742 .cindex "debugging" "from embedded Perl"
12743 .cindex "log" "writing from embedded Perl"
12744 Two other Exim functions are available for use from within Perl code.
12745 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12746 debugging is enabled. If you want a newline at the end, you must supply it.
12747 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12748 timestamp. In this case, you should not supply a terminating newline.
12749
12750
12751 .section "Use of standard output and error by Perl" "SECID88"
12752 .cindex "Perl" "standard output and error"
12753 You should not write to the standard error or output streams from within your
12754 Perl code, as it is not defined how these are set up. In versions of Exim
12755 before 4.50, it is possible for the standard output or error to refer to the
12756 SMTP connection during message reception via the daemon. Writing to this stream
12757 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12758 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12759 avoided, but the output is lost.
12760
12761 .cindex "Perl" "use of &%warn%&"
12762 The Perl &%warn%& statement writes to the standard error stream by default.
12763 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12764 you have no control. When Exim starts up the Perl interpreter, it arranges for
12765 output from the &%warn%& statement to be written to the Exim main log. You can
12766 change this by including appropriate Perl magic somewhere in your Perl code.
12767 For example, to discard &%warn%& output completely, you need this:
12768 .code
12769 $SIG{__WARN__} = sub { };
12770 .endd
12771 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12772 example, the code for the subroutine is empty, so it does nothing, but you can
12773 include any Perl code that you like. The text of the &%warn%& message is passed
12774 as the first subroutine argument.
12775 .ecindex IIDperl
12776
12777
12778 . ////////////////////////////////////////////////////////////////////////////
12779 . ////////////////////////////////////////////////////////////////////////////
12780
12781 .chapter "Starting the daemon and the use of network interfaces" &&&
12782          "CHAPinterfaces" &&&
12783          "Starting the daemon"
12784 .cindex "daemon" "starting"
12785 .cindex "interface" "listening"
12786 .cindex "network interface"
12787 .cindex "interface" "network"
12788 .cindex "IP address" "for listening"
12789 .cindex "daemon" "listening IP addresses"
12790 .cindex "TCP/IP" "setting listening interfaces"
12791 .cindex "TCP/IP" "setting listening ports"
12792 A host that is connected to a TCP/IP network may have one or more physical
12793 hardware network interfaces. Each of these interfaces may be configured as one
12794 or more &"logical"& interfaces, which are the entities that a program actually
12795 works with. Each of these logical interfaces is associated with an IP address.
12796 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12797 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12798 knowledge about the host's interfaces for use in three different circumstances:
12799
12800 .olist
12801 When a listening daemon is started, Exim needs to know which interfaces
12802 and ports to listen on.
12803 .next
12804 When Exim is routing an address, it needs to know which IP addresses
12805 are associated with local interfaces. This is required for the correct
12806 processing of MX lists by removing the local host and others with the
12807 same or higher priority values. Also, Exim needs to detect cases
12808 when an address is routed to an IP address that in fact belongs to the
12809 local host. Unless the &%self%& router option or the &%allow_localhost%&
12810 option of the smtp transport is set (as appropriate), this is treated
12811 as an error situation.
12812 .next
12813 When Exim connects to a remote host, it may need to know which interface to use
12814 for the outgoing connection.
12815 .endlist
12816
12817
12818 Exim's default behaviour is likely to be appropriate in the vast majority
12819 of cases. If your host has only one interface, and you want all its IP
12820 addresses to be treated in the same way, and you are using only the
12821 standard SMTP port, you should not need to take any special action. The
12822 rest of this chapter does not apply to you.
12823
12824 In a more complicated situation you may want to listen only on certain
12825 interfaces, or on different ports, and for this reason there are a number of
12826 options that can be used to influence Exim's behaviour. The rest of this
12827 chapter describes how they operate.
12828
12829 When a message is received over TCP/IP, the interface and port that were
12830 actually used are set in &$received_ip_address$& and &$received_port$&.
12831
12832
12833
12834 .section "Starting a listening daemon" "SECID89"
12835 When a listening daemon is started (by means of the &%-bd%& command line
12836 option), the interfaces and ports on which it listens are controlled by the
12837 following options:
12838
12839 .ilist
12840 &%daemon_smtp_ports%& contains a list of default ports
12841 or service names.
12842 (For backward compatibility, this option can also be specified in the singular.)
12843 .next
12844 &%local_interfaces%& contains list of interface IP addresses on which to
12845 listen. Each item may optionally also specify a port.
12846 .endlist
12847
12848 The default list separator in both cases is a colon, but this can be changed as
12849 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12850 it is usually best to change the separator to avoid having to double all the
12851 colons. For example:
12852 .code
12853 local_interfaces = <; 127.0.0.1 ; \
12854                       192.168.23.65 ; \
12855                       ::1 ; \
12856                       3ffe:ffff:836f::fe86:a061
12857 .endd
12858 There are two different formats for specifying a port along with an IP address
12859 in &%local_interfaces%&:
12860
12861 .olist
12862 The port is added onto the address with a dot separator. For example, to listen
12863 on port 1234 on two different IP addresses:
12864 .code
12865 local_interfaces = <; 192.168.23.65.1234 ; \
12866                       3ffe:ffff:836f::fe86:a061.1234
12867 .endd
12868 .next
12869 The IP address is enclosed in square brackets, and the port is added
12870 with a colon separator, for example:
12871 .code
12872 local_interfaces = <; [192.168.23.65]:1234 ; \
12873                       [3ffe:ffff:836f::fe86:a061]:1234
12874 .endd
12875 .endlist
12876
12877 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12878 default setting contains just one port:
12879 .code
12880 daemon_smtp_ports = smtp
12881 .endd
12882 If more than one port is listed, each interface that does not have its own port
12883 specified listens on all of them. Ports that are listed in
12884 &%daemon_smtp_ports%& can be identified either by name (defined in
12885 &_/etc/services_&) or by number. However, when ports are given with individual
12886 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12887
12888
12889
12890 .section "Special IP listening addresses" "SECID90"
12891 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12892 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12893 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12894 instead of setting up separate listening sockets for each interface. The
12895 default value of &%local_interfaces%& is
12896 .code
12897 local_interfaces = 0.0.0.0
12898 .endd
12899 when Exim is built without IPv6 support; otherwise it is:
12900 .code
12901 local_interfaces = <; ::0 ; 0.0.0.0
12902 .endd
12903 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12904
12905
12906
12907 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12908 The &%-oX%& command line option can be used to override the values of
12909 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12910 instance. Another way of doing this would be to use macros and the &%-D%&
12911 option. However, &%-oX%& can be used by any admin user, whereas modification of
12912 the runtime configuration by &%-D%& is allowed only when the caller is root or
12913 exim.
12914
12915 The value of &%-oX%& is a list of items. The default colon separator can be
12916 changed in the usual way if required. If there are any items that do not
12917 contain dots or colons (that is, are not IP addresses), the value of
12918 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12919 items that do contain dots or colons, the value of &%local_interfaces%& is
12920 replaced by those items. Thus, for example,
12921 .code
12922 -oX 1225
12923 .endd
12924 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12925 whereas
12926 .code
12927 -oX 192.168.34.5.1125
12928 .endd
12929 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12930 (However, since &%local_interfaces%& now contains no items without ports, the
12931 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12932
12933
12934
12935 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12936 .cindex "ssmtp protocol"
12937 .cindex "smtps protocol"
12938 .cindex "SMTP" "ssmtp protocol"
12939 .cindex "SMTP" "smtps protocol"
12940 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12941 before the STARTTLS command was standardized for SMTP. Some legacy clients
12942 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12943 list of port numbers or service names,
12944 connections to those ports must use SSMTP. The most
12945 common use of this option is expected to be
12946 .code
12947 tls_on_connect_ports = 465
12948 .endd
12949 because 465 is the usual port number used by the legacy clients. There is also
12950 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12951 this way when a daemon is started.
12952
12953 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12954 daemon to listen on those ports. You must still specify them in
12955 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12956 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12957 connections via the daemon.)
12958
12959
12960
12961
12962 .section "IPv6 address scopes" "SECID92"
12963 .cindex "IPv6" "address scopes"
12964 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12965 can, in principle, have the same link-local IPv6 address on different
12966 interfaces. Thus, additional information is needed, over and above the IP
12967 address, to distinguish individual interfaces. A convention of using a
12968 percent sign followed by something (often the interface name) has been
12969 adopted in some cases, leading to addresses like this:
12970 .code
12971 fe80::202:b3ff:fe03:45c1%eth0
12972 .endd
12973 To accommodate this usage, a percent sign followed by an arbitrary string is
12974 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12975 to convert a textual IPv6 address for actual use. This function recognizes the
12976 percent convention in operating systems that support it, and it processes the
12977 address appropriately. Unfortunately, some older libraries have problems with
12978 &[getaddrinfo()]&. If
12979 .code
12980 IPV6_USE_INET_PTON=yes
12981 .endd
12982 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12983 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12984 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12985 function.) Of course, this means that the additional functionality of
12986 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12987
12988 .section "Disabling IPv6" "SECID93"
12989 .cindex "IPv6" "disabling"
12990 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12991 run on a host whose kernel does not support IPv6. The binary will fall back to
12992 using IPv4, but it may waste resources looking up AAAA records, and trying to
12993 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12994 .oindex "&%disable_ipv6%&"
12995 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12996 activities take place. AAAA records are never looked up, and any IPv6 addresses
12997 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12998 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12999 to handle IPv6 literal addresses.
13000
13001 On the other hand, when IPv6 is in use, there may be times when you want to
13002 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13003 option to globally suppress the lookup of AAAA records for specified domains,
13004 and you can use the &%ignore_target_hosts%& generic router option to ignore
13005 IPv6 addresses in an individual router.
13006
13007
13008
13009 .section "Examples of starting a listening daemon" "SECID94"
13010 The default case in an IPv6 environment is
13011 .code
13012 daemon_smtp_ports = smtp
13013 local_interfaces = <; ::0 ; 0.0.0.0
13014 .endd
13015 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13016 Either one or two sockets may be used, depending on the characteristics of
13017 the TCP/IP stack. (This is complicated and messy; for more information,
13018 read the comments in the &_daemon.c_& source file.)
13019
13020 To specify listening on ports 25 and 26 on all interfaces:
13021 .code
13022 daemon_smtp_ports = 25 : 26
13023 .endd
13024 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13025 .code
13026 local_interfaces = <; ::0.25     ; ::0.26 \
13027                       0.0.0.0.25 ; 0.0.0.0.26
13028 .endd
13029 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13030 IPv4 loopback address only:
13031 .code
13032 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13033 .endd
13034 To specify listening on the default port on specific interfaces only:
13035 .code
13036 local_interfaces = 10.0.0.67 : 192.168.34.67
13037 .endd
13038 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13039
13040
13041
13042 .section "Recognizing the local host" "SECTreclocipadd"
13043 The &%local_interfaces%& option is also used when Exim needs to determine
13044 whether or not an IP address refers to the local host. That is, the IP
13045 addresses of all the interfaces on which a daemon is listening are always
13046 treated as local.
13047
13048 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13049 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13050 available interfaces from the operating system, and extracts the relevant
13051 (that is, IPv4 or IPv6) addresses to use for checking.
13052
13053 Some systems set up large numbers of virtual interfaces in order to provide
13054 many virtual web servers. In this situation, you may want to listen for
13055 email on only a few of the available interfaces, but nevertheless treat all
13056 interfaces as local when routing. You can do this by setting
13057 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13058 &"all"& wildcard values. These addresses are recognized as local, but are not
13059 used for listening. Consider this example:
13060 .code
13061 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13062                       192.168.53.235 ; \
13063                       3ffe:2101:12:1:a00:20ff:fe86:a061
13064
13065 extra_local_interfaces = <; ::0 ; 0.0.0.0
13066 .endd
13067 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13068 address, but all available interface addresses are treated as local when
13069 Exim is routing.
13070
13071 In some environments the local host name may be in an MX list, but with an IP
13072 address that is not assigned to any local interface. In other cases it may be
13073 desirable to treat other host names as if they referred to the local host. Both
13074 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13075 This contains host names rather than IP addresses. When a host is referenced
13076 during routing, either via an MX record or directly, it is treated as the local
13077 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13078 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13079
13080
13081
13082 .section "Delivering to a remote host" "SECID95"
13083 Delivery to a remote host is handled by the smtp transport. By default, it
13084 allows the system's TCP/IP functions to choose which interface to use (if
13085 there is more than one) when connecting to a remote host. However, the
13086 &%interface%& option can be set to specify which interface is used. See the
13087 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13088 details.
13089
13090
13091
13092
13093 . ////////////////////////////////////////////////////////////////////////////
13094 . ////////////////////////////////////////////////////////////////////////////
13095
13096 .chapter "Main configuration" "CHAPmainconfig"
13097 .scindex IIDconfima "configuration file" "main section"
13098 .scindex IIDmaiconf "main configuration"
13099 The first part of the run time configuration file contains three types of item:
13100
13101 .ilist
13102 Macro definitions: These lines start with an upper case letter. See section
13103 &<<SECTmacrodefs>>& for details of macro processing.
13104 .next
13105 Named list definitions: These lines start with one of the words &"domainlist"&,
13106 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13107 section &<<SECTnamedlists>>&.
13108 .next
13109 Main configuration settings: Each setting occupies one line of the file
13110 (with possible continuations). If any setting is preceded by the word
13111 &"hide"&, the &%-bP%& command line option displays its value to admin users
13112 only. See section &<<SECTcos>>& for a description of the syntax of these option
13113 settings.
13114 .endlist
13115
13116 This chapter specifies all the main configuration options, along with their
13117 types and default values. For ease of finding a particular option, they appear
13118 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13119 are now so many options, they are first listed briefly in functional groups, as
13120 an aid to finding the name of the option you are looking for. Some options are
13121 listed in more than one group.
13122
13123 .section "Miscellaneous" "SECID96"
13124 .table2
13125 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13126 .row &%disable_ipv6%&                "do no IPv6 processing"
13127 .row &%keep_malformed%&              "for broken files &-- should not happen"
13128 .row &%localhost_number%&            "for unique message ids in clusters"
13129 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13130 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13131 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13132 .row &%print_topbitchars%&           "top-bit characters are printing"
13133 .row &%timezone%&                    "force time zone"
13134 .endtable
13135
13136
13137 .section "Exim parameters" "SECID97"
13138 .table2
13139 .row &%exim_group%&                  "override compiled-in value"
13140 .row &%exim_path%&                   "override compiled-in value"
13141 .row &%exim_user%&                   "override compiled-in value"
13142 .row &%primary_hostname%&            "default from &[uname()]&"
13143 .row &%split_spool_directory%&       "use multiple directories"
13144 .row &%spool_directory%&             "override compiled-in value"
13145 .endtable
13146
13147
13148
13149 .section "Privilege controls" "SECID98"
13150 .table2
13151 .row &%admin_groups%&                "groups that are Exim admin users"
13152 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13153 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13154 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13155 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13156 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13157 .row &%never_users%&                 "do not run deliveries as these"
13158 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13159 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13160 .row &%trusted_groups%&              "groups that are trusted"
13161 .row &%trusted_users%&               "users that are trusted"
13162 .endtable
13163
13164
13165
13166 .section "Logging" "SECID99"
13167 .table2
13168 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13169 .row &%log_file_path%&               "override compiled-in value"
13170 .row &%log_selector%&                "set/unset optional logging"
13171 .row &%log_timezone%&                "add timezone to log lines"
13172 .row &%message_logs%&                "create per-message logs"
13173 .row &%preserve_message_logs%&       "after message completion"
13174 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13175 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13176 .row &%syslog_facility%&             "set syslog &""facility""& field"
13177 .row &%syslog_processname%&          "set syslog &""ident""& field"
13178 .row &%syslog_timestamp%&            "timestamp syslog lines"
13179 .row &%write_rejectlog%&             "control use of message log"
13180 .endtable
13181
13182
13183
13184 .section "Frozen messages" "SECID100"
13185 .table2
13186 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13187 .row &%freeze_tell%&                 "send message when freezing"
13188 .row &%move_frozen_messages%&        "to another directory"
13189 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13190 .endtable
13191
13192
13193
13194 .section "Data lookups" "SECID101"
13195 .table2
13196 .row &%ibase_servers%&               "InterBase servers"
13197 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13198 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13199 .row &%ldap_cert_file%&              "client cert file for LDAP"
13200 .row &%ldap_cert_key%&               "client key file for LDAP"
13201 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13202 .row &%ldap_default_servers%&        "used if no server in query"
13203 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13204 .row &%ldap_start_tls%&              "require TLS within LDAP"
13205 .row &%ldap_version%&                "set protocol version"
13206 .row &%lookup_open_max%&             "lookup files held open"
13207 .row &%mysql_servers%&               "default MySQL servers"
13208 .row &%oracle_servers%&              "Oracle servers"
13209 .row &%pgsql_servers%&               "default PostgreSQL servers"
13210 .row &%sqlite_lock_timeout%&         "as it says"
13211 .endtable
13212
13213
13214
13215 .section "Message ids" "SECID102"
13216 .table2
13217 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13218 .row &%message_id_header_text%&      "ditto"
13219 .endtable
13220
13221
13222
13223 .section "Embedded Perl Startup" "SECID103"
13224 .table2
13225 .row &%perl_at_start%&               "always start the interpreter"
13226 .row &%perl_startup%&                "code to obey when starting Perl"
13227 .endtable
13228
13229
13230
13231 .section "Daemon" "SECID104"
13232 .table2
13233 .row &%daemon_smtp_ports%&           "default ports"
13234 .row &%daemon_startup_retries%&      "number of times to retry"
13235 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13236 .row &%extra_local_interfaces%&      "not necessarily listened on"
13237 .row &%local_interfaces%&            "on which to listen, with optional ports"
13238 .row &%pid_file_path%&               "override compiled-in value"
13239 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13240 .endtable
13241
13242
13243
13244 .section "Resource control" "SECID105"
13245 .table2
13246 .row &%check_log_inodes%&            "before accepting a message"
13247 .row &%check_log_space%&             "before accepting a message"
13248 .row &%check_spool_inodes%&          "before accepting a message"
13249 .row &%check_spool_space%&           "before accepting a message"
13250 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13251 .row &%queue_only_load%&             "queue incoming if load high"
13252 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13253 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13254 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13255 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13256 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13257 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13258 .row &%smtp_accept_max_per_connection%& "messages per connection"
13259 .row &%smtp_accept_max_per_host%&    "connections from one host"
13260 .row &%smtp_accept_queue%&           "queue mail if more connections"
13261 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13262                                            connection"
13263 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13264 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13265 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13266 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13267 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13268 .endtable
13269
13270
13271
13272 .section "Policy controls" "SECID106"
13273 .table2
13274 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13275 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13276 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13277 .row &%acl_smtp_auth%&               "ACL for AUTH"
13278 .row &%acl_smtp_connect%&            "ACL for connection"
13279 .row &%acl_smtp_data%&               "ACL for DATA"
13280 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13281 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13282 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13283 .row &%acl_smtp_expn%&               "ACL for EXPN"
13284 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13285 .row &%acl_smtp_mail%&               "ACL for MAIL"
13286 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13287 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13288 .row &%acl_smtp_predata%&            "ACL for start of data"
13289 .row &%acl_smtp_quit%&               "ACL for QUIT"
13290 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13291 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13292 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13293 .row &%av_scanner%&                  "specify virus scanner"
13294 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13295                                       words""&"
13296 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13297 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13298 .row &%header_maxsize%&              "total size of message header"
13299 .row &%header_line_maxsize%&         "individual header line limit"
13300 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13301 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13302 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13303 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13304 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13305 .row &%host_lookup%&                 "host name looked up for these hosts"
13306 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13307 .row &%host_reject_connection%&      "reject connection from these hosts"
13308 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13309 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13310 .row &%message_size_limit%&          "for all messages"
13311 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13312 .row &%spamd_address%&               "set interface to SpamAssassin"
13313 .row &%strict_acl_vars%&             "object to unset ACL variables"
13314 .endtable
13315
13316
13317
13318 .section "Callout cache" "SECID107"
13319 .table2
13320 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13321                                          item"
13322 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13323                                          item"
13324 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13325 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13326 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13327 .endtable
13328
13329
13330
13331 .section "TLS" "SECID108"
13332 .table2
13333 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13334 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13335 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13336 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13337 .row &%tls_certificate%&             "location of server certificate"
13338 .row &%tls_crl%&                     "certificate revocation list"
13339 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13340 .row &%tls_dhparam%&                 "DH parameters for server"
13341 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13342 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13343 .row &%tls_privatekey%&              "location of server private key"
13344 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13345 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13346 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13347 .row &%tls_verify_certificates%&     "expected client certificates"
13348 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13349 .endtable
13350
13351
13352
13353 .section "Local user handling" "SECID109"
13354 .table2
13355 .row &%finduser_retries%&            "useful in NIS environments"
13356 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13357 .row &%gecos_pattern%&               "ditto"
13358 .row &%max_username_length%&         "for systems that truncate"
13359 .row &%unknown_login%&               "used when no login name found"
13360 .row &%unknown_username%&            "ditto"
13361 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13362 .row &%uucp_from_sender%&            "ditto"
13363 .endtable
13364
13365
13366
13367 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13368 .table2
13369 .row &%header_maxsize%&              "total size of message header"
13370 .row &%header_line_maxsize%&         "individual header line limit"
13371 .row &%message_size_limit%&          "applies to all messages"
13372 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13373 .row &%received_header_text%&        "expanded to make &'Received:'&"
13374 .row &%received_headers_max%&        "for mail loop detection"
13375 .row &%recipients_max%&              "limit per message"
13376 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13377 .endtable
13378
13379
13380
13381
13382 .section "Non-SMTP incoming messages" "SECID111"
13383 .table2
13384 .row &%receive_timeout%&             "for non-SMTP messages"
13385 .endtable
13386
13387
13388
13389
13390
13391 .section "Incoming SMTP messages" "SECID112"
13392 See also the &'Policy controls'& section above.
13393
13394 .table2
13395 .row &%host_lookup%&                 "host name looked up for these hosts"
13396 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13397 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13398 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13399 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13400 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13401 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13402 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13403 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13404 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13405 .row &%smtp_accept_max_per_connection%& "messages per connection"
13406 .row &%smtp_accept_max_per_host%&    "connections from one host"
13407 .row &%smtp_accept_queue%&           "queue mail if more connections"
13408 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13409                                            connection"
13410 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13411 .row &%smtp_active_hostname%&        "host name to use in messages"
13412 .row &%smtp_banner%&                 "text for welcome banner"
13413 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13414 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13415 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13416 .row &%smtp_etrn_command%&           "what to run for ETRN"
13417 .row &%smtp_etrn_serialize%&         "only one at once"
13418 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13419 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13420 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13421 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13422 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13423 .row &%smtp_receive_timeout%&        "per command or data line"
13424 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13425 .row &%smtp_return_error_details%&   "give detail on rejections"
13426 .endtable
13427
13428
13429
13430 .section "SMTP extensions" "SECID113"
13431 .table2
13432 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13433 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13434 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13435 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13436 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13437 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13438 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13439 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13440 .endtable
13441
13442
13443
13444 .section "Processing messages" "SECID114"
13445 .table2
13446 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13447 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13448 .row &%allow_utf8_domains%&          "in addresses"
13449 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13450                                       words""&"
13451 .row &%delivery_date_remove%&        "from incoming messages"
13452 .row &%envelope_to_remove%&          "from incoming messages"
13453 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13454 .row &%headers_charset%&             "default for translations"
13455 .row &%qualify_domain%&              "default for senders"
13456 .row &%qualify_recipient%&           "default for recipients"
13457 .row &%return_path_remove%&          "from incoming messages"
13458 .row &%strip_excess_angle_brackets%& "in addresses"
13459 .row &%strip_trailing_dot%&          "at end of addresses"
13460 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13461 .endtable
13462
13463
13464
13465 .section "System filter" "SECID115"
13466 .table2
13467 .row &%system_filter%&               "locate system filter"
13468 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13469                                             directory"
13470 .row &%system_filter_file_transport%& "transport for delivery to a file"
13471 .row &%system_filter_group%&         "group for filter running"
13472 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13473 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13474 .row &%system_filter_user%&          "user for filter running"
13475 .endtable
13476
13477
13478
13479 .section "Routing and delivery" "SECID116"
13480 .table2
13481 .row &%disable_ipv6%&                "do no IPv6 processing"
13482 .row &%dns_again_means_nonexist%&    "for broken domains"
13483 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13484 .row &%dns_dnssec_ok%&               "parameter for resolver"
13485 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13486 .row &%dns_retrans%&                 "parameter for resolver"
13487 .row &%dns_retry%&                   "parameter for resolver"
13488 .row &%dns_use_edns0%&               "parameter for resolver"
13489 .row &%hold_domains%&                "hold delivery for these domains"
13490 .row &%local_interfaces%&            "for routing checks"
13491 .row &%queue_domains%&               "no immediate delivery for these"
13492 .row &%queue_only%&                  "no immediate delivery at all"
13493 .row &%queue_only_file%&             "no immediate delivery if file exists"
13494 .row &%queue_only_load%&             "no immediate delivery if load is high"
13495 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13496 .row &%queue_only_override%&         "allow command line to override"
13497 .row &%queue_run_in_order%&          "order of arrival"
13498 .row &%queue_run_max%&               "of simultaneous queue runners"
13499 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13500 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13501 .row &%remote_sort_domains%&         "order of remote deliveries"
13502 .row &%retry_data_expire%&           "timeout for retry data"
13503 .row &%retry_interval_max%&          "safety net for retry rules"
13504 .endtable
13505
13506
13507
13508 .section "Bounce and warning messages" "SECID117"
13509 .table2
13510 .row &%bounce_message_file%&         "content of bounce"
13511 .row &%bounce_message_text%&         "content of bounce"
13512 .row &%bounce_return_body%&          "include body if returning message"
13513 .row &%bounce_return_message%&       "include original message in bounce"
13514 .row &%bounce_return_size_limit%&    "limit on returned message"
13515 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13516 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13517 .row &%errors_copy%&                 "copy bounce messages"
13518 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13519 .row &%delay_warning%&               "time schedule"
13520 .row &%delay_warning_condition%&     "condition for warning messages"
13521 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13522 .row &%smtp_return_error_details%&   "give detail on rejections"
13523 .row &%warn_message_file%&           "content of warning message"
13524 .endtable
13525
13526
13527
13528 .section "Alphabetical list of main options" "SECTalomo"
13529 Those options that undergo string expansion before use are marked with
13530 &dagger;.
13531
13532 .option accept_8bitmime main boolean true
13533 .cindex "8BITMIME"
13534 .cindex "8-bit characters"
13535 .cindex "log" "selectors"
13536 .cindex "log" "8BITMIME"
13537 This option causes Exim to send 8BITMIME in its response to an SMTP
13538 EHLO command, and to accept the BODY= parameter on MAIL commands.
13539 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13540 takes no steps to do anything special with messages received by this route.
13541
13542 Historically Exim kept this option off by default, but the maintainers
13543 feel that in today's Internet, this causes more problems than it solves.
13544 It now defaults to true.
13545 A more detailed analysis of the issues is provided by Dan Bernstein:
13546 .display
13547 &url(http://cr.yp.to/smtp/8bitmime.html)
13548 .endd
13549
13550 To log received 8BITMIME status use
13551 .code
13552 log_selector = +8bitmime
13553 .endd
13554
13555 .option acl_not_smtp main string&!! unset
13556 .cindex "&ACL;" "for non-SMTP messages"
13557 .cindex "non-SMTP messages" "ACLs for"
13558 This option defines the ACL that is run when a non-SMTP message has been
13559 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13560 further details.
13561
13562 .option acl_not_smtp_mime main string&!! unset
13563 This option defines the ACL that is run for individual MIME parts of non-SMTP
13564 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13565 SMTP messages.
13566
13567 .option acl_not_smtp_start main string&!! unset
13568 .cindex "&ACL;" "at start of non-SMTP message"
13569 .cindex "non-SMTP messages" "ACLs for"
13570 This option defines the ACL that is run before Exim starts reading a
13571 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13572
13573 .option acl_smtp_auth main string&!! unset
13574 .cindex "&ACL;" "setting up for SMTP commands"
13575 .cindex "AUTH" "ACL for"
13576 This option defines the ACL that is run when an SMTP AUTH command is
13577 received. See chapter &<<CHAPACL>>& for further details.
13578
13579 .option acl_smtp_connect main string&!! unset
13580 .cindex "&ACL;" "on SMTP connection"
13581 This option defines the ACL that is run when an SMTP connection is received.
13582 See chapter &<<CHAPACL>>& for further details.
13583
13584 .option acl_smtp_data main string&!! unset
13585 .cindex "DATA" "ACL for"
13586 This option defines the ACL that is run after an SMTP DATA command has been
13587 processed and the message itself has been received, but before the final
13588 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13589
13590 .option acl_smtp_data_prdr main string&!! accept
13591 .cindex "PRDR" "ACL for"
13592 .cindex "DATA" "PRDR ACL for"
13593 .cindex "&ACL;" "PRDR-related"
13594 .cindex "&ACL;" "per-user data processing"
13595 This option defines the ACL that,
13596 if the PRDR feature has been negotiated,
13597 is run for each recipient after an SMTP DATA command has been
13598 processed and the message itself has been received, but before the
13599 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13600
13601 .option acl_smtp_etrn main string&!! unset
13602 .cindex "ETRN" "ACL for"
13603 This option defines the ACL that is run when an SMTP ETRN command is
13604 received. See chapter &<<CHAPACL>>& for further details.
13605
13606 .option acl_smtp_expn main string&!! unset
13607 .cindex "EXPN" "ACL for"
13608 This option defines the ACL that is run when an SMTP EXPN command is
13609 received. See chapter &<<CHAPACL>>& for further details.
13610
13611 .option acl_smtp_helo main string&!! unset
13612 .cindex "EHLO" "ACL for"
13613 .cindex "HELO" "ACL for"
13614 This option defines the ACL that is run when an SMTP EHLO or HELO
13615 command is received. See chapter &<<CHAPACL>>& for further details.
13616
13617
13618 .option acl_smtp_mail main string&!! unset
13619 .cindex "MAIL" "ACL for"
13620 This option defines the ACL that is run when an SMTP MAIL command is
13621 received. See chapter &<<CHAPACL>>& for further details.
13622
13623 .option acl_smtp_mailauth main string&!! unset
13624 .cindex "AUTH" "on MAIL command"
13625 This option defines the ACL that is run when there is an AUTH parameter on
13626 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13627 &<<CHAPSMTPAUTH>>& for details of authentication.
13628
13629 .option acl_smtp_mime main string&!! unset
13630 .cindex "MIME content scanning" "ACL for"
13631 This option is available when Exim is built with the content-scanning
13632 extension. It defines the ACL that is run for each MIME part in a message. See
13633 section &<<SECTscanmimepart>>& for details.
13634
13635 .option acl_smtp_predata main string&!! unset
13636 This option defines the ACL that is run when an SMTP DATA command is
13637 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13638 further details.
13639
13640 .option acl_smtp_quit main string&!! unset
13641 .cindex "QUIT, ACL for"
13642 This option defines the ACL that is run when an SMTP QUIT command is
13643 received. See chapter &<<CHAPACL>>& for further details.
13644
13645 .option acl_smtp_rcpt main string&!! unset
13646 .cindex "RCPT" "ACL for"
13647 This option defines the ACL that is run when an SMTP RCPT command is
13648 received. See chapter &<<CHAPACL>>& for further details.
13649
13650 .option acl_smtp_starttls main string&!! unset
13651 .cindex "STARTTLS, ACL for"
13652 This option defines the ACL that is run when an SMTP STARTTLS command is
13653 received. See chapter &<<CHAPACL>>& for further details.
13654
13655 .option acl_smtp_vrfy main string&!! unset
13656 .cindex "VRFY" "ACL for"
13657 This option defines the ACL that is run when an SMTP VRFY command is
13658 received. See chapter &<<CHAPACL>>& for further details.
13659
13660 .option admin_groups main "string list&!!" unset
13661 .cindex "admin user"
13662 This option is expanded just once, at the start of Exim's processing. If the
13663 current group or any of the supplementary groups of an Exim caller is in this
13664 colon-separated list, the caller has admin privileges. If all your system
13665 programmers are in a specific group, for example, you can give them all Exim
13666 admin privileges by putting that group in &%admin_groups%&. However, this does
13667 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13668 To permit this, you have to add individuals to the Exim group.
13669
13670 .option allow_domain_literals main boolean false
13671 .cindex "domain literal"
13672 If this option is set, the RFC 2822 domain literal format is permitted in
13673 email addresses. The option is not set by default, because the domain literal
13674 format is not normally required these days, and few people know about it. It
13675 has, however, been exploited by mail abusers.
13676
13677 Unfortunately, it seems that some DNS black list maintainers are using this
13678 format to report black listing to postmasters. If you want to accept messages
13679 addressed to your hosts by IP address, you need to set
13680 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13681 domains (defined in the named domain list &%local_domains%& in the default
13682 configuration). This &"magic string"& matches the domain literal form of all
13683 the local host's IP addresses.
13684
13685
13686 .option allow_mx_to_ip main boolean false
13687 .cindex "MX record" "pointing to IP address"
13688 It appears that more and more DNS zone administrators are breaking the rules
13689 and putting domain names that look like IP addresses on the right hand side of
13690 MX records. Exim follows the rules and rejects this, giving an error message
13691 that explains the mis-configuration. However, some other MTAs support this
13692 practice, so to avoid &"Why can't Exim do this?"& complaints,
13693 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13694 recommended, except when you have no other choice.
13695
13696 .option allow_utf8_domains main boolean false
13697 .cindex "domain" "UTF-8 characters in"
13698 .cindex "UTF-8" "in domain name"
13699 Lots of discussion is going on about internationalized domain names. One
13700 camp is strongly in favour of just using UTF-8 characters, and it seems
13701 that at least two other MTAs permit this. This option allows Exim users to
13702 experiment if they wish.
13703
13704 If it is set true, Exim's domain parsing function allows valid
13705 UTF-8 multicharacters to appear in domain name components, in addition to
13706 letters, digits, and hyphens. However, just setting this option is not
13707 enough; if you want to look up these domain names in the DNS, you must also
13708 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13709 suitable setting is:
13710 .code
13711 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13712   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13713 .endd
13714 Alternatively, you can just disable this feature by setting
13715 .code
13716 dns_check_names_pattern =
13717 .endd
13718 That is, set the option to an empty string so that no check is done.
13719
13720
13721 .option auth_advertise_hosts main "host list&!!" *
13722 .cindex "authentication" "advertising"
13723 .cindex "AUTH" "advertising"
13724 If any server authentication mechanisms are configured, Exim advertises them in
13725 response to an EHLO command only if the calling host matches this list.
13726 Otherwise, Exim does not advertise AUTH.
13727 Exim does not accept AUTH commands from clients to which it has not
13728 advertised the availability of AUTH. The advertising of individual
13729 authentication mechanisms can be controlled by the use of the
13730 &%server_advertise_condition%& generic authenticator option on the individual
13731 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13732
13733 Certain mail clients (for example, Netscape) require the user to provide a name
13734 and password for authentication if AUTH is advertised, even though it may
13735 not be needed (the host may accept messages from hosts on its local LAN without
13736 authentication, for example). The &%auth_advertise_hosts%& option can be used
13737 to make these clients more friendly by excluding them from the set of hosts to
13738 which Exim advertises AUTH.
13739
13740 .cindex "AUTH" "advertising when encrypted"
13741 If you want to advertise the availability of AUTH only when the connection
13742 is encrypted using TLS, you can make use of the fact that the value of this
13743 option is expanded, with a setting like this:
13744 .code
13745 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13746 .endd
13747 .vindex "&$tls_in_cipher$&"
13748 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13749 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13750 expansion is *, which matches all hosts.
13751
13752
13753 .option auto_thaw main time 0s
13754 .cindex "thawing messages"
13755 .cindex "unfreezing messages"
13756 If this option is set to a time greater than zero, a queue runner will try a
13757 new delivery attempt on any frozen message, other than a bounce message, if
13758 this much time has passed since it was frozen. This may result in the message
13759 being re-frozen if nothing has changed since the last attempt. It is a way of
13760 saying &"keep on trying, even though there are big problems"&.
13761
13762 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13763 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13764 thought to be very useful any more, and its use should probably be avoided.
13765
13766
13767 .option av_scanner main string "see below"
13768 This option is available if Exim is built with the content-scanning extension.
13769 It specifies which anti-virus scanner to use. The default value is:
13770 .code
13771 sophie:/var/run/sophie
13772 .endd
13773 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13774 before use. See section &<<SECTscanvirus>>& for further details.
13775
13776
13777 .option bi_command main string unset
13778 .oindex "&%-bi%&"
13779 This option supplies the name of a command that is run when Exim is called with
13780 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13781 just the command name, it is not a complete command line. If an argument is
13782 required, it must come from the &%-oA%& command line option.
13783
13784
13785 .option bounce_message_file main string unset
13786 .cindex "bounce message" "customizing"
13787 .cindex "customizing" "bounce message"
13788 This option defines a template file containing paragraphs of text to be used
13789 for constructing bounce messages.  Details of the file's contents are given in
13790 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13791
13792
13793 .option bounce_message_text main string unset
13794 When this option is set, its contents are included in the default bounce
13795 message immediately after &"This message was created automatically by mail
13796 delivery software."& It is not used if &%bounce_message_file%& is set.
13797
13798 .option bounce_return_body main boolean true
13799 .cindex "bounce message" "including body"
13800 This option controls whether the body of an incoming message is included in a
13801 bounce message when &%bounce_return_message%& is true. The default setting
13802 causes the entire message, both header and body, to be returned (subject to the
13803 value of &%bounce_return_size_limit%&). If this option is false, only the
13804 message header is included. In the case of a non-SMTP message containing an
13805 error that is detected during reception, only those header lines preceding the
13806 point at which the error was detected are returned.
13807 .cindex "bounce message" "including original"
13808
13809 .option bounce_return_message main boolean true
13810 If this option is set false, none of the original message is included in
13811 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13812 &%bounce_return_body%&.
13813
13814
13815 .option bounce_return_size_limit main integer 100K
13816 .cindex "size" "of bounce, limit"
13817 .cindex "bounce message" "size limit"
13818 .cindex "limit" "bounce message size"
13819 This option sets a limit in bytes on the size of messages that are returned to
13820 senders as part of bounce messages when &%bounce_return_message%& is true. The
13821 limit should be less than the value of the global &%message_size_limit%& and of
13822 any &%message_size_limit%& settings on transports, to allow for the bounce text
13823 that Exim generates. If this option is set to zero there is no limit.
13824
13825 When the body of any message that is to be included in a bounce message is
13826 greater than the limit, it is truncated, and a comment pointing this out is
13827 added at the top. The actual cutoff may be greater than the value given, owing
13828 to the use of buffering for transferring the message in chunks (typically 8K in
13829 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13830 messages.
13831
13832 .option bounce_sender_authentication main string unset
13833 .cindex "bounce message" "sender authentication"
13834 .cindex "authentication" "bounce message"
13835 .cindex "AUTH" "on bounce message"
13836 This option provides an authenticated sender address that is sent with any
13837 bounce messages generated by Exim that are sent over an authenticated SMTP
13838 connection. A typical setting might be:
13839 .code
13840 bounce_sender_authentication = mailer-daemon@my.domain.example
13841 .endd
13842 which would cause bounce messages to be sent using the SMTP command:
13843 .code
13844 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13845 .endd
13846 The value of &%bounce_sender_authentication%& must always be a complete email
13847 address.
13848
13849 .option callout_domain_negative_expire main time 3h
13850 .cindex "caching" "callout timeouts"
13851 .cindex "callout" "caching timeouts"
13852 This option specifies the expiry time for negative callout cache data for a
13853 domain. See section &<<SECTcallver>>& for details of callout verification, and
13854 section &<<SECTcallvercache>>& for details of the caching.
13855
13856
13857 .option callout_domain_positive_expire main time 7d
13858 This option specifies the expiry time for positive callout cache data for a
13859 domain. See section &<<SECTcallver>>& for details of callout verification, and
13860 section &<<SECTcallvercache>>& for details of the caching.
13861
13862
13863 .option callout_negative_expire main time 2h
13864 This option specifies the expiry time for negative callout cache data for an
13865 address. See section &<<SECTcallver>>& for details of callout verification, and
13866 section &<<SECTcallvercache>>& for details of the caching.
13867
13868
13869 .option callout_positive_expire main time 24h
13870 This option specifies the expiry time for positive callout cache data for an
13871 address. See section &<<SECTcallver>>& for details of callout verification, and
13872 section &<<SECTcallvercache>>& for details of the caching.
13873
13874
13875 .option callout_random_local_part main string&!! "see below"
13876 This option defines the &"random"& local part that can be used as part of
13877 callout verification. The default value is
13878 .code
13879 $primary_hostname-$tod_epoch-testing
13880 .endd
13881 See section &<<CALLaddparcall>>& for details of how this value is used.
13882
13883
13884 .option check_log_inodes main integer 0
13885 See &%check_spool_space%& below.
13886
13887
13888 .option check_log_space main integer 0
13889 See &%check_spool_space%& below.
13890
13891 .oindex "&%check_rfc2047_length%&"
13892 .cindex "RFC 2047" "disabling length check"
13893 .option check_rfc2047_length main boolean true
13894 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13895 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13896 word; strings to be encoded that exceed this length are supposed to use
13897 multiple encoded words. By default, Exim does not recognize encoded words that
13898 exceed the maximum length. However, it seems that some software, in violation
13899 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13900 set false, Exim recognizes encoded words of any length.
13901
13902
13903 .option check_spool_inodes main integer 0
13904 See &%check_spool_space%& below.
13905
13906
13907 .option check_spool_space main integer 0
13908 .cindex "checking disk space"
13909 .cindex "disk space, checking"
13910 .cindex "spool directory" "checking space"
13911 The four &%check_...%& options allow for checking of disk resources before a
13912 message is accepted.
13913
13914 .vindex "&$log_inodes$&"
13915 .vindex "&$log_space$&"
13916 .vindex "&$spool_inodes$&"
13917 .vindex "&$spool_space$&"
13918 When any of these options are set, they apply to all incoming messages. If you
13919 want to apply different checks to different kinds of message, you can do so by
13920 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13921 &$spool_space$& in an ACL with appropriate additional conditions.
13922
13923
13924 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13925 either value is greater than zero, for example:
13926 .code
13927 check_spool_space = 10M
13928 check_spool_inodes = 100
13929 .endd
13930 The spool partition is the one that contains the directory defined by
13931 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13932 transit.
13933
13934 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13935 files are written if either is greater than zero. These should be set only if
13936 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13937
13938 If there is less space or fewer inodes than requested, Exim refuses to accept
13939 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13940 error response to the MAIL command. If ESMTP is in use and there was a
13941 SIZE parameter on the MAIL command, its value is added to the
13942 &%check_spool_space%& value, and the check is performed even if
13943 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13944
13945 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13946 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13947
13948 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13949 failure a message is written to stderr and Exim exits with a non-zero code, as
13950 it obviously cannot send an error message of any kind.
13951
13952 .option daemon_smtp_ports main string &`smtp`&
13953 .cindex "port" "for daemon"
13954 .cindex "TCP/IP" "setting listening ports"
13955 This option specifies one or more default SMTP ports on which the Exim daemon
13956 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13957 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13958
13959 .option daemon_startup_retries main integer 9
13960 .cindex "daemon startup, retrying"
13961 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13962 the daemon at startup when it cannot immediately bind a listening socket
13963 (typically because the socket is already in use): &%daemon_startup_retries%&
13964 defines the number of retries after the first failure, and
13965 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13966
13967 .option daemon_startup_sleep main time 30s
13968 See &%daemon_startup_retries%&.
13969
13970 .option delay_warning main "time list" 24h
13971 .cindex "warning of delay"
13972 .cindex "delay warning, specifying"
13973 When a message is delayed, Exim sends a warning message to the sender at
13974 intervals specified by this option. The data is a colon-separated list of times
13975 after which to send warning messages. If the value of the option is an empty
13976 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13977 message has been on the queue for longer than the last time, the last interval
13978 between the times is used to compute subsequent warning times. For example,
13979 with
13980 .code
13981 delay_warning = 4h:8h:24h
13982 .endd
13983 the first message is sent after 4 hours, the second after 8 hours, and
13984 the third one after 24 hours. After that, messages are sent every 16 hours,
13985 because that is the interval between the last two times on the list. If you set
13986 just one time, it specifies the repeat interval. For example, with:
13987 .code
13988 delay_warning = 6h
13989 .endd
13990 messages are repeated every six hours. To stop warnings after a given time, set
13991 a very large time at the end of the list. For example:
13992 .code
13993 delay_warning = 2h:12h:99d
13994 .endd
13995 Note that the option is only evaluated at the time a delivery attempt fails,
13996 which depends on retry and queue-runner configuration.
13997 Typically retries will be configured more frequently than warning messages.
13998
13999 .option delay_warning_condition main string&!! "see below"
14000 .vindex "&$domain$&"
14001 The string is expanded at the time a warning message might be sent. If all the
14002 deferred addresses have the same domain, it is set in &$domain$& during the
14003 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14004 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14005 &"false"& (the comparison being done caselessly) then the warning message is
14006 not sent. The default is:
14007 .code
14008 delay_warning_condition = ${if or {\
14009   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14010   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14011   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14012   } {no}{yes}}
14013 .endd
14014 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14015 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14016 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14017 &"auto-replied"& in an &'Auto-Submitted:'& header.
14018
14019 .option deliver_drop_privilege main boolean false
14020 .cindex "unprivileged delivery"
14021 .cindex "delivery" "unprivileged"
14022 If this option is set true, Exim drops its root privilege at the start of a
14023 delivery process, and runs as the Exim user throughout. This severely restricts
14024 the kinds of local delivery that are possible, but is viable in certain types
14025 of configuration. There is a discussion about the use of root privilege in
14026 chapter &<<CHAPsecurity>>&.
14027
14028 .option deliver_queue_load_max main fixed-point unset
14029 .cindex "load average"
14030 .cindex "queue runner" "abandoning"
14031 When this option is set, a queue run is abandoned if the system load average
14032 becomes greater than the value of the option. The option has no effect on
14033 ancient operating systems on which Exim cannot determine the load average.
14034 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14035
14036
14037 .option delivery_date_remove main boolean true
14038 .cindex "&'Delivery-date:'& header line"
14039 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14040 message when it is delivered, in exactly the same way as &'Return-path:'& is
14041 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14042 should not be present in incoming messages, and this option causes them to be
14043 removed at the time the message is received, to avoid any problems that might
14044 occur when a delivered message is subsequently sent on to some other recipient.
14045
14046 .option disable_fsync main boolean false
14047 .cindex "&[fsync()]&, disabling"
14048 This option is available only if Exim was built with the compile-time option
14049 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14050 a runtime configuration generates an &"unknown option"& error. You should not
14051 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14052 really, really, really understand what you are doing. &'No pre-compiled
14053 distributions of Exim should ever make this option available.'&
14054
14055 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14056 updated files' data to be written to disc before continuing. Unexpected events
14057 such as crashes and power outages may cause data to be lost or scrambled.
14058 Here be Dragons. &*Beware.*&
14059
14060
14061 .option disable_ipv6 main boolean false
14062 .cindex "IPv6" "disabling"
14063 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14064 activities take place. AAAA records are never looked up, and any IPv6 addresses
14065 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14066 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14067 to handle IPv6 literal addresses.
14068
14069
14070 .option dns_again_means_nonexist main "domain list&!!" unset
14071 .cindex "DNS" "&""try again""& response; overriding"
14072 DNS lookups give a &"try again"& response for the DNS errors
14073 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14074 keep trying to deliver a message, or to give repeated temporary errors to
14075 incoming mail. Sometimes the effect is caused by a badly set up name server and
14076 may persist for a long time. If a domain which exhibits this problem matches
14077 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14078 This option should be used with care. You can make it apply to reverse lookups
14079 by a setting such as this:
14080 .code
14081 dns_again_means_nonexist = *.in-addr.arpa
14082 .endd
14083 This option applies to all DNS lookups that Exim does. It also applies when the
14084 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14085 since these are most likely to be caused by DNS lookup problems. The
14086 &(dnslookup)& router has some options of its own for controlling what happens
14087 when lookups for MX or SRV records give temporary errors. These more specific
14088 options are applied after this global option.
14089
14090 .option dns_check_names_pattern main string "see below"
14091 .cindex "DNS" "pre-check of name syntax"
14092 When this option is set to a non-empty string, it causes Exim to check domain
14093 names for characters that are not allowed in host names before handing them to
14094 the DNS resolver, because some resolvers give temporary errors for names that
14095 contain unusual characters. If a domain name contains any unwanted characters,
14096 a &"not found"& result is forced, and the resolver is not called. The check is
14097 done by matching the domain name against a regular expression, which is the
14098 value of this option. The default pattern is
14099 .code
14100 dns_check_names_pattern = \
14101   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14102 .endd
14103 which permits only letters, digits, slashes, and hyphens in components, but
14104 they must start and end with a letter or digit. Slashes are not, in fact,
14105 permitted in host names, but they are found in certain NS records (which can be
14106 accessed in Exim by using a &%dnsdb%& lookup). If you set
14107 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14108 empty string.
14109
14110 .option dns_csa_search_limit main integer 5
14111 This option controls the depth of parental searching for CSA SRV records in the
14112 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14113
14114 .option dns_csa_use_reverse main boolean true
14115 This option controls whether or not an IP address, given as a CSA domain, is
14116 reversed and looked up in the reverse DNS, as described in more detail in
14117 section &<<SECTverifyCSA>>&.
14118
14119
14120 .option dns_dnssec_ok main integer -1
14121 .cindex "DNS" "resolver options"
14122 .cindex "DNS" "DNSSEC"
14123 If this option is set to a non-negative number then Exim will initialise the
14124 DNS resolver library to either use or not use DNSSEC, overriding the system
14125 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14126
14127 If the resolver library does not support DNSSEC then this option has no effect.
14128
14129
14130 .option dns_ipv4_lookup main "domain list&!!" unset
14131 .cindex "IPv6" "DNS lookup for AAAA records"
14132 .cindex "DNS" "IPv6 lookup for AAAA records"
14133 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14134 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14135 (A records) when trying to find IP addresses for hosts, unless the host's
14136 domain matches this list.
14137
14138 This is a fudge to help with name servers that give big delays or otherwise do
14139 not work for the AAAA record type. In due course, when the world's name
14140 servers have all been upgraded, there should be no need for this option.
14141
14142
14143 .option dns_retrans main time 0s
14144 .cindex "DNS" "resolver options"
14145 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14146 retransmission and retry parameters for DNS lookups. Values of zero (the
14147 defaults) leave the system default settings unchanged. The first value is the
14148 time between retries, and the second is the number of retries. It isn't
14149 totally clear exactly how these settings affect the total time a DNS lookup may
14150 take. I haven't found any documentation about timeouts on DNS lookups; these
14151 parameter values are available in the external resolver interface structure,
14152 but nowhere does it seem to describe how they are used or what you might want
14153 to set in them.
14154
14155
14156 .option dns_retry main integer 0
14157 See &%dns_retrans%& above.
14158
14159
14160 .option dns_use_edns0 main integer -1
14161 .cindex "DNS" "resolver options"
14162 .cindex "DNS" "EDNS0"
14163 If this option is set to a non-negative number then Exim will initialise the
14164 DNS resolver library to either use or not use EDNS0 extensions, overriding
14165 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14166 on.
14167
14168 If the resolver library does not support EDNS0 then this option has no effect.
14169
14170
14171 .option drop_cr main boolean false
14172 This is an obsolete option that is now a no-op. It used to affect the way Exim
14173 handled CR and LF characters in incoming messages. What happens now is
14174 described in section &<<SECTlineendings>>&.
14175
14176 .option dsn_advertise_hosts main "host list&!!" unset
14177 .cindex "bounce messages" "success"
14178 .cindex "DSN" "success"
14179 .cindex "Delivery Status Notification" "success"
14180 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14181 and accepted from, these hosts.
14182 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14183 and RET and ORCPT options on MAIL FROM commands.
14184 A NOTIFY=SUCCESS option requests success-DSN messages.
14185 A NOTIFY= option with no argument requests that no delay or failure DSNs
14186 are sent.
14187
14188 .option dsn_from main "string&!!" "see below"
14189 .cindex "&'From:'& header line" "in bounces"
14190 .cindex "bounce messages" "&'From:'& line, specifying"
14191 This option can be used to vary the contents of &'From:'& header lines in
14192 bounces and other automatically generated messages (&"Delivery Status
14193 Notifications"& &-- hence the name of the option). The default setting is:
14194 .code
14195 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14196 .endd
14197 The value is expanded every time it is needed. If the expansion fails, a
14198 panic is logged, and the default value is used.
14199
14200 .option envelope_to_remove main boolean true
14201 .cindex "&'Envelope-to:'& header line"
14202 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14203 message when it is delivered, in exactly the same way as &'Return-path:'& is
14204 handled. &'Envelope-to:'& records the original recipient address from the
14205 messages's envelope that caused the delivery to happen. Such headers should not
14206 be present in incoming messages, and this option causes them to be removed at
14207 the time the message is received, to avoid any problems that might occur when a
14208 delivered message is subsequently sent on to some other recipient.
14209
14210
14211 .option errors_copy main "string list&!!" unset
14212 .cindex "bounce message" "copy to other address"
14213 .cindex "copy of bounce message"
14214 Setting this option causes Exim to send bcc copies of bounce messages that it
14215 generates to other addresses. &*Note*&: This does not apply to bounce messages
14216 coming from elsewhere. The value of the option is a colon-separated list of
14217 items. Each item consists of a pattern, terminated by white space, followed by
14218 a comma-separated list of email addresses. If a pattern contains spaces, it
14219 must be enclosed in double quotes.
14220
14221 Each pattern is processed in the same way as a single item in an address list
14222 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14223 the bounce message, the message is copied to the addresses on the list. The
14224 items are scanned in order, and once a matching one is found, no further items
14225 are examined. For example:
14226 .code
14227 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14228               rqps@mydomain   hostmaster@mydomain.example,\
14229                               postmaster@mydomain.example
14230 .endd
14231 .vindex "&$domain$&"
14232 .vindex "&$local_part$&"
14233 The address list is expanded before use. The expansion variables &$local_part$&
14234 and &$domain$& are set from the original recipient of the error message, and if
14235 there was any wildcard matching in the pattern, the expansion
14236 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14237 variables &$0$&, &$1$&, etc. are set in the normal way.
14238
14239
14240 .option errors_reply_to main string unset
14241 .cindex "bounce message" "&'Reply-to:'& in"
14242 By default, Exim's bounce and delivery warning messages contain the header line
14243 .display
14244 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14245 .endd
14246 .oindex &%quota_warn_message%&
14247 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14248 A warning message that is generated by the &%quota_warn_message%& option in an
14249 &(appendfile)& transport may contain its own &'From:'& header line that
14250 overrides the default.
14251
14252 Experience shows that people reply to bounce messages. If the
14253 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14254 and warning messages. For example:
14255 .code
14256 errors_reply_to = postmaster@my.domain.example
14257 .endd
14258 The value of the option is not expanded. It must specify a valid RFC 2822
14259 address. However, if a warning message that is generated by the
14260 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14261 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14262 not used.
14263
14264
14265 .option exim_group main string "compile-time configured"
14266 .cindex "gid (group id)" "Exim's own"
14267 .cindex "Exim group"
14268 This option changes the gid under which Exim runs when it gives up root
14269 privilege. The default value is compiled into the binary. The value of this
14270 option is used only when &%exim_user%& is also set. Unless it consists entirely
14271 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14272 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14273 security issues.
14274
14275
14276 .option exim_path main string "see below"
14277 .cindex "Exim binary, path name"
14278 This option specifies the path name of the Exim binary, which is used when Exim
14279 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14280 the directory configured at compile time by the BIN_DIRECTORY setting. It
14281 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14282 other place.
14283 &*Warning*&: Do not use a macro to define the value of this option, because
14284 you will break those Exim utilities that scan the configuration file to find
14285 where the binary is. (They then use the &%-bP%& option to extract option
14286 settings such as the value of &%spool_directory%&.)
14287
14288
14289 .option exim_user main string "compile-time configured"
14290 .cindex "uid (user id)" "Exim's own"
14291 .cindex "Exim user"
14292 This option changes the uid under which Exim runs when it gives up root
14293 privilege. The default value is compiled into the binary. Ownership of the run
14294 time configuration file and the use of the &%-C%& and &%-D%& command line
14295 options is checked against the values in the binary, not what is set here.
14296
14297 Unless it consists entirely of digits, the string is looked up using
14298 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14299 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14300 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14301
14302
14303 .option extra_local_interfaces main "string list" unset
14304 This option defines network interfaces that are to be considered local when
14305 routing, but which are not used for listening by the daemon. See section
14306 &<<SECTreclocipadd>>& for details.
14307
14308
14309 . Allow this long option name to split; give it unsplit as a fifth argument
14310 . for the automatic .oindex that is generated by .option.
14311
14312 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14313          extract_addresses_remove_arguments
14314 .oindex "&%-t%&"
14315 .cindex "command line" "addresses with &%-t%&"
14316 .cindex "Sendmail compatibility" "&%-t%& option"
14317 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14318 are present on the command line when the &%-t%& option is used to build an
14319 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14320 line addresses are removed from the recipients list. This is also how Smail
14321 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14322 command line addresses are added to those obtained from the header lines. When
14323 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14324 argument headers. If it is set false, Exim adds rather than removes argument
14325 addresses.
14326
14327
14328 .option finduser_retries main integer 0
14329 .cindex "NIS, retrying user lookups"
14330 On systems running NIS or other schemes in which user and group information is
14331 distributed from a remote system, there can be times when &[getpwnam()]& and
14332 related functions fail, even when given valid data, because things time out.
14333 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14334 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14335 many extra times to find a user or a group, waiting for one second between
14336 retries.
14337
14338 .cindex "&_/etc/passwd_&" "multiple reading of"
14339 You should not set this option greater than zero if your user information is in
14340 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14341 search the file multiple times for non-existent users, and also cause delay.
14342
14343
14344
14345 .option freeze_tell main "string list, comma separated" unset
14346 .cindex "freezing messages" "sending a message when freezing"
14347 On encountering certain errors, or when configured to do so in a system filter,
14348 ACL, or special router, Exim freezes a message. This means that no further
14349 delivery attempts take place until an administrator thaws the message, or the
14350 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14351 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14352 warning message whenever it freezes something, unless the message it is
14353 freezing is a locally-generated bounce message. (Without this exception there
14354 is the possibility of looping.) The warning message is sent to the addresses
14355 supplied as the comma-separated value of this option. If several of the
14356 message's addresses cause freezing, only a single message is sent. If the
14357 freezing was automatic, the reason(s) for freezing can be found in the message
14358 log. If you configure freezing in a filter or ACL, you must arrange for any
14359 logging that you require.
14360
14361
14362 .option gecos_name main string&!! unset
14363 .cindex "HP-UX"
14364 .cindex "&""gecos""& field, parsing"
14365 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14366 password file to hold other information in addition to users' real names. Exim
14367 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14368 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14369 of the field are used unchanged, except that, if an ampersand is encountered,
14370 it is replaced by the user's login name with the first character forced to
14371 upper case, since this is a convention that is observed on many systems.
14372
14373 When these options are set, &%gecos_pattern%& is treated as a regular
14374 expression that is to be applied to the field (again with && replaced by the
14375 login name), and if it matches, &%gecos_name%& is expanded and used as the
14376 user's name.
14377
14378 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14379 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14380 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14381 name terminates at the first comma, the following can be used:
14382 .code
14383 gecos_pattern = ([^,]*)
14384 gecos_name = $1
14385 .endd
14386
14387 .option gecos_pattern main string unset
14388 See &%gecos_name%& above.
14389
14390
14391 .option gnutls_compat_mode main boolean unset
14392 This option controls whether GnuTLS is used in compatibility mode in an Exim
14393 server. This reduces security slightly, but improves interworking with older
14394 implementations of TLS.
14395
14396
14397 option gnutls_allow_auto_pkcs11 main boolean unset
14398 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14399 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14400
14401 See
14402 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14403 for documentation.
14404
14405
14406
14407 .option headers_charset main string "see below"
14408 This option sets a default character set for translating from encoded MIME
14409 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14410 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14411 ultimate default is ISO-8859-1. For more details see the description of header
14412 insertions in section &<<SECTexpansionitems>>&.
14413
14414
14415
14416 .option header_maxsize main integer "see below"
14417 .cindex "header section" "maximum size of"
14418 .cindex "limit" "size of message header section"
14419 This option controls the overall maximum size of a message's header
14420 section. The default is the value of HEADER_MAXSIZE in
14421 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14422 sections are rejected.
14423
14424
14425 .option header_line_maxsize main integer 0
14426 .cindex "header lines" "maximum size of"
14427 .cindex "limit" "size of one header line"
14428 This option limits the length of any individual header line in a message, after
14429 all the continuations have been joined together. Messages with individual
14430 header lines that are longer than the limit are rejected. The default value of
14431 zero means &"no limit"&.
14432
14433
14434
14435
14436 .option helo_accept_junk_hosts main "host list&!!" unset
14437 .cindex "HELO" "accepting junk data"
14438 .cindex "EHLO" "accepting junk data"
14439 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14440 mail, and gives an error response for invalid data. Unfortunately, there are
14441 some SMTP clients that send syntactic junk. They can be accommodated by setting
14442 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14443 if you want to do semantic checking.
14444 See also &%helo_allow_chars%& for a way of extending the permitted character
14445 set.
14446
14447
14448 .option helo_allow_chars main string unset
14449 .cindex "HELO" "underscores in"
14450 .cindex "EHLO" "underscores in"
14451 .cindex "underscore in EHLO/HELO"
14452 This option can be set to a string of rogue characters that are permitted in
14453 all EHLO and HELO names in addition to the standard letters, digits,
14454 hyphens, and dots. If you really must allow underscores, you can set
14455 .code
14456 helo_allow_chars = _
14457 .endd
14458 Note that the value is one string, not a list.
14459
14460
14461 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14462 .cindex "HELO" "forcing reverse lookup"
14463 .cindex "EHLO" "forcing reverse lookup"
14464 If the domain given by a client in a HELO or EHLO command matches this
14465 list, a reverse lookup is done in order to establish the host's true name. The
14466 default forces a lookup if the client host gives the server's name or any of
14467 its IP addresses (in brackets), something that broken clients have been seen to
14468 do.
14469
14470
14471 .option helo_try_verify_hosts main "host list&!!" unset
14472 .cindex "HELO verifying" "optional"
14473 .cindex "EHLO" "verifying, optional"
14474 By default, Exim just checks the syntax of HELO and EHLO commands (see
14475 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14476 to do more extensive checking of the data supplied by these commands. The ACL
14477 condition &`verify = helo`& is provided to make this possible.
14478 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14479 to force the check to occur. From release 4.53 onwards, this is no longer
14480 necessary. If the check has not been done before &`verify = helo`& is
14481 encountered, it is done at that time. Consequently, this option is obsolete.
14482 Its specification is retained here for backwards compatibility.
14483
14484 When an EHLO or HELO command is received, if the calling host matches
14485 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14486 EHLO command either:
14487
14488 .ilist
14489 is an IP literal matching the calling address of the host, or
14490 .next
14491 .cindex "DNS" "reverse lookup"
14492 .cindex "reverse DNS lookup"
14493 matches the host name that Exim obtains by doing a reverse lookup of the
14494 calling host address, or
14495 .next
14496 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14497 available) yields the calling host address.
14498 .endlist
14499
14500 However, the EHLO or HELO command is not rejected if any of the checks
14501 fail. Processing continues, but the result of the check is remembered, and can
14502 be detected later in an ACL by the &`verify = helo`& condition.
14503
14504 .option helo_verify_hosts main "host list&!!" unset
14505 .cindex "HELO verifying" "mandatory"
14506 .cindex "EHLO" "verifying, mandatory"
14507 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14508 backwards compatibility. For hosts that match this option, Exim checks the host
14509 name given in the HELO or EHLO in the same way as for
14510 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14511 rejected with a 550 error, and entries are written to the main and reject logs.
14512 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14513 error.
14514
14515 .option hold_domains main "domain list&!!" unset
14516 .cindex "domain" "delaying delivery"
14517 .cindex "delivery" "delaying certain domains"
14518 This option allows mail for particular domains to be held on the queue
14519 manually. The option is overridden if a message delivery is forced with the
14520 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14521 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14522 item in &%hold_domains%&, no routing or delivery for that address is done, and
14523 it is deferred every time the message is looked at.
14524
14525 This option is intended as a temporary operational measure for delaying the
14526 delivery of mail while some problem is being sorted out, or some new
14527 configuration tested. If you just want to delay the processing of some
14528 domains until a queue run occurs, you should use &%queue_domains%& or
14529 &%queue_smtp_domains%&, not &%hold_domains%&.
14530
14531 A setting of &%hold_domains%& does not override Exim's code for removing
14532 messages from the queue if they have been there longer than the longest retry
14533 time in any retry rule. If you want to hold messages for longer than the normal
14534 retry times, insert a dummy retry rule with a long retry time.
14535
14536
14537 .option host_lookup main "host list&!!" unset
14538 .cindex "host name" "lookup, forcing"
14539 Exim does not look up the name of a calling host from its IP address unless it
14540 is required to compare against some host list, or the host matches
14541 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14542 option (which normally contains IP addresses rather than host names). The
14543 default configuration file contains
14544 .code
14545 host_lookup = *
14546 .endd
14547 which causes a lookup to happen for all hosts. If the expense of these lookups
14548 is felt to be too great, the setting can be changed or removed.
14549
14550 After a successful reverse lookup, Exim does a forward lookup on the name it
14551 has obtained, to verify that it yields the IP address that it started with. If
14552 this check fails, Exim behaves as if the name lookup failed.
14553
14554 .vindex "&$host_lookup_failed$&"
14555 .vindex "&$sender_host_name$&"
14556 After any kind of failure, the host name (in &$sender_host_name$&) remains
14557 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14558 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14559 &`verify = reverse_host_lookup`& in ACLs.
14560
14561
14562 .option host_lookup_order main "string list" &`bydns:byaddr`&
14563 This option specifies the order of different lookup methods when Exim is trying
14564 to find a host name from an IP address. The default is to do a DNS lookup
14565 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14566 if that fails. You can change the order of these lookups, or omit one entirely,
14567 if you want.
14568
14569 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14570 multiple PTR records in the DNS and the IP address is not listed in
14571 &_/etc/hosts_&. Different operating systems give different results in this
14572 case. That is why the default tries a DNS lookup first.
14573
14574
14575
14576 .option host_reject_connection main "host list&!!" unset
14577 .cindex "host" "rejecting connections from"
14578 If this option is set, incoming SMTP calls from the hosts listed are rejected
14579 as soon as the connection is made.
14580 This option is obsolete, and retained only for backward compatibility, because
14581 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14582 connections immediately.
14583
14584 The ability to give an immediate rejection (either by this option or using an
14585 ACL) is provided for use in unusual cases. Many hosts will just try again,
14586 sometimes without much delay. Normally, it is better to use an ACL to reject
14587 incoming messages at a later stage, such as after RCPT commands. See
14588 chapter &<<CHAPACL>>&.
14589
14590
14591 .option hosts_connection_nolog main "host list&!!" unset
14592 .cindex "host" "not logging connections from"
14593 This option defines a list of hosts for which connection logging does not
14594 happen, even though the &%smtp_connection%& log selector is set. For example,
14595 you might want not to log SMTP connections from local processes, or from
14596 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14597 the daemon; you should therefore strive to restrict its value to a short inline
14598 list of IP addresses and networks. To disable logging SMTP connections from
14599 local processes, you must create a host list with an empty item. For example:
14600 .code
14601 hosts_connection_nolog = :
14602 .endd
14603 If the &%smtp_connection%& log selector is not set, this option has no effect.
14604
14605
14606
14607 .option hosts_treat_as_local main "domain list&!!" unset
14608 .cindex "local host" "domains treated as"
14609 .cindex "host" "treated as local"
14610 If this option is set, any host names that match the domain list are treated as
14611 if they were the local host when Exim is scanning host lists obtained from MX
14612 records
14613 or other sources. Note that the value of this option is a domain list, not a
14614 host list, because it is always used to check host names, not IP addresses.
14615
14616 This option also applies when Exim is matching the special items
14617 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14618 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14619 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14620 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14621 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14622 interfaces and recognizing the local host.
14623
14624
14625 .option ibase_servers main "string list" unset
14626 .cindex "InterBase" "server list"
14627 This option provides a list of InterBase servers and associated connection data,
14628 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14629 The option is available only if Exim has been built with InterBase support.
14630
14631
14632
14633 .option ignore_bounce_errors_after main time 10w
14634 .cindex "bounce message" "discarding"
14635 .cindex "discarding bounce message"
14636 This option affects the processing of bounce messages that cannot be delivered,
14637 that is, those that suffer a permanent delivery failure. (Bounce messages that
14638 suffer temporary delivery failures are of course retried in the usual way.)
14639
14640 After a permanent delivery failure, bounce messages are frozen,
14641 because there is no sender to whom they can be returned. When a frozen bounce
14642 message has been on the queue for more than the given time, it is unfrozen at
14643 the next queue run, and a further delivery is attempted. If delivery fails
14644 again, the bounce message is discarded. This makes it possible to keep failed
14645 bounce messages around for a shorter time than the normal maximum retry time
14646 for frozen messages. For example,
14647 .code
14648 ignore_bounce_errors_after = 12h
14649 .endd
14650 retries failed bounce message deliveries after 12 hours, discarding any further
14651 failures. If the value of this option is set to a zero time period, bounce
14652 failures are discarded immediately. Setting a very long time (as in the default
14653 value) has the effect of disabling this option. For ways of automatically
14654 dealing with other kinds of frozen message, see &%auto_thaw%& and
14655 &%timeout_frozen_after%&.
14656
14657
14658 .option ignore_fromline_hosts main "host list&!!" unset
14659 .cindex "&""From""& line"
14660 .cindex "UUCP" "&""From""& line"
14661 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14662 the headers of a message. By default this is treated as the start of the
14663 message's body, which means that any following headers are not recognized as
14664 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14665 match those hosts that insist on sending it. If the sender is actually a local
14666 process rather than a remote host, and is using &%-bs%& to inject the messages,
14667 &%ignore_fromline_local%& must be set to achieve this effect.
14668
14669
14670 .option ignore_fromline_local main boolean false
14671 See &%ignore_fromline_hosts%& above.
14672
14673
14674 .option keep_malformed main time 4d
14675 This option specifies the length of time to keep messages whose spool files
14676 have been corrupted in some way. This should, of course, never happen. At the
14677 next attempt to deliver such a message, it gets removed. The incident is
14678 logged.
14679
14680
14681 .option ldap_ca_cert_dir main string unset
14682 .cindex "LDAP", "TLS CA certificate directory"
14683 This option indicates which directory contains CA certificates for verifying
14684 a TLS certificate presented by an LDAP server.
14685 While Exim does not provide a default value, your SSL library may.
14686 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14687 and constrained to be a directory.
14688
14689
14690 .option ldap_ca_cert_file main string unset
14691 .cindex "LDAP", "TLS CA certificate file"
14692 This option indicates which file contains CA certificates for verifying
14693 a TLS certificate presented by an LDAP server.
14694 While Exim does not provide a default value, your SSL library may.
14695 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14696 and constrained to be a file.
14697
14698
14699 .option ldap_cert_file main string unset
14700 .cindex "LDAP" "TLS client certificate file"
14701 This option indicates which file contains an TLS client certificate which
14702 Exim should present to the LDAP server during TLS negotiation.
14703 Should be used together with &%ldap_cert_key%&.
14704
14705
14706 .option ldap_cert_key main string unset
14707 .cindex "LDAP" "TLS client key file"
14708 This option indicates which file contains the secret/private key to use
14709 to prove identity to the LDAP server during TLS negotiation.
14710 Should be used together with &%ldap_cert_file%&, which contains the
14711 identity to be proven.
14712
14713
14714 .option ldap_cipher_suite main string unset
14715 .cindex "LDAP" "TLS cipher suite"
14716 This controls the TLS cipher-suite negotiation during TLS negotiation with
14717 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14718 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14719
14720
14721 .option ldap_default_servers main "string list" unset
14722 .cindex "LDAP" "default servers"
14723 This option provides a list of LDAP servers which are tried in turn when an
14724 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14725 details of LDAP queries. This option is available only when Exim has been built
14726 with LDAP support.
14727
14728
14729 .option ldap_require_cert main string unset.
14730 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14731 This should be one of the values "hard", "demand", "allow", "try" or "never".
14732 A value other than one of these is interpreted as "never".
14733 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14734 Although Exim does not set a default, the LDAP library probably defaults
14735 to hard/demand.
14736
14737
14738 .option ldap_start_tls main boolean false
14739 .cindex "LDAP" "whether or not to negotiate TLS"
14740 If set, Exim will attempt to negotiate TLS with the LDAP server when
14741 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14742 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14743 of SSL-on-connect.
14744 In the event of failure to negotiate TLS, the action taken is controlled
14745 by &%ldap_require_cert%&.
14746
14747
14748 .option ldap_version main integer unset
14749 .cindex "LDAP" "protocol version, forcing"
14750 This option can be used to force Exim to set a specific protocol version for
14751 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14752 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14753 the LDAP headers; otherwise it is 2. This option is available only when Exim
14754 has been built with LDAP support.
14755
14756
14757
14758 .option local_from_check main boolean true
14759 .cindex "&'Sender:'& header line" "disabling addition of"
14760 .cindex "&'From:'& header line" "disabling checking of"
14761 When a message is submitted locally (that is, not over a TCP/IP connection) by
14762 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14763 checks that the &'From:'& header line matches the login of the calling user and
14764 the domain specified by &%qualify_domain%&.
14765
14766 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14767 locally submitted message is automatically qualified by Exim, unless the
14768 &%-bnq%& command line option is used.
14769
14770 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14771 on the local part. If the &'From:'& header line does not match, Exim adds a
14772 &'Sender:'& header with an address constructed from the calling user's login
14773 and the default qualify domain.
14774
14775 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14776 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14777 &'Sender:'& header lines supplied by untrusted users, you must also set
14778 &%local_sender_retain%& to be true.
14779
14780 .cindex "envelope sender"
14781 These options affect only the header lines in the message. The envelope sender
14782 is still forced to be the login id at the qualify domain unless
14783 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14784
14785 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14786 request similar header line checking. See section &<<SECTthesenhea>>&, which
14787 has more details about &'Sender:'& processing.
14788
14789
14790
14791
14792 .option local_from_prefix main string unset
14793 When Exim checks the &'From:'& header line of locally submitted messages for
14794 matching the login id (see &%local_from_check%& above), it can be configured to
14795 ignore certain prefixes and suffixes in the local part of the address. This is
14796 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14797 appropriate lists, in the same form as the &%local_part_prefix%& and
14798 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14799 example, if
14800 .code
14801 local_from_prefix = *-
14802 .endd
14803 is set, a &'From:'& line containing
14804 .code
14805 From: anything-user@your.domain.example
14806 .endd
14807 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14808 matches the actual sender address that is constructed from the login name and
14809 qualify domain.
14810
14811
14812 .option local_from_suffix main string unset
14813 See &%local_from_prefix%& above.
14814
14815
14816 .option local_interfaces main "string list" "see below"
14817 This option controls which network interfaces are used by the daemon for
14818 listening; they are also used to identify the local host when routing. Chapter
14819 &<<CHAPinterfaces>>& contains a full description of this option and the related
14820 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14821 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14822 &%local_interfaces%& is
14823 .code
14824 local_interfaces = 0.0.0.0
14825 .endd
14826 when Exim is built without IPv6 support; otherwise it is
14827 .code
14828 local_interfaces = <; ::0 ; 0.0.0.0
14829 .endd
14830
14831 .option local_scan_timeout main time 5m
14832 .cindex "timeout" "for &[local_scan()]& function"
14833 .cindex "&[local_scan()]& function" "timeout"
14834 This timeout applies to the &[local_scan()]& function (see chapter
14835 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14836 the incoming message is rejected with a temporary error if it is an SMTP
14837 message. For a non-SMTP message, the message is dropped and Exim ends with a
14838 non-zero code. The incident is logged on the main and reject logs.
14839
14840
14841
14842 .option local_sender_retain main boolean false
14843 .cindex "&'Sender:'& header line" "retaining from local submission"
14844 When a message is submitted locally (that is, not over a TCP/IP connection) by
14845 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14846 do not want this to happen, you must set &%local_sender_retain%&, and you must
14847 also set &%local_from_check%& to be false (Exim will complain if you do not).
14848 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14849 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14850
14851
14852
14853
14854 .option localhost_number main string&!! unset
14855 .cindex "host" "locally unique number for"
14856 .cindex "message ids" "with multiple hosts"
14857 .vindex "&$localhost_number$&"
14858 Exim's message ids are normally unique only within the local host. If
14859 uniqueness among a set of hosts is required, each host must set a different
14860 value for the &%localhost_number%& option. The string is expanded immediately
14861 after reading the configuration file (so that a number can be computed from the
14862 host name, for example) and the result of the expansion must be a number in the
14863 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14864 systems). This is available in subsequent string expansions via the variable
14865 &$localhost_number$&. When &%localhost_number is set%&, the final two
14866 characters of the message id, instead of just being a fractional part of the
14867 time, are computed from the time and the local host number as described in
14868 section &<<SECTmessiden>>&.
14869
14870
14871
14872 .option log_file_path main "string list&!!" "set at compile time"
14873 .cindex "log" "file path for"
14874 This option sets the path which is used to determine the names of Exim's log
14875 files, or indicates that logging is to be to syslog, or both. It is expanded
14876 when Exim is entered, so it can, for example, contain a reference to the host
14877 name. If no specific path is set for the log files at compile or run time, they
14878 are written in a sub-directory called &_log_& in Exim's spool directory.
14879 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14880 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14881 used. If this string is fixed at your installation (contains no expansion
14882 variables) it is recommended that you do not set this option in the
14883 configuration file, but instead supply the path using LOG_FILE_PATH in
14884 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14885 early on &-- in particular, failure to read the configuration file.
14886
14887
14888 .option log_selector main string unset
14889 .cindex "log" "selectors"
14890 This option can be used to reduce or increase the number of things that Exim
14891 writes to its log files. Its argument is made up of names preceded by plus or
14892 minus characters. For example:
14893 .code
14894 log_selector = +arguments -retry_defer
14895 .endd
14896 A list of possible names and what they control is given in the chapter on
14897 logging, in section &<<SECTlogselector>>&.
14898
14899
14900 .option log_timezone main boolean false
14901 .cindex "log" "timezone for entries"
14902 .vindex "&$tod_log$&"
14903 .vindex "&$tod_zone$&"
14904 By default, the timestamps on log lines are in local time without the
14905 timezone. This means that if your timezone changes twice a year, the timestamps
14906 in log lines are ambiguous for an hour when the clocks go back. One way of
14907 avoiding this problem is to set the timezone to UTC. An alternative is to set
14908 &%log_timezone%& true. This turns on the addition of the timezone offset to
14909 timestamps in log lines. Turning on this option can add quite a lot to the size
14910 of log files because each line is extended by 6 characters. Note that the
14911 &$tod_log$& variable contains the log timestamp without the zone, but there is
14912 another variable called &$tod_zone$& that contains just the timezone offset.
14913
14914
14915 .option lookup_open_max main integer 25
14916 .cindex "too many open files"
14917 .cindex "open files, too many"
14918 .cindex "file" "too many open"
14919 .cindex "lookup" "maximum open files"
14920 .cindex "limit" "open files for lookups"
14921 This option limits the number of simultaneously open files for single-key
14922 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14923 Exim normally keeps these files open during routing, because often the same
14924 file is required several times. If the limit is reached, Exim closes the least
14925 recently used file. Note that if you are using the &'ndbm'& library, it
14926 actually opens two files for each logical DBM database, though it still counts
14927 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14928 open files"& errors with NDBM, you need to reduce the value of
14929 &%lookup_open_max%&.
14930
14931
14932 .option max_username_length main integer 0
14933 .cindex "length of login name"
14934 .cindex "user name" "maximum length"
14935 .cindex "limit" "user name length"
14936 Some operating systems are broken in that they truncate long arguments to
14937 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14938 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14939 an argument that is longer behaves as if &[getpwnam()]& failed.
14940
14941
14942 .option message_body_newlines main bool false
14943 .cindex "message body" "newlines in variables"
14944 .cindex "newline" "in message body variables"
14945 .vindex "&$message_body$&"
14946 .vindex "&$message_body_end$&"
14947 By default, newlines in the message body are replaced by spaces when setting
14948 the &$message_body$& and &$message_body_end$& expansion variables. If this
14949 option is set true, this no longer happens.
14950
14951
14952 .option message_body_visible main integer 500
14953 .cindex "body of message" "visible size"
14954 .cindex "message body" "visible size"
14955 .vindex "&$message_body$&"
14956 .vindex "&$message_body_end$&"
14957 This option specifies how much of a message's body is to be included in the
14958 &$message_body$& and &$message_body_end$& expansion variables.
14959
14960
14961 .option message_id_header_domain main string&!! unset
14962 .cindex "&'Message-ID:'& header line"
14963 If this option is set, the string is expanded and used as the right hand side
14964 (domain) of the &'Message-ID:'& header that Exim creates if a
14965 locally-originated incoming message does not have one. &"Locally-originated"&
14966 means &"not received over TCP/IP."&
14967 Otherwise, the primary host name is used.
14968 Only letters, digits, dot and hyphen are accepted; any other characters are
14969 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14970 empty string, the option is ignored.
14971
14972
14973 .option message_id_header_text main string&!! unset
14974 If this variable is set, the string is expanded and used to augment the text of
14975 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14976 message does not have one. The text of this header is required by RFC 2822 to
14977 take the form of an address. By default, Exim uses its internal message id as
14978 the local part, and the primary host name as the domain. If this option is set,
14979 it is expanded, and provided the expansion is not forced to fail, and does not
14980 yield an empty string, the result is inserted into the header immediately
14981 before the @, separated from the internal message id by a dot. Any characters
14982 that are illegal in an address are automatically converted into hyphens. This
14983 means that variables such as &$tod_log$& can be used, because the spaces and
14984 colons will become hyphens.
14985
14986
14987 .option message_logs main boolean true
14988 .cindex "message logs" "disabling"
14989 .cindex "log" "message log; disabling"
14990 If this option is turned off, per-message log files are not created in the
14991 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14992 Exim, by reducing the number of files involved in handling a message from a
14993 minimum of four (header spool file, body spool file, delivery journal, and
14994 per-message log) to three. The other major I/O activity is Exim's main log,
14995 which is not affected by this option.
14996
14997
14998 .option message_size_limit main string&!! 50M
14999 .cindex "message" "size limit"
15000 .cindex "limit" "message size"
15001 .cindex "size" "of message, limit"
15002 This option limits the maximum size of message that Exim will process. The
15003 value is expanded for each incoming connection so, for example, it can be made
15004 to depend on the IP address of the remote host for messages arriving via
15005 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15006 optionally followed by K or M.
15007
15008 &*Note*&: This limit cannot be made to depend on a message's sender or any
15009 other properties of an individual message, because it has to be advertised in
15010 the server's response to EHLO. String expansion failure causes a temporary
15011 error. A value of zero means no limit, but its use is not recommended. See also
15012 &%bounce_return_size_limit%&.
15013
15014 Incoming SMTP messages are failed with a 552 error if the limit is
15015 exceeded; locally-generated messages either get a stderr message or a delivery
15016 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15017 an oversized message is logged in both the main and the reject logs. See also
15018 the generic transport option &%message_size_limit%&, which limits the size of
15019 message that an individual transport can process.
15020
15021 If you use a virus-scanner and set this option to to a value larger than the
15022 maximum size that your virus-scanner is configured to support, you may get
15023 failures triggered by large mails.  The right size to configure for the
15024 virus-scanner depends upon what data is passed and the options in use but it's
15025 probably safest to just set it to a little larger than this value.  Eg, with a
15026 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15027 some problems may result.
15028
15029 A value of 0 will disable size limit checking; Exim will still advertise the
15030 SIZE extension in an EHLO response, but without a limit, so as to permit
15031 SMTP clients to still indicate the message size along with the MAIL verb.
15032
15033
15034 .option move_frozen_messages main boolean false
15035 .cindex "frozen messages" "moving"
15036 This option, which is available only if Exim has been built with the setting
15037 .code
15038 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15039 .endd
15040 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15041 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15042 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15043 standard utilities for handling such moved messages, and they do not show up in
15044 lists generated by &%-bp%& or by the Exim monitor.
15045
15046
15047 .option mua_wrapper main boolean false
15048 Setting this option true causes Exim to run in a very restrictive mode in which
15049 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15050 contains a full description of this facility.
15051
15052
15053
15054 .option mysql_servers main "string list" unset
15055 .cindex "MySQL" "server list"
15056 This option provides a list of MySQL servers and associated connection data, to
15057 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15058 option is available only if Exim has been built with MySQL support.
15059
15060
15061 .option never_users main "string list&!!" unset
15062 This option is expanded just once, at the start of Exim's processing. Local
15063 message deliveries are normally run in processes that are setuid to the
15064 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15065 It is usually desirable to prevent any deliveries from running as root, as a
15066 safety precaution.
15067
15068 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15069 list of users that must not be used for local deliveries. This list is fixed in
15070 the binary and cannot be overridden by the configuration file. By default, it
15071 contains just the single user name &"root"&. The &%never_users%& runtime option
15072 can be used to add more users to the fixed list.
15073
15074 If a message is to be delivered as one of the users on the fixed list or the
15075 &%never_users%& list, an error occurs, and delivery is deferred. A common
15076 example is
15077 .code
15078 never_users = root:daemon:bin
15079 .endd
15080 Including root is redundant if it is also on the fixed list, but it does no
15081 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15082 transport driver.
15083
15084
15085 .option openssl_options main "string list" "+no_sslv2"
15086 .cindex "OpenSSL "compatibility options"
15087 This option allows an administrator to adjust the SSL options applied
15088 by OpenSSL to connections.  It is given as a space-separated list of items,
15089 each one to be +added or -subtracted from the current value.
15090
15091 This option is only available if Exim is built against OpenSSL.  The values
15092 available for this option vary according to the age of your OpenSSL install.
15093 The &"all"& value controls a subset of flags which are available, typically
15094 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15095 list the values known on your system and Exim should support all the
15096 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15097 names lose the leading &"SSL_OP_"& and are lower-cased.
15098
15099 Note that adjusting the options can have severe impact upon the security of
15100 SSL as used by Exim.  It is possible to disable safety checks and shoot
15101 yourself in the foot in various unpleasant ways.  This option should not be
15102 adjusted lightly.  An unrecognised item will be detected at startup, by
15103 invoking Exim with the &%-bV%& flag.
15104
15105 The option affects Exim operating both as a server and as a client.
15106
15107 Historical note: prior to release 4.80, Exim defaulted this value to
15108 "+dont_insert_empty_fragments", which may still be needed for compatibility
15109 with some clients, but which lowers security by increasing exposure to
15110 some now infamous attacks.
15111
15112 Examples:
15113 .code
15114 # Make both old MS and old Eudora happy:
15115 openssl_options = -all +microsoft_big_sslv3_buffer \
15116                        +dont_insert_empty_fragments
15117
15118 # Disable older protocol versions:
15119 openssl_options = +no_sslv2 +no_sslv3
15120 .endd
15121
15122 Possible options may include:
15123 .ilist
15124 &`all`&
15125 .next
15126 &`allow_unsafe_legacy_renegotiation`&
15127 .next
15128 &`cipher_server_preference`&
15129 .next
15130 &`dont_insert_empty_fragments`&
15131 .next
15132 &`ephemeral_rsa`&
15133 .next
15134 &`legacy_server_connect`&
15135 .next
15136 &`microsoft_big_sslv3_buffer`&
15137 .next
15138 &`microsoft_sess_id_bug`&
15139 .next
15140 &`msie_sslv2_rsa_padding`&
15141 .next
15142 &`netscape_challenge_bug`&
15143 .next
15144 &`netscape_reuse_cipher_change_bug`&
15145 .next
15146 &`no_compression`&
15147 .next
15148 &`no_session_resumption_on_renegotiation`&
15149 .next
15150 &`no_sslv2`&
15151 .next
15152 &`no_sslv3`&
15153 .next
15154 &`no_ticket`&
15155 .next
15156 &`no_tlsv1`&
15157 .next
15158 &`no_tlsv1_1`&
15159 .next
15160 &`no_tlsv1_2`&
15161 .next
15162 &`safari_ecdhe_ecdsa_bug`&
15163 .next
15164 &`single_dh_use`&
15165 .next
15166 &`single_ecdh_use`&
15167 .next
15168 &`ssleay_080_client_dh_bug`&
15169 .next
15170 &`sslref2_reuse_cert_type_bug`&
15171 .next
15172 &`tls_block_padding_bug`&
15173 .next
15174 &`tls_d5_bug`&
15175 .next
15176 &`tls_rollback_bug`&
15177 .endlist
15178
15179 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15180 all clients connecting using the MacOS SecureTransport TLS facility prior
15181 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15182 to negotiate TLS then this option value might help, provided that your OpenSSL
15183 release is new enough to contain this work-around.  This may be a situation
15184 where you have to upgrade OpenSSL to get buggy clients working.
15185
15186
15187 .option oracle_servers main "string list" unset
15188 .cindex "Oracle" "server list"
15189 This option provides a list of Oracle servers and associated connection data,
15190 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15191 The option is available only if Exim has been built with Oracle support.
15192
15193
15194 .option percent_hack_domains main "domain list&!!" unset
15195 .cindex "&""percent hack""&"
15196 .cindex "source routing" "in email address"
15197 .cindex "address" "source-routed"
15198 The &"percent hack"& is the convention whereby a local part containing a
15199 percent sign is re-interpreted as a new email address, with the percent
15200 replaced by @. This is sometimes called &"source routing"&, though that term is
15201 also applied to RFC 2822 addresses that begin with an @ character. If this
15202 option is set, Exim implements the percent facility for those domains listed,
15203 but no others. This happens before an incoming SMTP address is tested against
15204 an ACL.
15205
15206 &*Warning*&: The &"percent hack"& has often been abused by people who are
15207 trying to get round relaying restrictions. For this reason, it is best avoided
15208 if at all possible. Unfortunately, a number of less security-conscious MTAs
15209 implement it unconditionally. If you are running Exim on a gateway host, and
15210 routing mail through to internal MTAs without processing the local parts, it is
15211 a good idea to reject recipient addresses with percent characters in their
15212 local parts. Exim's default configuration does this.
15213
15214
15215 .option perl_at_start main boolean false
15216 This option is available only when Exim is built with an embedded Perl
15217 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15218
15219
15220 .option perl_startup main string unset
15221 This option is available only when Exim is built with an embedded Perl
15222 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15223
15224
15225 .option pgsql_servers main "string list" unset
15226 .cindex "PostgreSQL lookup type" "server list"
15227 This option provides a list of PostgreSQL servers and associated connection
15228 data, to be used in conjunction with &(pgsql)& lookups (see section
15229 &<<SECID72>>&). The option is available only if Exim has been built with
15230 PostgreSQL support.
15231
15232
15233 .option pid_file_path main string&!! "set at compile time"
15234 .cindex "daemon" "pid file path"
15235 .cindex "pid file, path for"
15236 This option sets the name of the file to which the Exim daemon writes its
15237 process id. The string is expanded, so it can contain, for example, references
15238 to the host name:
15239 .code
15240 pid_file_path = /var/log/$primary_hostname/exim.pid
15241 .endd
15242 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15243 spool directory.
15244 The value set by the option can be overridden by the &%-oP%& command line
15245 option. A pid file is not written if a &"non-standard"& daemon is run by means
15246 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15247
15248
15249 .option pipelining_advertise_hosts main "host list&!!" *
15250 .cindex "PIPELINING" "suppressing advertising"
15251 This option can be used to suppress the advertisement of the SMTP
15252 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15253 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15254 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15255 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15256 that clients will use it; &"out of order"& commands that are &"expected"& do
15257 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15258
15259
15260 .option prdr_enable main boolean false
15261 .cindex "PRDR" "enabling on server"
15262 This option can be used to enable the Per-Recipient Data Response extension
15263 to SMTP, defined by Eric Hall.
15264 If the option is set, PRDR is advertised by Exim when operating as a server.
15265 If the client requests PRDR, and more than one recipient, for a message 
15266 an additional ACL is called for each recipient after the message content
15267 is recieved.  See section &<<SECTPRDRACL>>&.
15268
15269 .option preserve_message_logs main boolean false
15270 .cindex "message logs" "preserving"
15271 If this option is set, message log files are not deleted when messages are
15272 completed. Instead, they are moved to a sub-directory of the spool directory
15273 called &_msglog.OLD_&, where they remain available for statistical or debugging
15274 purposes. This is a dangerous option to set on systems with any appreciable
15275 volume of mail. Use with care!
15276
15277
15278 .option primary_hostname main string "see below"
15279 .cindex "name" "of local host"
15280 .cindex "host" "name of local"
15281 .cindex "local host" "name of"
15282 .vindex "&$primary_hostname$&"
15283 This specifies the name of the current host. It is used in the default EHLO or
15284 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15285 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15286 The value is also used by default in some SMTP response messages from an Exim
15287 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15288
15289 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15290 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15291 contains only one component, Exim passes it to &[gethostbyname()]& (or
15292 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15293 version. The variable &$primary_hostname$& contains the host name, whether set
15294 explicitly by this option, or defaulted.
15295
15296
15297 .option print_topbitchars main boolean false
15298 .cindex "printing characters"
15299 .cindex "8-bit characters"
15300 By default, Exim considers only those characters whose codes lie in the range
15301 32&--126 to be printing characters. In a number of circumstances (for example,
15302 when writing log entries) non-printing characters are converted into escape
15303 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15304 is set, code values of 128 and above are also considered to be printing
15305 characters.
15306
15307 This option also affects the header syntax checks performed by the
15308 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15309 the user's full name when constructing From: and Sender: addresses (as
15310 described in section &<<SECTconstr>>&). Setting this option can cause
15311 Exim to generate eight bit message headers that do not conform to the
15312 standards.
15313
15314
15315 .option process_log_path main string unset
15316 .cindex "process log path"
15317 .cindex "log" "process log"
15318 .cindex "&'exiwhat'&"
15319 This option sets the name of the file to which an Exim process writes its
15320 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15321 utility script. If this option is unset, the file called &_exim-process.info_&
15322 in Exim's spool directory is used. The ability to specify the name explicitly
15323 can be useful in environments where two different Exims are running, using
15324 different spool directories.
15325
15326
15327 .option prod_requires_admin main boolean true
15328 .oindex "&%-M%&"
15329 .oindex "&%-R%&"
15330 .oindex "&%-q%&"
15331 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15332 admin user unless &%prod_requires_admin%& is set false. See also
15333 &%queue_list_requires_admin%&.
15334
15335
15336 .option qualify_domain main string "see below"
15337 .cindex "domain" "for qualifying addresses"
15338 .cindex "address" "qualification"
15339 This option specifies the domain name that is added to any envelope sender
15340 addresses that do not have a domain qualification. It also applies to
15341 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15342 are accepted by default only for locally-generated messages. Qualification is
15343 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15344 locally-generated messages, unless the &%-bnq%& command line option is used.
15345
15346 Messages from external sources must always contain fully qualified addresses,
15347 unless the sending host matches &%sender_unqualified_hosts%& or
15348 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15349 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15350 necessary. Internally, Exim always works with fully qualified envelope
15351 addresses. If &%qualify_domain%& is not set, it defaults to the
15352 &%primary_hostname%& value.
15353
15354
15355 .option qualify_recipient main string "see below"
15356 This option allows you to specify a different domain for qualifying recipient
15357 addresses to the one that is used for senders. See &%qualify_domain%& above.
15358
15359
15360
15361 .option queue_domains main "domain list&!!" unset
15362 .cindex "domain" "specifying non-immediate delivery"
15363 .cindex "queueing incoming messages"
15364 .cindex "message" "queueing certain domains"
15365 This option lists domains for which immediate delivery is not required.
15366 A delivery process is started whenever a message is received, but only those
15367 domains that do not match are processed. All other deliveries wait until the
15368 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15369
15370
15371 .option queue_list_requires_admin main boolean true
15372 .oindex "&%-bp%&"
15373 The &%-bp%& command-line option, which lists the messages that are on the
15374 queue, requires the caller to be an admin user unless
15375 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15376
15377
15378 .option queue_only main boolean false
15379 .cindex "queueing incoming messages"
15380 .cindex "message" "queueing unconditionally"
15381 If &%queue_only%& is set, a delivery process is not automatically started
15382 whenever a message is received. Instead, the message waits on the queue for the
15383 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15384 delivered immediately when certain conditions (such as heavy load) occur.
15385
15386 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15387 and &%-odi%& command line options override &%queue_only%& unless
15388 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15389 &%queue_only_load%&, and &%smtp_accept_queue%&.
15390
15391
15392 .option queue_only_file main string unset
15393 .cindex "queueing incoming messages"
15394 .cindex "message" "queueing by file existence"
15395 This option can be set to a colon-separated list of absolute path names, each
15396 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15397 it tests for the existence of each listed path using a call to &[stat()]&. For
15398 each path that exists, the corresponding queueing option is set.
15399 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15400 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15401 .code
15402 queue_only_file = smtp/some/file
15403 .endd
15404 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15405 &_/some/file_& exists.
15406
15407
15408 .option queue_only_load main fixed-point unset
15409 .cindex "load average"
15410 .cindex "queueing incoming messages"
15411 .cindex "message" "queueing by load"
15412 If the system load average is higher than this value, incoming messages from
15413 all sources are queued, and no automatic deliveries are started. If this
15414 happens during local or remote SMTP input, all subsequent messages received on
15415 the same SMTP connection are queued by default, whatever happens to the load in
15416 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15417 false.
15418
15419 Deliveries will subsequently be performed by queue runner processes. This
15420 option has no effect on ancient operating systems on which Exim cannot
15421 determine the load average. See also &%deliver_queue_load_max%& and
15422 &%smtp_load_reserve%&.
15423
15424
15425 .option queue_only_load_latch main boolean true
15426 .cindex "load average" "re-evaluating per message"
15427 When this option is true (the default), once one message has been queued
15428 because the load average is higher than the value set by &%queue_only_load%&,
15429 all subsequent messages received on the same SMTP connection are also queued.
15430 This is a deliberate choice; even though the load average may fall below the
15431 threshold, it doesn't seem right to deliver later messages on the same
15432 connection when not delivering earlier ones. However, there are special
15433 circumstances such as very long-lived connections from scanning appliances
15434 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15435 should be set false. This causes the value of the load average to be
15436 re-evaluated for each message.
15437
15438
15439 .option queue_only_override main boolean true
15440 .cindex "queueing incoming messages"
15441 When this option is true, the &%-od%&&'x'& command line options override the
15442 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15443 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15444 to override; they are accepted, but ignored.
15445
15446
15447 .option queue_run_in_order main boolean false
15448 .cindex "queue runner" "processing messages in order"
15449 If this option is set, queue runs happen in order of message arrival instead of
15450 in an arbitrary order. For this to happen, a complete list of the entire queue
15451 must be set up before the deliveries start. When the queue is all held in a
15452 single directory (the default), a single list is created for both the ordered
15453 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15454 single list is not created when &%queue_run_in_order%& is false. In this case,
15455 the sub-directories are processed one at a time (in a random order), and this
15456 avoids setting up one huge list for the whole queue. Thus, setting
15457 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15458 when the queue is large, because of the extra work in setting up the single,
15459 large list. In most situations, &%queue_run_in_order%& should not be set.
15460
15461
15462
15463 .option queue_run_max main integer 5
15464 .cindex "queue runner" "maximum number of"
15465 This controls the maximum number of queue runner processes that an Exim daemon
15466 can run simultaneously. This does not mean that it starts them all at once,
15467 but rather that if the maximum number are still running when the time comes to
15468 start another one, it refrains from starting another one. This can happen with
15469 very large queues and/or very sluggish deliveries. This option does not,
15470 however, interlock with other processes, so additional queue runners can be
15471 started by other means, or by killing and restarting the daemon.
15472
15473 Setting this option to zero does not suppress queue runs; rather, it disables
15474 the limit, allowing any number of simultaneous queue runner processes to be
15475 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15476 the daemon's command line.
15477
15478 .option queue_smtp_domains main "domain list&!!" unset
15479 .cindex "queueing incoming messages"
15480 .cindex "message" "queueing remote deliveries"
15481 When this option is set, a delivery process is started whenever a message is
15482 received, routing is performed, and local deliveries take place.
15483 However, if any SMTP deliveries are required for domains that match
15484 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15485 message waits on the queue for the next queue run. Since routing of the message
15486 has taken place, Exim knows to which remote hosts it must be delivered, and so
15487 when the queue run happens, multiple messages for the same host are delivered
15488 over a single SMTP connection. The &%-odqs%& command line option causes all
15489 SMTP deliveries to be queued in this way, and is equivalent to setting
15490 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15491 &%queue_domains%&.
15492
15493
15494 .option receive_timeout main time 0s
15495 .cindex "timeout" "for non-SMTP input"
15496 This option sets the timeout for accepting a non-SMTP message, that is, the
15497 maximum time that Exim waits when reading a message on the standard input. If
15498 the value is zero, it will wait for ever. This setting is overridden by the
15499 &%-or%& command line option. The timeout for incoming SMTP messages is
15500 controlled by &%smtp_receive_timeout%&.
15501
15502 .option received_header_text main string&!! "see below"
15503 .cindex "customizing" "&'Received:'& header"
15504 .cindex "&'Received:'& header line" "customizing"
15505 This string defines the contents of the &'Received:'& message header that is
15506 added to each message, except for the timestamp, which is automatically added
15507 on at the end (preceded by a semicolon). The string is expanded each time it is
15508 used. If the expansion yields an empty string, no &'Received:'& header line is
15509 added to the message. Otherwise, the string should start with the text
15510 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15511 header lines. The default setting is:
15512
15513 .code
15514 received_header_text = Received: \
15515   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15516   {${if def:sender_ident \
15517   {from ${quote_local_part:$sender_ident} }}\
15518   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15519   by $primary_hostname \
15520   ${if def:received_protocol {with $received_protocol}} \
15521   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15522   (Exim $version_number)\n\t\
15523   ${if def:sender_address \
15524   {(envelope-from <$sender_address>)\n\t}}\
15525   id $message_exim_id\
15526   ${if def:received_for {\n\tfor $received_for}}
15527 .endd
15528
15529 The reference to the TLS cipher is omitted when Exim is built without TLS
15530 support. The use of conditional expansions ensures that this works for both
15531 locally generated messages and messages received from remote hosts, giving
15532 header lines such as the following:
15533 .code
15534 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15535 by marley.carol.example with esmtp (Exim 4.00)
15536 (envelope-from <bob@carol.example>)
15537 id 16IOWa-00019l-00
15538 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15539 Received: by scrooge.carol.example with local (Exim 4.00)
15540 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15541 .endd
15542 Until the body of the message has been received, the timestamp is the time when
15543 the message started to be received. Once the body has arrived, and all policy
15544 checks have taken place, the timestamp is updated to the time at which the
15545 message was accepted.
15546
15547
15548 .option received_headers_max main integer 30
15549 .cindex "loop" "prevention"
15550 .cindex "mail loop prevention"
15551 .cindex "&'Received:'& header line" "counting"
15552 When a message is to be delivered, the number of &'Received:'& headers is
15553 counted, and if it is greater than this parameter, a mail loop is assumed to
15554 have occurred, the delivery is abandoned, and an error message is generated.
15555 This applies to both local and remote deliveries.
15556
15557
15558 .option recipient_unqualified_hosts main "host list&!!" unset
15559 .cindex "unqualified addresses"
15560 .cindex "host" "unqualified addresses from"
15561 This option lists those hosts from which Exim is prepared to accept unqualified
15562 recipient addresses in message envelopes. The addresses are made fully
15563 qualified by the addition of the &%qualify_recipient%& value. This option also
15564 affects message header lines. Exim does not reject unqualified recipient
15565 addresses in headers, but it qualifies them only if the message came from a
15566 host that matches &%recipient_unqualified_hosts%&,
15567 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15568 option was not set.
15569
15570
15571 .option recipients_max main integer 0
15572 .cindex "limit" "number of recipients"
15573 .cindex "recipient" "maximum number"
15574 If this option is set greater than zero, it specifies the maximum number of
15575 original recipients for any message. Additional recipients that are generated
15576 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15577 all recipients over the limit; earlier recipients are delivered as normal.
15578 Non-SMTP messages with too many recipients are failed, and no deliveries are
15579 done.
15580
15581 .cindex "RCPT" "maximum number of incoming"
15582 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15583 RCPT commands in a single message.
15584
15585
15586 .option recipients_max_reject main boolean false
15587 If this option is set true, Exim rejects SMTP messages containing too many
15588 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15589 error to the eventual DATA command. Otherwise (the default) it gives a 452
15590 error to the surplus RCPT commands and accepts the message on behalf of the
15591 initial set of recipients. The remote server should then re-send the message
15592 for the remaining recipients at a later time.
15593
15594
15595 .option remote_max_parallel main integer 2
15596 .cindex "delivery" "parallelism for remote"
15597 This option controls parallel delivery of one message to a number of remote
15598 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15599 does all the remote deliveries for a message one by one. Otherwise, if a single
15600 message has to be delivered to more than one remote host, or if several copies
15601 have to be sent to the same remote host, up to &%remote_max_parallel%&
15602 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15603 deliveries are required, the maximum number of processes are started, and as
15604 each one finishes, another is begun. The order of starting processes is the
15605 same as if sequential delivery were being done, and can be controlled by the
15606 &%remote_sort_domains%& option. If parallel delivery takes place while running
15607 with debugging turned on, the debugging output from each delivery process is
15608 tagged with its process id.
15609
15610 This option controls only the maximum number of parallel deliveries for one
15611 message in one Exim delivery process. Because Exim has no central queue
15612 manager, there is no way of controlling the total number of simultaneous
15613 deliveries if the configuration allows a delivery attempt as soon as a message
15614 is received.
15615
15616 .cindex "number of deliveries"
15617 .cindex "delivery" "maximum number of"
15618 If you want to control the total number of deliveries on the system, you
15619 need to set the &%queue_only%& option. This ensures that all incoming messages
15620 are added to the queue without starting a delivery process. Then set up an Exim
15621 daemon to start queue runner processes at appropriate intervals (probably
15622 fairly often, for example, every minute), and limit the total number of queue
15623 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15624 delivers only one message at a time, the maximum number of deliveries that can
15625 then take place at once is &%queue_run_max%& multiplied by
15626 &%remote_max_parallel%&.
15627
15628 If it is purely remote deliveries you want to control, use
15629 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15630 doing the SMTP routing before queueing, so that several messages for the same
15631 host will eventually get delivered down the same connection.
15632
15633
15634 .option remote_sort_domains main "domain list&!!" unset
15635 .cindex "sorting remote deliveries"
15636 .cindex "delivery" "sorting remote"
15637 When there are a number of remote deliveries for a message, they are sorted by
15638 domain into the order given by this list. For example,
15639 .code
15640 remote_sort_domains = *.cam.ac.uk:*.uk
15641 .endd
15642 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15643 then to those in the &%uk%& domain, then to any others.
15644
15645
15646 .option retry_data_expire main time 7d
15647 .cindex "hints database" "data expiry"
15648 This option sets a &"use before"& time on retry information in Exim's hints
15649 database. Any older retry data is ignored. This means that, for example, once a
15650 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15651 past failures.
15652
15653
15654 .option retry_interval_max main time 24h
15655 .cindex "retry" "limit on interval"
15656 .cindex "limit" "on retry interval"
15657 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15658 intervals between delivery attempts for messages that cannot be delivered
15659 straight away. This option sets an overall limit to the length of time between
15660 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15661 the default value.
15662
15663
15664 .option return_path_remove main boolean true
15665 .cindex "&'Return-path:'& header line" "removing"
15666 RFC 2821, section 4.4, states that an SMTP server must insert a
15667 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15668 The &'Return-path:'& header preserves the sender address as received in the
15669 MAIL command. This description implies that this header should not be present
15670 in an incoming message. If &%return_path_remove%& is true, any existing
15671 &'Return-path:'& headers are removed from messages at the time they are
15672 received. Exim's transports have options for adding &'Return-path:'& headers at
15673 the time of delivery. They are normally used only for final local deliveries.
15674
15675
15676 .option return_size_limit main integer 100K
15677 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15678
15679
15680 .option rfc1413_hosts main "host list&!!" @[]
15681 .cindex "RFC 1413"
15682 .cindex "host" "for RFC 1413 calls"
15683 RFC 1413 identification calls are made to any client host which matches
15684 an item in the list.
15685 The default value specifies just this host, being any local interface
15686 for the system.
15687
15688 .option rfc1413_query_timeout main time 0s
15689 .cindex "RFC 1413" "query timeout"
15690 .cindex "timeout" "for RFC 1413 call"
15691 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15692 no RFC 1413 calls are ever made.
15693
15694
15695 .option sender_unqualified_hosts main "host list&!!" unset
15696 .cindex "unqualified addresses"
15697 .cindex "host" "unqualified addresses from"
15698 This option lists those hosts from which Exim is prepared to accept unqualified
15699 sender addresses. The addresses are made fully qualified by the addition of
15700 &%qualify_domain%&. This option also affects message header lines. Exim does
15701 not reject unqualified addresses in headers that contain sender addresses, but
15702 it qualifies them only if the message came from a host that matches
15703 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15704 using TCP/IP), and the &%-bnq%& option was not set.
15705
15706
15707 .option smtp_accept_keepalive main boolean true
15708 .cindex "keepalive" "on incoming connection"
15709 This option controls the setting of the SO_KEEPALIVE option on incoming
15710 TCP/IP socket connections. When set, it causes the kernel to probe idle
15711 connections periodically, by sending packets with &"old"& sequence numbers. The
15712 other end of the connection should send an acknowledgment if the connection is
15713 still okay or a reset if the connection has been aborted. The reason for doing
15714 this is that it has the beneficial effect of freeing up certain types of
15715 connection that can get stuck when the remote host is disconnected without
15716 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15717 hours to detect unreachable hosts.
15718
15719
15720
15721 .option smtp_accept_max main integer 20
15722 .cindex "limit" "incoming SMTP connections"
15723 .cindex "SMTP" "incoming connection count"
15724 .cindex "inetd"
15725 This option specifies the maximum number of simultaneous incoming SMTP calls
15726 that Exim will accept. It applies only to the listening daemon; there is no
15727 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15728 value is set to zero, no limit is applied. However, it is required to be
15729 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15730 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15731
15732 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15733 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15734 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15735 and &%smtp_load_reserve%& are then checked before accepting the connection.
15736
15737
15738 .option smtp_accept_max_nonmail main integer 10
15739 .cindex "limit" "non-mail SMTP commands"
15740 .cindex "SMTP" "limiting non-mail commands"
15741 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15742 the connection if there are too many. This option defines &"too many"&. The
15743 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15744 client looping sending EHLO, for example. The check is applied only if the
15745 client host matches &%smtp_accept_max_nonmail_hosts%&.
15746
15747 When a new message is expected, one occurrence of RSET is not counted. This
15748 allows a client to send one RSET between messages (this is not necessary,
15749 but some clients do it). Exim also allows one uncounted occurrence of HELO
15750 or EHLO, and one occurrence of STARTTLS between messages. After
15751 starting up a TLS session, another EHLO is expected, and so it too is not
15752 counted. The first occurrence of AUTH in a connection, or immediately
15753 following STARTTLS is not counted. Otherwise, all commands other than
15754 MAIL, RCPT, DATA, and QUIT are counted.
15755
15756
15757 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15758 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15759 check by setting this option. The default value makes it apply to all hosts. By
15760 changing the value, you can exclude any badly-behaved hosts that you have to
15761 live with.
15762
15763
15764 . Allow this long option name to split; give it unsplit as a fifth argument
15765 . for the automatic .oindex that is generated by .option.
15766 . We insert " &~&~" which is both pretty nasty visually and results in
15767 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15768 . zero-width-space, which would be nicer visually and results in (at least)
15769 . html that Firefox will split on when it's forced to reflow (rather than
15770 . inserting a horizontal scrollbar).  However, the text is still not
15771 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15772 . the option name to split.
15773
15774 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15775          smtp_accept_max_per_connection
15776 .cindex "SMTP" "limiting incoming message count"
15777 .cindex "limit" "messages per SMTP connection"
15778 The value of this option limits the number of MAIL commands that Exim is
15779 prepared to accept over a single SMTP connection, whether or not each command
15780 results in the transfer of a message. After the limit is reached, a 421
15781 response is given to subsequent MAIL commands. This limit is a safety
15782 precaution against a client that goes mad (incidents of this type have been
15783 seen).
15784
15785
15786 .option smtp_accept_max_per_host main string&!! unset
15787 .cindex "limit" "SMTP connections from one host"
15788 .cindex "host" "limiting SMTP connections from"
15789 This option restricts the number of simultaneous IP connections from a single
15790 host (strictly, from a single IP address) to the Exim daemon. The option is
15791 expanded, to enable different limits to be applied to different hosts by
15792 reference to &$sender_host_address$&. Once the limit is reached, additional
15793 connection attempts from the same host are rejected with error code 421. This
15794 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15795 of zero imposes no limit. If this option is set greater than zero, it is
15796 required that &%smtp_accept_max%& be non-zero.
15797
15798 &*Warning*&: When setting this option you should not use any expansion
15799 constructions that take an appreciable amount of time. The expansion and test
15800 happen in the main daemon loop, in order to reject additional connections
15801 without forking additional processes (otherwise a denial-of-service attack
15802 could cause a vast number or processes to be created). While the daemon is
15803 doing this processing, it cannot accept any other incoming connections.
15804
15805
15806
15807 .option smtp_accept_queue main integer 0
15808 .cindex "SMTP" "incoming connection count"
15809 .cindex "queueing incoming messages"
15810 .cindex "message" "queueing by SMTP connection count"
15811 If the number of simultaneous incoming SMTP connections being handled via the
15812 listening daemon exceeds this value, messages received by SMTP are just placed
15813 on the queue; no delivery processes are started automatically. The count is
15814 fixed at the start of an SMTP connection. It cannot be updated in the
15815 subprocess that receives messages, and so the queueing or not queueing applies
15816 to all messages received in the same connection.
15817
15818 A value of zero implies no limit, and clearly any non-zero value is useful only
15819 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15820 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15821 various &%-od%&&'x'& command line options.
15822
15823
15824 . See the comment on smtp_accept_max_per_connection
15825
15826 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15827          smtp_accept_queue_per_connection
15828 .cindex "queueing incoming messages"
15829 .cindex "message" "queueing by message count"
15830 This option limits the number of delivery processes that Exim starts
15831 automatically when receiving messages via SMTP, whether via the daemon or by
15832 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15833 and the number of messages received in a single SMTP session exceeds this
15834 number, subsequent messages are placed on the queue, but no delivery processes
15835 are started. This helps to limit the number of Exim processes when a server
15836 restarts after downtime and there is a lot of mail waiting for it on other
15837 systems. On large systems, the default should probably be increased, and on
15838 dial-in client systems it should probably be set to zero (that is, disabled).
15839
15840
15841 .option smtp_accept_reserve main integer 0
15842 .cindex "SMTP" "incoming call count"
15843 .cindex "host" "reserved"
15844 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15845 number of SMTP connections that are reserved for connections from the hosts
15846 that are specified in &%smtp_reserve_hosts%&. The value set in
15847 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15848 restricted to this number of connections; the option specifies a minimum number
15849 of connection slots for them, not a maximum. It is a guarantee that this group
15850 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15851 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15852 individual host.
15853
15854 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15855 set to 5, once there are 45 active connections (from any hosts), new
15856 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15857 provided the other criteria for acceptance are met.
15858
15859
15860 .option smtp_active_hostname main string&!! unset
15861 .cindex "host" "name in SMTP responses"
15862 .cindex "SMTP" "host name in responses"
15863 .vindex "&$primary_hostname$&"
15864 This option is provided for multi-homed servers that want to masquerade as
15865 several different hosts. At the start of an incoming SMTP connection, its value
15866 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15867 responses. For example, it is used as domain name in the response to an
15868 incoming HELO or EHLO command.
15869
15870 .vindex "&$smtp_active_hostname$&"
15871 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15872 is saved with any messages that are received. It is therefore available for use
15873 in routers and transports when the message is later delivered.
15874
15875 If this option is unset, or if its expansion is forced to fail, or if the
15876 expansion results in an empty string, the value of &$primary_hostname$& is
15877 used. Other expansion failures cause a message to be written to the main and
15878 panic logs, and the SMTP command receives a temporary error. Typically, the
15879 value of &%smtp_active_hostname%& depends on the incoming interface address.
15880 For example:
15881 .code
15882 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15883   {cox.mydomain}{box.mydomain}}
15884 .endd
15885
15886 Although &$smtp_active_hostname$& is primarily concerned with incoming
15887 messages, it is also used as the default for HELO commands in callout
15888 verification if there is no remote transport from which to obtain a
15889 &%helo_data%& value.
15890
15891 .option smtp_banner main string&!! "see below"
15892 .cindex "SMTP" "welcome banner"
15893 .cindex "banner for SMTP"
15894 .cindex "welcome banner for SMTP"
15895 .cindex "customizing" "SMTP banner"
15896 This string, which is expanded every time it is used, is output as the initial
15897 positive response to an SMTP connection. The default setting is:
15898 .code
15899 smtp_banner = $smtp_active_hostname ESMTP Exim \
15900   $version_number $tod_full
15901 .endd
15902 Failure to expand the string causes a panic error. If you want to create a
15903 multiline response to the initial SMTP connection, use &"\n"& in the string at
15904 appropriate points, but not at the end. Note that the 220 code is not included
15905 in this string. Exim adds it automatically (several times in the case of a
15906 multiline response).
15907
15908
15909 .option smtp_check_spool_space main boolean true
15910 .cindex "checking disk space"
15911 .cindex "disk space, checking"
15912 .cindex "spool directory" "checking space"
15913 When this option is set, if an incoming SMTP session encounters the SIZE
15914 option on a MAIL command, it checks that there is enough space in the
15915 spool directory's partition to accept a message of that size, while still
15916 leaving free the amount specified by &%check_spool_space%& (even if that value
15917 is zero). If there isn't enough space, a temporary error code is returned.
15918
15919
15920 .option smtp_connect_backlog main integer 20
15921 .cindex "connection backlog"
15922 .cindex "SMTP" "connection backlog"
15923 .cindex "backlog of connections"
15924 This option specifies a maximum number of waiting SMTP connections. Exim passes
15925 this value to the TCP/IP system when it sets up its listener. Once this number
15926 of connections are waiting for the daemon's attention, subsequent connection
15927 attempts are refused at the TCP/IP level. At least, that is what the manuals
15928 say; in some circumstances such connection attempts have been observed to time
15929 out instead. For large systems it is probably a good idea to increase the
15930 value (to 50, say). It also gives some protection against denial-of-service
15931 attacks by SYN flooding.
15932
15933
15934 .option smtp_enforce_sync main boolean true
15935 .cindex "SMTP" "synchronization checking"
15936 .cindex "synchronization checking in SMTP"
15937 The SMTP protocol specification requires the client to wait for a response from
15938 the server at certain points in the dialogue. Without PIPELINING these
15939 synchronization points are after every command; with PIPELINING they are
15940 fewer, but they still exist.
15941
15942 Some spamming sites send out a complete set of SMTP commands without waiting
15943 for any response. Exim protects against this by rejecting a message if the
15944 client has sent further input when it should not have. The error response &"554
15945 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15946 for this error cannot be perfect because of transmission delays (unexpected
15947 input may be on its way but not yet received when Exim checks). However, it
15948 does detect many instances.
15949
15950 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15951 If you want to disable the check selectively (for example, only for certain
15952 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15953 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15954
15955
15956
15957 .option smtp_etrn_command main string&!! unset
15958 .cindex "ETRN" "command to be run"
15959 .vindex "&$domain$&"
15960 If this option is set, the given command is run whenever an SMTP ETRN
15961 command is received from a host that is permitted to issue such commands (see
15962 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15963 are independently expanded. The expansion variable &$domain$& is set to the
15964 argument of the ETRN command, and no syntax checking is done on it. For
15965 example:
15966 .code
15967 smtp_etrn_command = /etc/etrn_command $domain \
15968                     $sender_host_address
15969 .endd
15970 A new process is created to run the command, but Exim does not wait for it to
15971 complete. Consequently, its status cannot be checked. If the command cannot be
15972 run, a line is written to the panic log, but the ETRN caller still receives
15973 a 250 success response. Exim is normally running under its own uid when
15974 receiving SMTP, so it is not possible for it to change the uid before running
15975 the command.
15976
15977
15978 .option smtp_etrn_serialize main boolean true
15979 .cindex "ETRN" "serializing"
15980 When this option is set, it prevents the simultaneous execution of more than
15981 one identical command as a result of ETRN in an SMTP connection. See
15982 section &<<SECTETRN>>& for details.
15983
15984
15985 .option smtp_load_reserve main fixed-point unset
15986 .cindex "load average"
15987 If the system load average ever gets higher than this, incoming SMTP calls are
15988 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15989 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15990 the load is over the limit. The option has no effect on ancient operating
15991 systems on which Exim cannot determine the load average. See also
15992 &%deliver_queue_load_max%& and &%queue_only_load%&.
15993
15994
15995
15996 .option smtp_max_synprot_errors main integer 3
15997 .cindex "SMTP" "limiting syntax and protocol errors"
15998 .cindex "limit" "SMTP syntax and protocol errors"
15999 Exim rejects SMTP commands that contain syntax or protocol errors. In
16000 particular, a syntactically invalid email address, as in this command:
16001 .code
16002 RCPT TO:<abc xyz@a.b.c>
16003 .endd
16004 causes immediate rejection of the command, before any other tests are done.
16005 (The ACL cannot be run if there is no valid address to set up for it.) An
16006 example of a protocol error is receiving RCPT before MAIL. If there are
16007 too many syntax or protocol errors in one SMTP session, the connection is
16008 dropped. The limit is set by this option.
16009
16010 .cindex "PIPELINING" "expected errors"
16011 When the PIPELINING extension to SMTP is in use, some protocol errors are
16012 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16013 Exim assumes that PIPELINING will be used if it advertises it (see
16014 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16015 not count towards the limit.
16016
16017
16018
16019 .option smtp_max_unknown_commands main integer 3
16020 .cindex "SMTP" "limiting unknown commands"
16021 .cindex "limit" "unknown SMTP commands"
16022 If there are too many unrecognized commands in an incoming SMTP session, an
16023 Exim server drops the connection. This is a defence against some kinds of abuse
16024 that subvert web
16025 clients
16026 into making connections to SMTP ports; in these circumstances, a number of
16027 non-SMTP command lines are sent first.
16028
16029
16030
16031 .option smtp_ratelimit_hosts main "host list&!!" unset
16032 .cindex "SMTP" "rate limiting"
16033 .cindex "limit" "rate of message arrival"
16034 .cindex "RCPT" "rate limiting"
16035 Some sites find it helpful to be able to limit the rate at which certain hosts
16036 can send them messages, and the rate at which an individual message can specify
16037 recipients.
16038
16039 Exim has two rate-limiting facilities. This section describes the older
16040 facility, which can limit rates within a single connection. The newer
16041 &%ratelimit%& ACL condition can limit rates across all connections. See section
16042 &<<SECTratelimiting>>& for details of the newer facility.
16043
16044 When a host matches &%smtp_ratelimit_hosts%&, the values of
16045 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16046 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16047 respectively. Each option, if set, must contain a set of four comma-separated
16048 values:
16049
16050 .ilist
16051 A threshold, before which there is no rate limiting.
16052 .next
16053 An initial time delay. Unlike other times in Exim, numbers with decimal
16054 fractional parts are allowed here.
16055 .next
16056 A factor by which to increase the delay each time.
16057 .next
16058 A maximum value for the delay. This should normally be less than 5 minutes,
16059 because after that time, the client is liable to timeout the SMTP command.
16060 .endlist
16061
16062 For example, these settings have been used successfully at the site which
16063 first suggested this feature, for controlling mail from their customers:
16064 .code
16065 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16066 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16067 .endd
16068 The first setting specifies delays that are applied to MAIL commands after
16069 two have been received over a single connection. The initial delay is 0.5
16070 seconds, increasing by a factor of 1.05 each time. The second setting applies
16071 delays to RCPT commands when more than four occur in a single message.
16072
16073
16074 .option smtp_ratelimit_mail main string unset
16075 See &%smtp_ratelimit_hosts%& above.
16076
16077
16078 .option smtp_ratelimit_rcpt main string unset
16079 See &%smtp_ratelimit_hosts%& above.
16080
16081
16082 .option smtp_receive_timeout main time 5m
16083 .cindex "timeout" "for SMTP input"
16084 .cindex "SMTP" "input timeout"
16085 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16086 input, including batch SMTP. If a line of input (either an SMTP command or a
16087 data line) is not received within this time, the SMTP connection is dropped and
16088 the message is abandoned.
16089 A line is written to the log containing one of the following messages:
16090 .code
16091 SMTP command timeout on connection from...
16092 SMTP data timeout on connection from...
16093 .endd
16094 The former means that Exim was expecting to read an SMTP command; the latter
16095 means that it was in the DATA phase, reading the contents of a message.
16096
16097
16098 .oindex "&%-os%&"
16099 The value set by this option can be overridden by the
16100 &%-os%& command-line option. A setting of zero time disables the timeout, but
16101 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16102 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16103 timeout is controlled by &%receive_timeout%& and &%-or%&.
16104
16105
16106 .option smtp_reserve_hosts main "host list&!!" unset
16107 This option defines hosts for which SMTP connections are reserved; see
16108 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16109
16110
16111 .option smtp_return_error_details main boolean false
16112 .cindex "SMTP" "details policy failures"
16113 .cindex "policy control" "rejection, returning details"
16114 In the default state, Exim uses bland messages such as
16115 &"Administrative prohibition"& when it rejects SMTP commands for policy
16116 reasons. Many sysadmins like this because it gives away little information
16117 to spammers. However, some other sysadmins who are applying strict checking
16118 policies want to give out much fuller information about failures. Setting
16119 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16120 example, instead of &"Administrative prohibition"&, it might give:
16121 .code
16122 550-Rejected after DATA: '>' missing at end of address:
16123 550 failing address in "From" header is: <user@dom.ain
16124 .endd
16125
16126 .option spamd_address main string "see below"
16127 This option is available when Exim is compiled with the content-scanning
16128 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16129 The default value is
16130 .code
16131 127.0.0.1 783
16132 .endd
16133 See section &<<SECTscanspamass>>& for more details.
16134
16135
16136
16137 .option split_spool_directory main boolean false
16138 .cindex "multiple spool directories"
16139 .cindex "spool directory" "split"
16140 .cindex "directories, multiple"
16141 If this option is set, it causes Exim to split its input directory into 62
16142 subdirectories, each with a single alphanumeric character as its name. The
16143 sixth character of the message id is used to allocate messages to
16144 subdirectories; this is the least significant base-62 digit of the time of
16145 arrival of the message.
16146
16147 Splitting up the spool in this way may provide better performance on systems
16148 where there are long mail queues, by reducing the number of files in any one
16149 directory. The msglog directory is also split up in a similar way to the input
16150 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16151 are still placed in the single directory &_msglog.OLD_&.
16152
16153 It is not necessary to take any special action for existing messages when
16154 changing &%split_spool_directory%&. Exim notices messages that are in the
16155 &"wrong"& place, and continues to process them. If the option is turned off
16156 after a period of being on, the subdirectories will eventually empty and be
16157 automatically deleted.
16158
16159 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16160 changes. Instead of creating a list of all messages in the queue, and then
16161 trying to deliver each one in turn, it constructs a list of those in one
16162 sub-directory and tries to deliver them, before moving on to the next
16163 sub-directory. The sub-directories are processed in a random order. This
16164 spreads out the scanning of the input directories, and uses less memory. It is
16165 particularly beneficial when there are lots of messages on the queue. However,
16166 if &%queue_run_in_order%& is set, none of this new processing happens. The
16167 entire queue has to be scanned and sorted before any deliveries can start.
16168
16169
16170 .option spool_directory main string&!! "set at compile time"
16171 .cindex "spool directory" "path to"
16172 This defines the directory in which Exim keeps its spool, that is, the messages
16173 it is waiting to deliver. The default value is taken from the compile-time
16174 configuration setting, if there is one. If not, this option must be set. The
16175 string is expanded, so it can contain, for example, a reference to
16176 &$primary_hostname$&.
16177
16178 If the spool directory name is fixed on your installation, it is recommended
16179 that you set it at build time rather than from this option, particularly if the
16180 log files are being written to the spool directory (see &%log_file_path%&).
16181 Otherwise log files cannot be used for errors that are detected early on, such
16182 as failures in the configuration file.
16183
16184 By using this option to override the compiled-in path, it is possible to run
16185 tests of Exim without using the standard spool.
16186
16187 .option sqlite_lock_timeout main time 5s
16188 .cindex "sqlite lookup type" "lock timeout"
16189 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16190 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16191
16192 .option strict_acl_vars main boolean false
16193 .cindex "&ACL;" "variables, handling unset"
16194 This option controls what happens if a syntactically valid but undefined ACL
16195 variable is referenced. If it is false (the default), an empty string
16196 is substituted; if it is true, an error is generated. See section
16197 &<<SECTaclvariables>>& for details of ACL variables.
16198
16199 .option strip_excess_angle_brackets main boolean false
16200 .cindex "angle brackets, excess"
16201 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16202 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16203 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16204 passed on to another MTA, the excess angle brackets are not passed on. If this
16205 option is not set, multiple pairs of angle brackets cause a syntax error.
16206
16207
16208 .option strip_trailing_dot main boolean false
16209 .cindex "trailing dot on domain"
16210 .cindex "dot" "trailing on domain"
16211 If this option is set, a trailing dot at the end of a domain in an address is
16212 ignored. If this is in the envelope and the message is passed on to another
16213 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16214 domain causes a syntax error.
16215 However, addresses in header lines are checked only when an ACL requests header
16216 syntax checking.
16217
16218
16219 .option syslog_duplication main boolean true
16220 .cindex "syslog" "duplicate log lines; suppressing"
16221 When Exim is logging to syslog, it writes the log lines for its three
16222 separate logs at different syslog priorities so that they can in principle
16223 be separated on the logging hosts. Some installations do not require this
16224 separation, and in those cases, the duplication of certain log lines is a
16225 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16226 particular log line is written to syslog. For lines that normally go to
16227 both the main log and the reject log, the reject log version (possibly
16228 containing message header lines) is written, at LOG_NOTICE priority.
16229 Lines that normally go to both the main and the panic log are written at
16230 the LOG_ALERT priority.
16231
16232
16233 .option syslog_facility main string unset
16234 .cindex "syslog" "facility; setting"
16235 This option sets the syslog &"facility"& name, used when Exim is logging to
16236 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16237 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16238 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16239 details of Exim's logging.
16240
16241
16242
16243 .option syslog_processname main string &`exim`&
16244 .cindex "syslog" "process name; setting"
16245 This option sets the syslog &"ident"& name, used when Exim is logging to
16246 syslog. The value must be no longer than 32 characters. See chapter
16247 &<<CHAPlog>>& for details of Exim's logging.
16248
16249
16250
16251 .option syslog_timestamp main boolean true
16252 .cindex "syslog" "timestamps"
16253 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16254 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16255 details of Exim's logging.
16256
16257
16258 .option system_filter main string&!! unset
16259 .cindex "filter" "system filter"
16260 .cindex "system filter" "specifying"
16261 .cindex "Sieve filter" "not available for system filter"
16262 This option specifies an Exim filter file that is applied to all messages at
16263 the start of each delivery attempt, before any routing is done. System filters
16264 must be Exim filters; they cannot be Sieve filters. If the system filter
16265 generates any deliveries to files or pipes, or any new mail messages, the
16266 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16267 which transports are to be used. Details of this facility are given in chapter
16268 &<<CHAPsystemfilter>>&.
16269
16270
16271 .option system_filter_directory_transport main string&!! unset
16272 .vindex "&$address_file$&"
16273 This sets the name of the transport driver that is to be used when the
16274 &%save%& command in a system message filter specifies a path ending in &"/"&,
16275 implying delivery of each message into a separate file in some directory.
16276 During the delivery, the variable &$address_file$& contains the path name.
16277
16278
16279 .option system_filter_file_transport main string&!! unset
16280 .cindex "file" "transport for system filter"
16281 This sets the name of the transport driver that is to be used when the &%save%&
16282 command in a system message filter specifies a path not ending in &"/"&. During
16283 the delivery, the variable &$address_file$& contains the path name.
16284
16285 .option system_filter_group main string unset
16286 .cindex "gid (group id)" "system filter"
16287 This option is used only when &%system_filter_user%& is also set. It sets the
16288 gid under which the system filter is run, overriding any gid that is associated
16289 with the user. The value may be numerical or symbolic.
16290
16291 .option system_filter_pipe_transport main string&!! unset
16292 .cindex "&(pipe)& transport" "for system filter"
16293 .vindex "&$address_pipe$&"
16294 This specifies the transport driver that is to be used when a &%pipe%& command
16295 is used in a system filter. During the delivery, the variable &$address_pipe$&
16296 contains the pipe command.
16297
16298
16299 .option system_filter_reply_transport main string&!! unset
16300 .cindex "&(autoreply)& transport" "for system filter"
16301 This specifies the transport driver that is to be used when a &%mail%& command
16302 is used in a system filter.
16303
16304
16305 .option system_filter_user main string unset
16306 .cindex "uid (user id)" "system filter"
16307 If this option is set to root, the system filter is run in the main Exim
16308 delivery process, as root.  Otherwise, the system filter runs in a separate
16309 process, as the given user, defaulting to the Exim run-time user.
16310 Unless the string consists entirely of digits, it
16311 is looked up in the password data. Failure to find the named user causes a
16312 configuration error. The gid is either taken from the password data, or
16313 specified by &%system_filter_group%&. When the uid is specified numerically,
16314 &%system_filter_group%& is required to be set.
16315
16316 If the system filter generates any pipe, file, or reply deliveries, the uid
16317 under which the filter is run is used when transporting them, unless a
16318 transport option overrides.
16319
16320
16321 .option tcp_nodelay main boolean true
16322 .cindex "daemon" "TCP_NODELAY on sockets"
16323 .cindex "Nagle algorithm"
16324 .cindex "TCP_NODELAY on listening sockets"
16325 If this option is set false, it stops the Exim daemon setting the
16326 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16327 turns off the &"Nagle algorithm"&, which is a way of improving network
16328 performance in interactive (character-by-character) situations. Turning it off
16329 should improve Exim's performance a bit, so that is what happens by default.
16330 However, it appears that some broken clients cannot cope, and time out. Hence
16331 this option. It affects only those sockets that are set up for listening by the
16332 daemon. Sockets created by the smtp transport for delivering mail always set
16333 TCP_NODELAY.
16334
16335
16336 .option timeout_frozen_after main time 0s
16337 .cindex "frozen messages" "timing out"
16338 .cindex "timeout" "frozen messages"
16339 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16340 message of any kind that has been on the queue for longer than the given time
16341 is automatically cancelled at the next queue run. If the frozen message is a
16342 bounce message, it is just discarded; otherwise, a bounce is sent to the
16343 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16344 If you want to timeout frozen bounce messages earlier than other kinds of
16345 frozen message, see &%ignore_bounce_errors_after%&.
16346
16347 &*Note:*& the default value of zero means no timeouts; with this setting,
16348 frozen messages remain on the queue forever (except for any frozen bounce
16349 messages that are released by &%ignore_bounce_errors_after%&).
16350
16351
16352 .option timezone main string unset
16353 .cindex "timezone, setting"
16354 The value of &%timezone%& is used to set the environment variable TZ while
16355 running Exim (if it is different on entry). This ensures that all timestamps
16356 created by Exim are in the required timezone. If you want all your timestamps
16357 to be in UTC (aka GMT) you should set
16358 .code
16359 timezone = UTC
16360 .endd
16361 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16362 or, if that is not set, from the value of the TZ environment variable when Exim
16363 is built. If &%timezone%& is set to the empty string, either at build or run
16364 time, any existing TZ variable is removed from the environment when Exim
16365 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16366 unfortunately not all, operating systems.
16367
16368
16369 .option tls_advertise_hosts main "host list&!!" unset
16370 .cindex "TLS" "advertising"
16371 .cindex "encryption" "on SMTP connection"
16372 .cindex "SMTP" "encrypted connection"
16373 When Exim is built with support for TLS encrypted connections, the availability
16374 of the STARTTLS command to set up an encrypted session is advertised in
16375 response to EHLO only to those client hosts that match this option. See
16376 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16377
16378
16379 .option tls_certificate main string&!! unset
16380 .cindex "TLS" "server certificate; location of"
16381 .cindex "certificate" "server, location of"
16382 The value of this option is expanded, and must then be the absolute path to a
16383 file which contains the server's certificates. The server's private key is also
16384 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16385 &<<CHAPTLS>>& for further details.
16386
16387 &*Note*&: The certificates defined by this option are used only when Exim is
16388 receiving incoming messages as a server. If you want to supply certificates for
16389 use when sending messages as a client, you must set the &%tls_certificate%&
16390 option in the relevant &(smtp)& transport.
16391
16392 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16393 if the OpenSSL build supports TLS extensions and the TLS client sends the
16394 Server Name Indication extension, then this option and others documented in
16395 &<<SECTtlssni>>& will be re-expanded.
16396
16397 .option tls_crl main string&!! unset
16398 .cindex "TLS" "server certificate revocation list"
16399 .cindex "certificate" "revocation list for server"
16400 This option specifies a certificate revocation list. The expanded value must
16401 be the name of a file that contains a CRL in PEM format.
16402
16403 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16404
16405
16406 .option tls_dh_max_bits main integer 2236
16407 .cindex "TLS" "D-H bit count"
16408 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16409 the chosen TLS library.  That value might prove to be too high for
16410 interoperability.  This option provides a maximum clamp on the value
16411 suggested, trading off security for interoperability.
16412
16413 The value must be at least 1024.
16414
16415 The value 2236 was chosen because, at time of adding the option, it was the
16416 hard-coded maximum value supported by the NSS cryptographic library, as used
16417 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16418
16419 If you prefer more security and are willing to break some clients, raise this
16420 number.
16421
16422 Note that the value passed to GnuTLS for *generating* a new prime may be a
16423 little less than this figure, because GnuTLS is inexact and may produce a
16424 larger prime than requested.
16425
16426
16427 .option tls_dhparam main string&!! unset
16428 .cindex "TLS" "D-H parameters for server"
16429 The value of this option is expanded and indicates the source of DH parameters
16430 to be used by Exim.
16431
16432 If it is a filename starting with a &`/`&, then it names a file from which DH
16433 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16434 PKCS#3 representation of the DH prime.  If the file does not exist, for
16435 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16436 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16437 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16438 and treated as though the &%tls_dhparam%& were set to "none".
16439
16440 If this option expands to the string "none", then no DH parameters will be
16441 loaded by Exim.
16442
16443 If this option expands to the string "historic" and Exim is using GnuTLS, then
16444 Exim will attempt to load a file from inside the spool directory.  If the file
16445 does not exist, Exim will attempt to create it.
16446 See section &<<SECTgnutlsparam>>& for further details.
16447
16448 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16449 a default DH prime; the default is the 2048 bit prime described in section
16450 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16451 in IKE is assigned number 23.
16452
16453 Otherwise, the option must expand to the name used by Exim for any of a number
16454 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16455 "ike" followed by the number used by IKE, of "default" which corresponds to
16456 "ike23".
16457
16458 The available primes are:
16459 &`ike1`&, &`ike2`&, &`ike5`&,
16460 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16461 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16462
16463 Some of these will be too small to be accepted by clients.
16464 Some may be too large to be accepted by clients.
16465
16466 The TLS protocol does not negotiate an acceptable size for this; clients tend
16467 to hard-drop connections if what is offered by the server is unacceptable,
16468 whether too large or too small, and there's no provision for the client to
16469 tell the server what these constraints are.  Thus, as a server operator, you
16470 need to make an educated guess as to what is most likely to work for your
16471 userbase.
16472
16473 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16474 is most likely to maximise interoperability.  The upper bound comes from
16475 applications using the Mozilla Network Security Services (NSS) library, which
16476 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16477 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16478 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16479 acceptable bound from 1024 to 2048.
16480
16481
16482 .option tls_ocsp_file main string&!! unset
16483 This option
16484 must if set expand to the absolute path to a file which contains a current
16485 status proof for the server's certificate, as obtained from the
16486 Certificate Authority.
16487
16488
16489 .option tls_on_connect_ports main "string list" unset
16490 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16491 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16492 set up without waiting for the client to issue a STARTTLS command. For
16493 further details, see section &<<SECTsupobssmt>>&.
16494
16495
16496
16497 .option tls_privatekey main string&!! unset
16498 .cindex "TLS" "server private key; location of"
16499 The value of this option is expanded, and must then be the absolute path to a
16500 file which contains the server's private key. If this option is unset, or if
16501 the expansion is forced to fail, or the result is an empty string, the private
16502 key is assumed to be in the same file as the server's certificates. See chapter
16503 &<<CHAPTLS>>& for further details.
16504
16505 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16506
16507
16508 .option tls_remember_esmtp main boolean false
16509 .cindex "TLS" "esmtp state; remembering"
16510 .cindex "TLS" "broken clients"
16511 If this option is set true, Exim violates the RFCs by remembering that it is in
16512 &"esmtp"& state after successfully negotiating a TLS session. This provides
16513 support for broken clients that fail to send a new EHLO after starting a
16514 TLS session.
16515
16516
16517 .option tls_require_ciphers main string&!! unset
16518 .cindex "TLS" "requiring specific ciphers"
16519 .cindex "cipher" "requiring specific"
16520 This option controls which ciphers can be used for incoming TLS connections.
16521 The &(smtp)& transport has an option of the same name for controlling outgoing
16522 connections. This option is expanded for each connection, so can be varied for
16523 different clients if required. The value of this option must be a list of
16524 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16525 in somewhat different ways. If GnuTLS is being used, the client controls the
16526 preference order of the available ciphers. Details are given in sections
16527 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16528
16529
16530 .option tls_try_verify_hosts main "host list&!!" unset
16531 .cindex "TLS" "client certificate verification"
16532 .cindex "certificate" "verification of client"
16533 See &%tls_verify_hosts%& below.
16534
16535
16536 .option tls_verify_certificates main string&!! system
16537 .cindex "TLS" "client certificate verification"
16538 .cindex "certificate" "verification of client"
16539 The value of this option is expanded, and must then be either the
16540 word "system"
16541 or the absolute path to
16542 a file or directory containing permitted certificates for clients that
16543 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16544
16545 The "system" value for the option will use a
16546 system default location compiled into the SSL library.
16547 This is not available for GnuTLS versions preceding 3.0.20,
16548 and will be taken as empty; an explicit location
16549 must be specified.
16550
16551 The use of a directory for the option value is not avilable for GnuTLS versions
16552 preceding 3.3.6 and a single file must be used.
16553
16554 With OpenSSL the certificates specified
16555 explicitly
16556 either by file or directory
16557 are added to those given by the system default location.
16558
16559 These certificates should be for the certificate authorities trusted, rather
16560 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16561 the value is a file then the certificates are sent by Exim as a server to
16562 connecting clients, defining the list of accepted certificate authorities.
16563 Thus the values defined should be considered public data.  To avoid this,
16564 use the explicit directory version.
16565
16566 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16567
16568 A forced expansion failure or setting to an empty string is equivalent to
16569 being unset.
16570
16571
16572 .option tls_verify_hosts main "host list&!!" unset
16573 .cindex "TLS" "client certificate verification"
16574 .cindex "certificate" "verification of client"
16575 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16576 certificates from clients. The expected certificates are defined by
16577 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16578 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16579 &%tls_verify_certificates%& is not set.
16580
16581 Any client that matches &%tls_verify_hosts%& is constrained by
16582 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16583 present one of the listed certificates. If it does not, the connection is
16584 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16585 the host to use TLS. It can still send SMTP commands through unencrypted
16586 connections. Forcing a client to use TLS has to be done separately using an
16587 ACL to reject inappropriate commands when the connection is not encrypted.
16588
16589 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16590 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16591 certificate and checks it against &%tls_verify_certificates%&, but does not
16592 abort the connection if there is no certificate or if it does not match. This
16593 state can be detected in an ACL, which makes it possible to implement policies
16594 such as &"accept for relay only if a verified certificate has been received,
16595 but accept for local delivery if encrypted, even without a verified
16596 certificate"&.
16597
16598 Client hosts that match neither of these lists are not asked to present
16599 certificates.
16600
16601
16602 .option trusted_groups main "string list&!!" unset
16603 .cindex "trusted groups"
16604 .cindex "groups" "trusted"
16605 This option is expanded just once, at the start of Exim's processing. If this
16606 option is set, any process that is running in one of the listed groups, or
16607 which has one of them as a supplementary group, is trusted. The groups can be
16608 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16609 details of what trusted callers are permitted to do. If neither
16610 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16611 are trusted.
16612
16613 .option trusted_users main "string list&!!" unset
16614 .cindex "trusted users"
16615 .cindex "user" "trusted"
16616 This option is expanded just once, at the start of Exim's processing. If this
16617 option is set, any process that is running as one of the listed users is
16618 trusted. The users can be specified numerically or by name. See section
16619 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16620 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16621 Exim user are trusted.
16622
16623 .option unknown_login main string&!! unset
16624 .cindex "uid (user id)" "unknown caller"
16625 .vindex "&$caller_uid$&"
16626 This is a specialized feature for use in unusual configurations. By default, if
16627 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16628 gives up. The &%unknown_login%& option can be used to set a login name to be
16629 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16630 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16631 is used for the user's real name (gecos field), unless this has been set by the
16632 &%-F%& option.
16633
16634 .option unknown_username main string unset
16635 See &%unknown_login%&.
16636
16637 .option untrusted_set_sender main "address list&!!" unset
16638 .cindex "trusted users"
16639 .cindex "sender" "setting by untrusted user"
16640 .cindex "untrusted user setting sender"
16641 .cindex "user" "untrusted setting sender"
16642 .cindex "envelope sender"
16643 When an untrusted user submits a message to Exim using the standard input, Exim
16644 normally creates an envelope sender address from the user's login and the
16645 default qualification domain. Data from the &%-f%& option (for setting envelope
16646 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16647 is used) is ignored.
16648
16649 However, untrusted users are permitted to set an empty envelope sender address,
16650 to declare that a message should never generate any bounces. For example:
16651 .code
16652 exim -f '<>' user@domain.example
16653 .endd
16654 .vindex "&$sender_ident$&"
16655 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16656 other envelope sender addresses in a controlled way. When it is set, untrusted
16657 users are allowed to set envelope sender addresses that match any of the
16658 patterns in the list. Like all address lists, the string is expanded. The
16659 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16660 users to setting senders that start with their login ids
16661 followed by a hyphen
16662 by a setting like this:
16663 .code
16664 untrusted_set_sender = ^$sender_ident-
16665 .endd
16666 If you want to allow untrusted users to set envelope sender addresses without
16667 restriction, you can use
16668 .code
16669 untrusted_set_sender = *
16670 .endd
16671 The &%untrusted_set_sender%& option applies to all forms of local input, but
16672 only to the setting of the envelope sender. It does not permit untrusted users
16673 to use the other options which trusted user can use to override message
16674 parameters. Furthermore, it does not stop Exim from removing an existing
16675 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16676 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16677 overriding these actions. The handling of the &'Sender:'& header is also
16678 described in section &<<SECTthesenhea>>&.
16679
16680 The log line for a message's arrival shows the envelope sender following
16681 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16682 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16683 envelope sender address, the user's login is shown in parentheses after the
16684 sender address.
16685
16686
16687 .option uucp_from_pattern main string "see below"
16688 .cindex "&""From""& line"
16689 .cindex "UUCP" "&""From""& line"
16690 Some applications that pass messages to an MTA via a command line interface use
16691 an initial line starting with &"From&~"& to pass the envelope sender. In
16692 particular, this is used by UUCP software. Exim recognizes such a line by means
16693 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16694 matches, the sender address is constructed by expanding the contents of
16695 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16696 default pattern recognizes lines in the following two forms:
16697 .code
16698 From ph10 Fri Jan  5 12:35 GMT 1996
16699 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16700 .endd
16701 The pattern can be seen by running
16702 .code
16703 exim -bP uucp_from_pattern
16704 .endd
16705 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16706 year in the second case. The first word after &"From&~"& is matched in the
16707 regular expression by a parenthesized subpattern. The default value for
16708 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16709 (&"ph10"& in the example above) as the message's sender. See also
16710 &%ignore_fromline_hosts%&.
16711
16712
16713 .option uucp_from_sender main string&!! &`$1`&
16714 See &%uucp_from_pattern%& above.
16715
16716
16717 .option warn_message_file main string unset
16718 .cindex "warning of delay" "customizing the message"
16719 .cindex "customizing" "warning message"
16720 This option defines a template file containing paragraphs of text to be used
16721 for constructing the warning message which is sent by Exim when a message has
16722 been on the queue for a specified amount of time, as specified by
16723 &%delay_warning%&. Details of the file's contents are given in chapter
16724 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16725
16726
16727 .option write_rejectlog main boolean true
16728 .cindex "reject log" "disabling"
16729 If this option is set false, Exim no longer writes anything to the reject log.
16730 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16731 .ecindex IIDconfima
16732 .ecindex IIDmaiconf
16733
16734
16735
16736
16737 . ////////////////////////////////////////////////////////////////////////////
16738 . ////////////////////////////////////////////////////////////////////////////
16739
16740 .chapter "Generic options for routers" "CHAProutergeneric"
16741 .scindex IIDgenoprou1 "options" "generic; for routers"
16742 .scindex IIDgenoprou2 "generic options" "router"
16743 This chapter describes the generic options that apply to all routers.
16744 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16745
16746 For a general description of how a router operates, see sections
16747 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16748 which the preconditions are tested. The order of expansion of the options that
16749 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16750 &%headers_remove%&, &%transport%&.
16751
16752
16753
16754 .option address_data routers string&!! unset
16755 .cindex "router" "data attached to address"
16756 The string is expanded just before the router is run, that is, after all the
16757 precondition tests have succeeded. If the expansion is forced to fail, the
16758 router declines, the value of &%address_data%& remains unchanged, and the
16759 &%more%& option controls what happens next. Other expansion failures cause
16760 delivery of the address to be deferred.
16761
16762 .vindex "&$address_data$&"
16763 When the expansion succeeds, the value is retained with the address, and can be
16764 accessed using the variable &$address_data$& in the current router, subsequent
16765 routers, and the eventual transport.
16766
16767 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16768 that runs a user's filter file, the contents of &$address_data$& are accessible
16769 in the filter. This is not normally a problem, because such data is usually
16770 either not confidential or it &"belongs"& to the current user, but if you do
16771 put confidential data into &$address_data$& you need to remember this point.
16772
16773 Even if the router declines or passes, the value of &$address_data$& remains
16774 with the address, though it can be changed by another &%address_data%& setting
16775 on a subsequent router. If a router generates child addresses, the value of
16776 &$address_data$& propagates to them. This also applies to the special kind of
16777 &"child"& that is generated by a router with the &%unseen%& option.
16778
16779 The idea of &%address_data%& is that you can use it to look up a lot of data
16780 for the address once, and then pick out parts of the data later. For example,
16781 you could use a single LDAP lookup to return a string of the form
16782 .code
16783 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16784 .endd
16785 In the transport you could pick out the mailbox by a setting such as
16786 .code
16787 file = ${extract{mailbox}{$address_data}}
16788 .endd
16789 This makes the configuration file less messy, and also reduces the number of
16790 lookups (though Exim does cache lookups).
16791
16792 .vindex "&$sender_address_data$&"
16793 .vindex "&$address_data$&"
16794 The &%address_data%& facility is also useful as a means of passing information
16795 from one router to another, and from a router to a transport. In addition, if
16796 &$address_data$& is set by a router when verifying a recipient address from an
16797 ACL, it remains available for use in the rest of the ACL statement. After
16798 verifying a sender, the value is transferred to &$sender_address_data$&.
16799
16800
16801
16802 .option address_test routers&!? boolean true
16803 .oindex "&%-bt%&"
16804 .cindex "router" "skipping when address testing"
16805 If this option is set false, the router is skipped when routing is being tested
16806 by means of the &%-bt%& command line option. This can be a convenience when
16807 your first router sends messages to an external scanner, because it saves you
16808 having to set the &"already scanned"& indicator when testing real address
16809 routing.
16810
16811
16812
16813 .option cannot_route_message routers string&!! unset
16814 .cindex "router" "customizing &""cannot route""& message"
16815 .cindex "customizing" "&""cannot route""& message"
16816 This option specifies a text message that is used when an address cannot be
16817 routed because Exim has run out of routers. The default message is
16818 &"Unrouteable address"&. This option is useful only on routers that have
16819 &%more%& set false, or on the very last router in a configuration, because the
16820 value that is used is taken from the last router that is considered. This
16821 includes a router that is skipped because its preconditions are not met, as
16822 well as a router that declines. For example, using the default configuration,
16823 you could put:
16824 .code
16825 cannot_route_message = Remote domain not found in DNS
16826 .endd
16827 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16828 and
16829 .code
16830 cannot_route_message = Unknown local user
16831 .endd
16832 on the final router that checks for local users. If string expansion fails for
16833 this option, the default message is used. Unless the expansion failure was
16834 explicitly forced, a message about the failure is written to the main and panic
16835 logs, in addition to the normal message about the routing failure.
16836
16837
16838 .option caseful_local_part routers boolean false
16839 .cindex "case of local parts"
16840 .cindex "router" "case of local parts"
16841 By default, routers handle the local parts of addresses in a case-insensitive
16842 manner, though the actual case is preserved for transmission with the message.
16843 If you want the case of letters to be significant in a router, you must set
16844 this option true. For individual router options that contain address or local
16845 part lists (for example, &%local_parts%&), case-sensitive matching can be
16846 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16847 more details.
16848
16849 .vindex "&$local_part$&"
16850 .vindex "&$original_local_part$&"
16851 .vindex "&$parent_local_part$&"
16852 The value of the &$local_part$& variable is forced to lower case while a
16853 router is running unless &%caseful_local_part%& is set. When a router assigns
16854 an address to a transport, the value of &$local_part$& when the transport runs
16855 is the same as it was in the router. Similarly, when a router generates child
16856 addresses by aliasing or forwarding, the values of &$original_local_part$&
16857 and &$parent_local_part$& are those that were used by the redirecting router.
16858
16859 This option applies to the processing of an address by a router. When a
16860 recipient address is being processed in an ACL, there is a separate &%control%&
16861 modifier that can be used to specify case-sensitive processing within the ACL
16862 (see section &<<SECTcontrols>>&).
16863
16864
16865
16866 .option check_local_user routers&!? boolean false
16867 .cindex "local user, checking in router"
16868 .cindex "router" "checking for local user"
16869 .cindex "&_/etc/passwd_&"
16870 .vindex "&$home$&"
16871 When this option is true, Exim checks that the local part of the recipient
16872 address (with affixes removed if relevant) is the name of an account on the
16873 local system. The check is done by calling the &[getpwnam()]& function rather
16874 than trying to read &_/etc/passwd_& directly. This means that other methods of
16875 holding password data (such as NIS) are supported. If the local part is a local
16876 user, &$home$& is set from the password data, and can be tested in other
16877 preconditions that are evaluated after this one (the order of evaluation is
16878 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16879 overridden by &%router_home_directory%&. If the local part is not a local user,
16880 the router is skipped.
16881
16882 If you want to check that the local part is either the name of a local user
16883 or matches something else, you cannot combine &%check_local_user%& with a
16884 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16885 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16886 setting to achieve this. For example:
16887 .code
16888 local_parts = passwd;$local_part : lsearch;/etc/other/users
16889 .endd
16890 Note, however, that the side effects of &%check_local_user%& (such as setting
16891 up a home directory) do not occur when a &(passwd)& lookup is used in a
16892 &%local_parts%& (or any other) precondition.
16893
16894
16895
16896 .option condition routers&!? string&!! unset
16897 .cindex "router" "customized precondition"
16898 This option specifies a general precondition test that has to succeed for the
16899 router to be called. The &%condition%& option is the last precondition to be
16900 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16901 result is a forced failure, or an empty string, or one of the strings &"0"& or
16902 &"no"& or &"false"& (checked without regard to the case of the letters), the
16903 router is skipped, and the address is offered to the next one.
16904
16905 If the result is any other value, the router is run (as this is the last
16906 precondition to be evaluated, all the other preconditions must be true).
16907
16908 This option is unusual in that multiple &%condition%& options may be present.
16909 All &%condition%& options must succeed.
16910
16911 The &%condition%& option provides a means of applying custom conditions to the
16912 running of routers. Note that in the case of a simple conditional expansion,
16913 the default expansion values are exactly what is wanted. For example:
16914 .code
16915 condition = ${if >{$message_age}{600}}
16916 .endd
16917 Because of the default behaviour of the string expansion, this is equivalent to
16918 .code
16919 condition = ${if >{$message_age}{600}{true}{}}
16920 .endd
16921
16922 A multiple condition example, which succeeds:
16923 .code
16924 condition = ${if >{$message_age}{600}}
16925 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16926 condition = foobar
16927 .endd
16928
16929 If the expansion fails (other than forced failure) delivery is deferred. Some
16930 of the other precondition options are common special cases that could in fact
16931 be specified using &%condition%&.
16932
16933 .new
16934 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16935 are far older, and use one set of semantics.  ACLs are newer and when
16936 they were created, the ACL &%condition%& process was given far stricter
16937 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16938 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16939 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16940 Router rules processing behavior.
16941
16942 This is best illustrated in an example:
16943 .code
16944 # If used in an ACL condition will fail with a syntax error, but
16945 # in a router condition any extra characters are treated as a string
16946
16947 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16948 true {yes} {no}}
16949
16950 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16951  {yes} {no}}
16952 .endd
16953 In each example above, the &%if%& statement actually ends after
16954 &"{google.com}}"&.  Since no true or false braces were defined, the
16955 default &%if%& behavior is to return a boolean true or a null answer
16956 (which evaluates to false). The rest of the line is then treated as a
16957 string. So the first example resulted in the boolean answer &"true"&
16958 with the string &" {yes} {no}}"& appended to it. The second example
16959 resulted in the null output (indicating false) with the string
16960 &" {yes} {no}}"& appended to it.
16961
16962 In fact you can put excess forward braces in too.  In the router
16963 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16964 mean something, like after a &"$"& or when required as part of a
16965 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16966 string characters.
16967
16968 Thus, in a Router, the above expansion strings will both always evaluate
16969 true, as the result of expansion is a non-empty string which doesn't
16970 match an explicit false value.  This can be tricky to debug.  By
16971 contrast, in an ACL either of those strings will always result in an
16972 expansion error because the result doesn't look sufficiently boolean.
16973 .wen
16974
16975
16976 .option debug_print routers string&!! unset
16977 .cindex "testing" "variables in drivers"
16978 If this option is set and debugging is enabled (see the &%-d%& command line
16979 option) or in address-testing mode (see the &%-bt%& command line option),
16980 the string is expanded and included in the debugging output.
16981 If expansion of the string fails, the error message is written to the debugging
16982 output, and Exim carries on processing.
16983 This option is provided to help with checking out the values of variables and
16984 so on when debugging router configurations. For example, if a &%condition%&
16985 option appears not to be working, &%debug_print%& can be used to output the
16986 variables it references. The output happens after checks for &%domains%&,
16987 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16988 are tested. A newline is added to the text if it does not end with one.
16989 The variable &$router_name$& contains the name of the router.
16990
16991
16992
16993 .option disable_logging routers boolean false
16994 If this option is set true, nothing is logged for any routing errors
16995 or for any deliveries caused by this router. You should not set this option
16996 unless you really, really know what you are doing. See also the generic
16997 transport option of the same name.
16998
16999
17000 .option domains routers&!? "domain list&!!" unset
17001 .cindex "router" "restricting to specific domains"
17002 .vindex "&$domain_data$&"
17003 If this option is set, the router is skipped unless the current domain matches
17004 the list. If the match is achieved by means of a file lookup, the data that the
17005 lookup returned for the domain is placed in &$domain_data$& for use in string
17006 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17007 a list of the order in which preconditions are evaluated.
17008
17009
17010
17011 .option driver routers string unset
17012 This option must always be set. It specifies which of the available routers is
17013 to be used.
17014
17015
17016 .option dsn_lasthop routers boolean false
17017 .cindex "DSN" "success"
17018 .cindex "Delivery Status Notification" "success"
17019 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17020 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17021 instead send a success DSN as if the next hop does not support DSN.
17022 Not effective on redirect routers.
17023
17024
17025
17026 .option errors_to routers string&!! unset
17027 .cindex "envelope sender"
17028 .cindex "router" "changing address for errors"
17029 If a router successfully handles an address, it may assign the address to a
17030 transport for delivery or it may generate child addresses. In both cases, if
17031 there is a delivery problem during later processing, the resulting bounce
17032 message is sent to the address that results from expanding this string,
17033 provided that the address verifies successfully. The &%errors_to%& option is
17034 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17035
17036 The &%errors_to%& setting associated with an address can be overridden if it
17037 subsequently passes through other routers that have their own &%errors_to%&
17038 settings, or if the message is delivered by a transport with a &%return_path%&
17039 setting.
17040
17041 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17042 the expansion fails to verify, the errors address associated with the incoming
17043 address is used. At top level, this is the envelope sender. A non-forced
17044 expansion failure causes delivery to be deferred.
17045
17046 If an address for which &%errors_to%& has been set ends up being delivered over
17047 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17048 any bounces that are generated by other MTAs on the delivery route are also
17049 sent there. You can set &%errors_to%& to the empty string by either of these
17050 settings:
17051 .code
17052 errors_to =
17053 errors_to = ""
17054 .endd
17055 An expansion item that yields an empty string has the same effect. If you do
17056 this, a locally detected delivery error for addresses processed by this router
17057 no longer gives rise to a bounce message; the error is discarded. If the
17058 address is delivered to a remote host, the return path is set to &`<>`&, unless
17059 overridden by the &%return_path%& option on the transport.
17060
17061 .vindex "&$address_data$&"
17062 If for some reason you want to discard local errors, but use a non-empty
17063 MAIL command for remote delivery, you can preserve the original return
17064 path in &$address_data$& in the router, and reinstate it in the transport by
17065 setting &%return_path%&.
17066
17067 The most common use of &%errors_to%& is to direct mailing list bounces to the
17068 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17069 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17070
17071
17072
17073 .option expn routers&!? boolean true
17074 .cindex "address" "testing"
17075 .cindex "testing" "addresses"
17076 .cindex "EXPN" "router skipping"
17077 .cindex "router" "skipping for EXPN"
17078 If this option is turned off, the router is skipped when testing an address
17079 as a result of processing an SMTP EXPN command. You might, for example,
17080 want to turn it off on a router for users' &_.forward_& files, while leaving it
17081 on for the system alias file.
17082 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17083 are evaluated.
17084
17085 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17086 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17087 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17088
17089
17090
17091 .option fail_verify routers boolean false
17092 .cindex "router" "forcing verification failure"
17093 Setting this option has the effect of setting both &%fail_verify_sender%& and
17094 &%fail_verify_recipient%& to the same value.
17095
17096
17097
17098 .option fail_verify_recipient routers boolean false
17099 If this option is true and an address is accepted by this router when
17100 verifying a recipient, verification fails.
17101
17102
17103
17104 .option fail_verify_sender routers boolean false
17105 If this option is true and an address is accepted by this router when
17106 verifying a sender, verification fails.
17107
17108
17109
17110 .option fallback_hosts routers "string list" unset
17111 .cindex "router" "fallback hosts"
17112 .cindex "fallback" "hosts specified on router"
17113 String expansion is not applied to this option. The argument must be a
17114 colon-separated list of host names or IP addresses. The list separator can be
17115 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17116 each name or address. In fact, the format of each item is exactly the same as
17117 defined for the list of hosts in a &(manualroute)& router (see section
17118 &<<SECTformatonehostitem>>&).
17119
17120 If a router queues an address for a remote transport, this host list is
17121 associated with the address, and used instead of the transport's fallback host
17122 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17123 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17124 transport for further details.
17125
17126
17127 .option group routers string&!! "see below"
17128 .cindex "gid (group id)" "local delivery"
17129 .cindex "local transports" "uid and gid"
17130 .cindex "transport" "local"
17131 .cindex "router" "setting group"
17132 When a router queues an address for a transport, and the transport does not
17133 specify a group, the group given here is used when running the delivery
17134 process.
17135 The group may be specified numerically or by name. If expansion fails, the
17136 error is logged and delivery is deferred.
17137 The default is unset, unless &%check_local_user%& is set, when the default
17138 is taken from the password information. See also &%initgroups%& and &%user%&
17139 and the discussion in chapter &<<CHAPenvironment>>&.
17140
17141
17142
17143 .option headers_add routers list&!! unset
17144 .cindex "header lines" "adding"
17145 .cindex "router" "adding header lines"
17146 This option specifies a list of text headers, newline-separated,
17147 that is associated with any addresses that are accepted by the router.
17148 Each item is separately expanded, at routing time.  However, this
17149 option has no effect when an address is just being verified. The way in which
17150 the text is used to add header lines at transport time is described in section
17151 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17152 message is in the process of being transported. This means that references to
17153 header lines in string expansions in the transport's configuration do not
17154 &"see"& the added header lines.
17155
17156 The &%headers_add%& option is expanded after &%errors_to%&, but before
17157 &%headers_remove%& and &%transport%&. If an item is empty, or if
17158 an item expansion is forced to fail, the item has no effect. Other expansion
17159 failures are treated as configuration errors.
17160
17161 Unlike most options, &%headers_add%& can be specified multiple times
17162 for a router; all listed headers are added.
17163
17164 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17165 router that has the &%one_time%& option set.
17166
17167 .cindex "duplicate addresses"
17168 .oindex "&%unseen%&"
17169 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17170 additions are deleted when the address is passed on to subsequent routers.
17171 For a &%redirect%& router, if a generated address is the same as the incoming
17172 address, this can lead to duplicate addresses with different header
17173 modifications. Exim does not do duplicate deliveries (except, in certain
17174 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17175 which of the duplicates is discarded, so this ambiguous situation should be
17176 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17177
17178
17179
17180 .option headers_remove routers list&!! unset
17181 .cindex "header lines" "removing"
17182 .cindex "router" "removing header lines"
17183 This option specifies a list of text headers, colon-separated,
17184 that is associated with any addresses that are accepted by the router.
17185 Each item is separately expanded, at routing time.  However, this
17186 option has no effect when an address is just being verified. The way in which
17187 the text is used to remove header lines at transport time is described in
17188 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17189 the message is in the process of being transported. This means that references
17190 to header lines in string expansions in the transport's configuration still
17191 &"see"& the original header lines.
17192
17193 The &%headers_remove%& option is expanded after &%errors_to%& and
17194 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17195 the item has no effect. Other expansion failures are treated as configuration
17196 errors.
17197
17198 Unlike most options, &%headers_remove%& can be specified multiple times
17199 for a router; all listed headers are removed.
17200
17201 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17202 router that has the &%one_time%& option set.
17203
17204 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17205 removal requests are deleted when the address is passed on to subsequent
17206 routers, and this can lead to problems with duplicates -- see the similar
17207 warning for &%headers_add%& above.
17208
17209
17210 .option ignore_target_hosts routers "host list&!!" unset
17211 .cindex "IP address" "discarding"
17212 .cindex "router" "discarding IP addresses"
17213 Although this option is a host list, it should normally contain IP address
17214 entries rather than names. If any host that is looked up by the router has an
17215 IP address that matches an item in this list, Exim behaves as if that IP
17216 address did not exist. This option allows you to cope with rogue DNS entries
17217 like
17218 .code
17219 remote.domain.example.  A  127.0.0.1
17220 .endd
17221 by setting
17222 .code
17223 ignore_target_hosts = 127.0.0.1
17224 .endd
17225 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17226 discarded in this way, the router declines. In a conventional configuration, an
17227 attempt to mail to such a domain would normally provoke the &"unrouteable
17228 domain"& error, and an attempt to verify an address in the domain would fail.
17229 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17230 router declines if presented with one of the listed addresses.
17231
17232 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17233 means of the first or the second of the following settings, respectively:
17234 .code
17235 ignore_target_hosts = 0.0.0.0/0
17236 ignore_target_hosts = <; 0::0/0
17237 .endd
17238 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17239 in the second line matches all IPv6 addresses.
17240
17241 This option may also be useful for ignoring link-local and site-local IPv6
17242 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17243 is expanded before use as a list, it is possible to make it dependent on the
17244 domain that is being routed.
17245
17246 .vindex "&$host_address$&"
17247 During its expansion, &$host_address$& is set to the IP address that is being
17248 checked.
17249
17250 .option initgroups routers boolean false
17251 .cindex "additional groups"
17252 .cindex "groups" "additional"
17253 .cindex "local transports" "uid and gid"
17254 .cindex "transport" "local"
17255 If the router queues an address for a transport, and this option is true, and
17256 the uid supplied by the router is not overridden by the transport, the
17257 &[initgroups()]& function is called when running the transport to ensure that
17258 any additional groups associated with the uid are set up. See also &%group%&
17259 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17260
17261
17262
17263 .option local_part_prefix routers&!? "string list" unset
17264 .cindex "router" "prefix for local part"
17265 .cindex "prefix" "for local part, used in router"
17266 If this option is set, the router is skipped unless the local part starts with
17267 one of the given strings, or &%local_part_prefix_optional%& is true. See
17268 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17269 evaluated.
17270
17271 The list is scanned from left to right, and the first prefix that matches is
17272 used. A limited form of wildcard is available; if the prefix begins with an
17273 asterisk, it matches the longest possible sequence of arbitrary characters at
17274 the start of the local part. An asterisk should therefore always be followed by
17275 some character that does not occur in normal local parts.
17276 .cindex "multiple mailboxes"
17277 .cindex "mailbox" "multiple"
17278 Wildcarding can be used to set up multiple user mailboxes, as described in
17279 section &<<SECTmulbox>>&.
17280
17281 .vindex "&$local_part$&"
17282 .vindex "&$local_part_prefix$&"
17283 During the testing of the &%local_parts%& option, and while the router is
17284 running, the prefix is removed from the local part, and is available in the
17285 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17286 the router accepts the address, this remains true during subsequent delivery by
17287 a transport. In particular, the local part that is transmitted in the RCPT
17288 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17289 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17290 the relevant transport.
17291
17292 When an address is being verified, &%local_part_prefix%& affects only the
17293 behaviour of the router. If the callout feature of verification is in use, this
17294 means that the full address, including the prefix, will be used during the
17295 callout.
17296
17297 The prefix facility is commonly used to handle local parts of the form
17298 &%owner-something%&. Another common use is to support local parts of the form
17299 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17300 to tell a user their forwarding is broken &-- by placing a router like this one
17301 immediately before the router that handles &_.forward_& files:
17302 .code
17303 real_localuser:
17304   driver = accept
17305   local_part_prefix = real-
17306   check_local_user
17307   transport = local_delivery
17308 .endd
17309 For security, it would probably be a good idea to restrict the use of this
17310 router to locally-generated messages, using a condition such as this:
17311 .code
17312   condition = ${if match {$sender_host_address}\
17313                          {\N^(|127\.0\.0\.1)$\N}}
17314 .endd
17315
17316 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17317 both conditions must be met if not optional. Care must be taken if wildcards
17318 are used in both a prefix and a suffix on the same router. Different
17319 separator characters must be used to avoid ambiguity.
17320
17321
17322 .option local_part_prefix_optional routers boolean false
17323 See &%local_part_prefix%& above.
17324
17325
17326
17327 .option local_part_suffix routers&!? "string list" unset
17328 .cindex "router" "suffix for local part"
17329 .cindex "suffix for local part" "used in router"
17330 This option operates in the same way as &%local_part_prefix%&, except that the
17331 local part must end (rather than start) with the given string, the
17332 &%local_part_suffix_optional%& option determines whether the suffix is
17333 mandatory, and the wildcard * character, if present, must be the last
17334 character of the suffix. This option facility is commonly used to handle local
17335 parts of the form &%something-request%& and multiple user mailboxes of the form
17336 &%username-foo%&.
17337
17338
17339 .option local_part_suffix_optional routers boolean false
17340 See &%local_part_suffix%& above.
17341
17342
17343
17344 .option local_parts routers&!? "local part list&!!" unset
17345 .cindex "router" "restricting to specific local parts"
17346 .cindex "local part" "checking in router"
17347 The router is run only if the local part of the address matches the list.
17348 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17349 are evaluated, and
17350 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17351 string is expanded, it is possible to make it depend on the domain, for
17352 example:
17353 .code
17354 local_parts = dbm;/usr/local/specials/$domain
17355 .endd
17356 .vindex "&$local_part_data$&"
17357 If the match is achieved by a lookup, the data that the lookup returned
17358 for the local part is placed in the variable &$local_part_data$& for use in
17359 expansions of the router's private options. You might use this option, for
17360 example, if you have a large number of local virtual domains, and you want to
17361 send all postmaster mail to the same place without having to set up an alias in
17362 each virtual domain:
17363 .code
17364 postmaster:
17365   driver = redirect
17366   local_parts = postmaster
17367   data = postmaster@real.domain.example
17368 .endd
17369
17370
17371 .option log_as_local routers boolean "see below"
17372 .cindex "log" "delivery line"
17373 .cindex "delivery" "log line format"
17374 Exim has two logging styles for delivery, the idea being to make local
17375 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17376 recipient address is given just as the local part, without a domain. The use of
17377 this style is controlled by this option. It defaults to true for the &(accept)&
17378 router, and false for all the others. This option applies only when a
17379 router assigns an address to a transport. It has no effect on routers that
17380 redirect addresses.
17381
17382
17383
17384 .option more routers boolean&!! true
17385 The result of string expansion for this option must be a valid boolean value,
17386 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17387 result causes an error, and delivery is deferred. If the expansion is forced to
17388 fail, the default value for the option (true) is used. Other failures cause
17389 delivery to be deferred.
17390
17391 If this option is set false, and the router declines to handle the address, no
17392 further routers are tried, routing fails, and the address is bounced.
17393 .oindex "&%self%&"
17394 However, if the router explicitly passes an address to the following router by
17395 means of the setting
17396 .code
17397 self = pass
17398 .endd
17399 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17400 does not affect the behaviour if one of the precondition tests fails. In that
17401 case, the address is always passed to the next router.
17402
17403 Note that &%address_data%& is not considered to be a precondition. If its
17404 expansion is forced to fail, the router declines, and the value of &%more%&
17405 controls what happens next.
17406
17407
17408 .option pass_on_timeout routers boolean false
17409 .cindex "timeout" "of router"
17410 .cindex "router" "timeout"
17411 If a router times out during a host lookup, it normally causes deferral of the
17412 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17413 router, overriding &%no_more%&. This may be helpful for systems that are
17414 intermittently connected to the Internet, or those that want to pass to a smart
17415 host any messages that cannot immediately be delivered.
17416
17417 There are occasional other temporary errors that can occur while doing DNS
17418 lookups. They are treated in the same way as a timeout, and this option
17419 applies to all of them.
17420
17421
17422
17423 .option pass_router routers string unset
17424 .cindex "router" "go to after &""pass""&"
17425 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17426 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17427 routing to continue, and overriding a false setting of &%more%&. When one of
17428 these routers returns &"pass"&, the address is normally handed on to the next
17429 router in sequence. This can be changed by setting &%pass_router%& to the name
17430 of another router. However (unlike &%redirect_router%&) the named router must
17431 be below the current router, to avoid loops. Note that this option applies only
17432 to the special case of &"pass"&. It does not apply when a router returns
17433 &"decline"& because it cannot handle an address.
17434
17435
17436
17437 .option redirect_router routers string unset
17438 .cindex "router" "start at after redirection"
17439 Sometimes an administrator knows that it is pointless to reprocess addresses
17440 generated from alias or forward files with the same router again. For
17441 example, if an alias file translates real names into login ids there is no
17442 point searching the alias file a second time, especially if it is a large file.
17443
17444 The &%redirect_router%& option can be set to the name of any router instance.
17445 It causes the routing of any generated addresses to start at the named router
17446 instead of at the first router. This option has no effect if the router in
17447 which it is set does not generate new addresses.
17448
17449
17450
17451 .option require_files routers&!? "string list&!!" unset
17452 .cindex "file" "requiring for router"
17453 .cindex "router" "requiring file existence"
17454 This option provides a general mechanism for predicating the running of a
17455 router on the existence or non-existence of certain files or directories.
17456 Before running a router, as one of its precondition tests, Exim works its way
17457 through the &%require_files%& list, expanding each item separately.
17458
17459 Because the list is split before expansion, any colons in expansion items must
17460 be doubled, or the facility for using a different list separator must be used.
17461 If any expansion is forced to fail, the item is ignored. Other expansion
17462 failures cause routing of the address to be deferred.
17463
17464 If any expanded string is empty, it is ignored. Otherwise, except as described
17465 below, each string must be a fully qualified file path, optionally preceded by
17466 &"!"&. The paths are passed to the &[stat()]& function to test for the
17467 existence of the files or directories. The router is skipped if any paths not
17468 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17469
17470 .cindex "NFS"
17471 If &[stat()]& cannot determine whether a file exists or not, delivery of
17472 the message is deferred. This can happen when NFS-mounted filesystems are
17473 unavailable.
17474
17475 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17476 options, so you cannot use it to check for the existence of a file in which to
17477 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17478 full list of the order in which preconditions are evaluated.) However, as
17479 these options are all expanded, you can use the &%exists%& expansion condition
17480 to make such tests. The &%require_files%& option is intended for checking files
17481 that the router may be going to use internally, or which are needed by a
17482 transport (for example &_.procmailrc_&).
17483
17484 During delivery, the &[stat()]& function is run as root, but there is a
17485 facility for some checking of the accessibility of a file by another user.
17486 This is not a proper permissions check, but just a &"rough"& check that
17487 operates as follows:
17488
17489 If an item in a &%require_files%& list does not contain any forward slash
17490 characters, it is taken to be the user (and optional group, separated by a
17491 comma) to be checked for subsequent files in the list. If no group is specified
17492 but the user is specified symbolically, the gid associated with the uid is
17493 used. For example:
17494 .code
17495 require_files = mail:/some/file
17496 require_files = $local_part:$home/.procmailrc
17497 .endd
17498 If a user or group name in a &%require_files%& list does not exist, the
17499 &%require_files%& condition fails.
17500
17501 Exim performs the check by scanning along the components of the file path, and
17502 checking the access for the given uid and gid. It checks for &"x"& access on
17503 directories, and &"r"& access on the final file. Note that this means that file
17504 access control lists, if the operating system has them, are ignored.
17505
17506 &*Warning 1*&: When the router is being run to verify addresses for an
17507 incoming SMTP message, Exim is not running as root, but under its own uid. This
17508 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17509 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17510 user is not permitted to read one of the directories on the file's path.
17511
17512 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17513 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17514 without root access. In this case, if a check for access by a particular user
17515 is requested, Exim creates a subprocess that runs as that user, and tries the
17516 check again in that process.
17517
17518 The default action for handling an unresolved EACCES is to consider it to
17519 be caused by a configuration error, and routing is deferred because the
17520 existence or non-existence of the file cannot be determined. However, in some
17521 circumstances it may be desirable to treat this condition as if the file did
17522 not exist. If the file name (or the exclamation mark that precedes the file
17523 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17524 as if the file did not exist. For example:
17525 .code
17526 require_files = +/some/file
17527 .endd
17528 If the router is not an essential part of verification (for example, it
17529 handles users' &_.forward_& files), another solution is to set the &%verify%&
17530 option false so that the router is skipped when verifying.
17531
17532
17533
17534 .option retry_use_local_part routers boolean "see below"
17535 .cindex "hints database" "retry keys"
17536 .cindex "local part" "in retry keys"
17537 When a delivery suffers a temporary routing failure, a retry record is created
17538 in Exim's hints database. For addresses whose routing depends only on the
17539 domain, the key for the retry record should not involve the local part, but for
17540 other addresses, both the domain and the local part should be included.
17541 Usually, remote routing is of the former kind, and local routing is of the
17542 latter kind.
17543
17544 This option controls whether the local part is used to form the key for retry
17545 hints for addresses that suffer temporary errors while being handled by this
17546 router. The default value is true for any router that has &%check_local_user%&
17547 set, and false otherwise. Note that this option does not apply to hints keys
17548 for transport delays; they are controlled by a generic transport option of the
17549 same name.
17550
17551 The setting of &%retry_use_local_part%& applies only to the router on which it
17552 appears. If the router generates child addresses, they are routed
17553 independently; this setting does not become attached to them.
17554
17555
17556
17557 .option router_home_directory routers string&!! unset
17558 .cindex "router" "home directory for"
17559 .cindex "home directory" "for router"
17560 .vindex "&$home$&"
17561 This option sets a home directory for use while the router is running. (Compare
17562 &%transport_home_directory%&, which sets a home directory for later
17563 transporting.) In particular, if used on a &(redirect)& router, this option
17564 sets a value for &$home$& while a filter is running. The value is expanded;
17565 forced expansion failure causes the option to be ignored &-- other failures
17566 cause the router to defer.
17567
17568 Expansion of &%router_home_directory%& happens immediately after the
17569 &%check_local_user%& test (if configured), before any further expansions take
17570 place.
17571 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17572 are evaluated.)
17573 While the router is running, &%router_home_directory%& overrides the value of
17574 &$home$& that came from &%check_local_user%&.
17575
17576 When a router accepts an address and assigns it to a local transport (including
17577 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17578 delivery), the home directory setting for the transport is taken from the first
17579 of these values that is set:
17580
17581 .ilist
17582 The &%home_directory%& option on the transport;
17583 .next
17584 The &%transport_home_directory%& option on the router;
17585 .next
17586 The password data if &%check_local_user%& is set on the router;
17587 .next
17588 The &%router_home_directory%& option on the router.
17589 .endlist
17590
17591 In other words, &%router_home_directory%& overrides the password data for the
17592 router, but not for the transport.
17593
17594
17595
17596 .option self routers string freeze
17597 .cindex "MX record" "pointing to local host"
17598 .cindex "local host" "MX pointing to"
17599 This option applies to those routers that use a recipient address to find a
17600 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17601 and &(manualroute)& routers.
17602 Certain configurations of the &(queryprogram)& router can also specify a list
17603 of remote hosts.
17604 Usually such routers are configured to send the message to a remote host via an
17605 &(smtp)& transport. The &%self%& option specifies what happens when the first
17606 host on the list turns out to be the local host.
17607 The way in which Exim checks for the local host is described in section
17608 &<<SECTreclocipadd>>&.
17609
17610 Normally this situation indicates either an error in Exim's configuration (for
17611 example, the router should be configured not to process this domain), or an
17612 error in the DNS (for example, the MX should not point to this host). For this
17613 reason, the default action is to log the incident, defer the address, and
17614 freeze the message. The following alternatives are provided for use in special
17615 cases:
17616
17617 .vlist
17618 .vitem &%defer%&
17619 Delivery of the message is tried again later, but the message is not frozen.
17620
17621 .vitem "&%reroute%&: <&'domain'&>"
17622 The domain is changed to the given domain, and the address is passed back to
17623 be reprocessed by the routers. No rewriting of headers takes place. This
17624 behaviour is essentially a redirection.
17625
17626 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17627 The domain is changed to the given domain, and the address is passed back to be
17628 reprocessed by the routers. Any headers that contain the original domain are
17629 rewritten.
17630
17631 .vitem &%pass%&
17632 .oindex "&%more%&"
17633 .vindex "&$self_hostname$&"
17634 The router passes the address to the next router, or to the router named in the
17635 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17636 subsequent routing and delivery, the variable &$self_hostname$& contains the
17637 name of the local host that the router encountered. This can be used to
17638 distinguish between different cases for hosts with multiple names. The
17639 combination
17640 .code
17641 self = pass
17642 no_more
17643 .endd
17644 ensures that only those addresses that routed to the local host are passed on.
17645 Without &%no_more%&, addresses that were declined for other reasons would also
17646 be passed to the next router.
17647
17648 .vitem &%fail%&
17649 Delivery fails and an error report is generated.
17650
17651 .vitem &%send%&
17652 .cindex "local host" "sending to"
17653 The anomaly is ignored and the address is queued for the transport. This
17654 setting should be used with extreme caution. For an &(smtp)& transport, it
17655 makes sense only in cases where the program that is listening on the SMTP port
17656 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17657 different configuration file that handles the domain in another way.
17658 .endlist
17659
17660
17661
17662 .option senders routers&!? "address list&!!" unset
17663 .cindex "router" "checking senders"
17664 If this option is set, the router is skipped unless the message's sender
17665 address matches something on the list.
17666 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17667 are evaluated.
17668
17669 There are issues concerning verification when the running of routers is
17670 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17671 setting, it sets the sender to the null string. When using the &%-bt%& option
17672 to check a configuration file, it is necessary also to use the &%-f%& option to
17673 set an appropriate sender. For incoming mail, the sender is unset when
17674 verifying the sender, but is available when verifying any recipients. If the
17675 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17676 matters.
17677
17678
17679 .option translate_ip_address routers string&!! unset
17680 .cindex "IP address" "translating"
17681 .cindex "packet radio"
17682 .cindex "router" "IP address translation"
17683 There exist some rare networking situations (for example, packet radio) where
17684 it is helpful to be able to translate IP addresses generated by normal routing
17685 mechanisms into other IP addresses, thus performing a kind of manual IP
17686 routing. This should be done only if the normal IP routing of the TCP/IP stack
17687 is inadequate or broken. Because this is an extremely uncommon requirement, the
17688 code to support this option is not included in the Exim binary unless
17689 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17690
17691 .vindex "&$host_address$&"
17692 The &%translate_ip_address%& string is expanded for every IP address generated
17693 by the router, with the generated address set in &$host_address$&. If the
17694 expansion is forced to fail, no action is taken.
17695 For any other expansion error, delivery of the message is deferred.
17696 If the result of the expansion is an IP address, that replaces the original
17697 address; otherwise the result is assumed to be a host name &-- this is looked
17698 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17699 produce one or more replacement IP addresses. For example, to subvert all IP
17700 addresses in some specific networks, this could be added to a router:
17701 .code
17702 translate_ip_address = \
17703   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17704     {$value}fail}}
17705 .endd
17706 The file would contain lines like
17707 .code
17708 10.2.3.128/26    some.host
17709 10.8.4.34/26     10.44.8.15
17710 .endd
17711 You should not make use of this facility unless you really understand what you
17712 are doing.
17713
17714
17715
17716 .option transport routers string&!! unset
17717 This option specifies the transport to be used when a router accepts an address
17718 and sets it up for delivery. A transport is never needed if a router is used
17719 only for verification. The value of the option is expanded at routing time,
17720 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17721 and result must be the name of one of the configured transports. If it is not,
17722 delivery is deferred.
17723
17724 The &%transport%& option is not used by the &(redirect)& router, but it does
17725 have some private options that set up transports for pipe and file deliveries
17726 (see chapter &<<CHAPredirect>>&).
17727
17728
17729
17730 .option transport_current_directory routers string&!! unset
17731 .cindex "current directory for local transport"
17732 This option associates a current directory with any address that is routed
17733 to a local transport. This can happen either because a transport is
17734 explicitly configured for the router, or because it generates a delivery to a
17735 file or a pipe. During the delivery process (that is, at transport time), this
17736 option string is expanded and is set as the current directory, unless
17737 overridden by a setting on the transport.
17738 If the expansion fails for any reason, including forced failure, an error is
17739 logged, and delivery is deferred.
17740 See chapter &<<CHAPenvironment>>& for details of the local delivery
17741 environment.
17742
17743
17744
17745
17746 .option transport_home_directory routers string&!! "see below"
17747 .cindex "home directory" "for local transport"
17748 This option associates a home directory with any address that is routed to a
17749 local transport. This can happen either because a transport is explicitly
17750 configured for the router, or because it generates a delivery to a file or a
17751 pipe. During the delivery process (that is, at transport time), the option
17752 string is expanded and is set as the home directory, unless overridden by a
17753 setting of &%home_directory%& on the transport.
17754 If the expansion fails for any reason, including forced failure, an error is
17755 logged, and delivery is deferred.
17756
17757 If the transport does not specify a home directory, and
17758 &%transport_home_directory%& is not set for the router, the home directory for
17759 the transport is taken from the password data if &%check_local_user%& is set for
17760 the router. Otherwise it is taken from &%router_home_directory%& if that option
17761 is set; if not, no home directory is set for the transport.
17762
17763 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17764 environment.
17765
17766
17767
17768
17769 .option unseen routers boolean&!! false
17770 .cindex "router" "carrying on after success"
17771 The result of string expansion for this option must be a valid boolean value,
17772 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17773 result causes an error, and delivery is deferred. If the expansion is forced to
17774 fail, the default value for the option (false) is used. Other failures cause
17775 delivery to be deferred.
17776
17777 When this option is set true, routing does not cease if the router accepts the
17778 address. Instead, a copy of the incoming address is passed to the next router,
17779 overriding a false setting of &%more%&. There is little point in setting
17780 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17781 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17782 sometimes true and sometimes false).
17783
17784 .cindex "copy of message (&%unseen%& option)"
17785 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17786 qualifier in filter files. It can be used to cause copies of messages to be
17787 delivered to some other destination, while also carrying out a normal delivery.
17788 In effect, the current address is made into a &"parent"& that has two children
17789 &-- one that is delivered as specified by this router, and a clone that goes on
17790 to be routed further. For this reason, &%unseen%& may not be combined with the
17791 &%one_time%& option in a &(redirect)& router.
17792
17793 &*Warning*&: Header lines added to the address (or specified for removal) by
17794 this router or by previous routers affect the &"unseen"& copy of the message
17795 only. The clone that continues to be processed by further routers starts with
17796 no added headers and none specified for removal. For a &%redirect%& router, if
17797 a generated address is the same as the incoming address, this can lead to
17798 duplicate addresses with different header modifications. Exim does not do
17799 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17800 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17801 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17802 &%redirect%& router may be of help.
17803
17804 Unlike the handling of header modifications, any data that was set by the
17805 &%address_data%& option in the current or previous routers &'is'& passed on to
17806 subsequent routers.
17807
17808
17809 .option user routers string&!! "see below"
17810 .cindex "uid (user id)" "local delivery"
17811 .cindex "local transports" "uid and gid"
17812 .cindex "transport" "local"
17813 .cindex "router" "user for filter processing"
17814 .cindex "filter" "user for processing"
17815 When a router queues an address for a transport, and the transport does not
17816 specify a user, the user given here is used when running the delivery process.
17817 The user may be specified numerically or by name. If expansion fails, the
17818 error is logged and delivery is deferred.
17819 This user is also used by the &(redirect)& router when running a filter file.
17820 The default is unset, except when &%check_local_user%& is set. In this case,
17821 the default is taken from the password information. If the user is specified as
17822 a name, and &%group%& is not set, the group associated with the user is used.
17823 See also &%initgroups%& and &%group%& and the discussion in chapter
17824 &<<CHAPenvironment>>&.
17825
17826
17827
17828 .option verify routers&!? boolean true
17829 Setting this option has the effect of setting &%verify_sender%& and
17830 &%verify_recipient%& to the same value.
17831
17832
17833 .option verify_only routers&!? boolean false
17834 .cindex "EXPN" "with &%verify_only%&"
17835 .oindex "&%-bv%&"
17836 .cindex "router" "used only when verifying"
17837 If this option is set, the router is used only when verifying an address,
17838 delivering in cutthrough mode or
17839 testing with the &%-bv%& option, not when actually doing a delivery, testing
17840 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17841 restricted to verifying only senders or recipients by means of
17842 &%verify_sender%& and &%verify_recipient%&.
17843
17844 &*Warning*&: When the router is being run to verify addresses for an incoming
17845 SMTP message, Exim is not running as root, but under its own uid. If the router
17846 accesses any files, you need to make sure that they are accessible to the Exim
17847 user or group.
17848
17849
17850 .option verify_recipient routers&!? boolean true
17851 If this option is false, the router is skipped when verifying recipient
17852 addresses,
17853 delivering in cutthrough mode
17854 or testing recipient verification using &%-bv%&.
17855 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17856 are evaluated.
17857 See also the &$verify_mode$& variable.
17858
17859
17860 .option verify_sender routers&!? boolean true
17861 If this option is false, the router is skipped when verifying sender addresses
17862 or testing sender verification using &%-bvs%&.
17863 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17864 are evaluated.
17865 See also the &$verify_mode$& variable.
17866 .ecindex IIDgenoprou1
17867 .ecindex IIDgenoprou2
17868
17869
17870
17871
17872
17873
17874 . ////////////////////////////////////////////////////////////////////////////
17875 . ////////////////////////////////////////////////////////////////////////////
17876
17877 .chapter "The accept router" "CHID4"
17878 .cindex "&(accept)& router"
17879 .cindex "routers" "&(accept)&"
17880 The &(accept)& router has no private options of its own. Unless it is being
17881 used purely for verification (see &%verify_only%&) a transport is required to
17882 be defined by the generic &%transport%& option. If the preconditions that are
17883 specified by generic options are met, the router accepts the address and queues
17884 it for the given transport. The most common use of this router is for setting
17885 up deliveries to local mailboxes. For example:
17886 .code
17887 localusers:
17888   driver = accept
17889   domains = mydomain.example
17890   check_local_user
17891   transport = local_delivery
17892 .endd
17893 The &%domains%& condition in this example checks the domain of the address, and
17894 &%check_local_user%& checks that the local part is the login of a local user.
17895 When both preconditions are met, the &(accept)& router runs, and queues the
17896 address for the &(local_delivery)& transport.
17897
17898
17899
17900
17901
17902
17903 . ////////////////////////////////////////////////////////////////////////////
17904 . ////////////////////////////////////////////////////////////////////////////
17905
17906 .chapter "The dnslookup router" "CHAPdnslookup"
17907 .scindex IIDdnsrou1 "&(dnslookup)& router"
17908 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17909 The &(dnslookup)& router looks up the hosts that handle mail for the
17910 recipient's domain in the DNS. A transport must always be set for this router,
17911 unless &%verify_only%& is set.
17912
17913 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17914 SRV records. If none are found, or if SRV support is not configured,
17915 MX records are looked up. If no MX records exist, address records are sought.
17916 However, &%mx_domains%& can be set to disable the direct use of address
17917 records.
17918
17919 MX records of equal priority are sorted by Exim into a random order. Exim then
17920 looks for address records for the host names obtained from MX or SRV records.
17921 When a host has more than one IP address, they are sorted into a random order,
17922 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17923 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17924 generic option, the router declines.
17925
17926 Unless they have the highest priority (lowest MX value), MX records that point
17927 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17928 are discarded, together with any other MX records of equal or lower priority.
17929
17930 .cindex "MX record" "pointing to local host"
17931 .cindex "local host" "MX pointing to"
17932 .oindex "&%self%&" "in &(dnslookup)& router"
17933 If the host pointed to by the highest priority MX record, or looked up as an
17934 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17935 happens is controlled by the generic &%self%& option.
17936
17937
17938 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17939 There have been problems with DNS servers when SRV records are looked up.
17940 Some mis-behaving servers return a DNS error or timeout when a non-existent
17941 SRV record is sought. Similar problems have in the past been reported for
17942 MX records. The global &%dns_again_means_nonexist%& option can help with this
17943 problem, but it is heavy-handed because it is a global option.
17944
17945 For this reason, there are two options, &%srv_fail_domains%& and
17946 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17947 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17948 an attempt to look up an SRV or MX record causes one of these results, and the
17949 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17950 such record"&. In the case of an SRV lookup, this means that the router
17951 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17952 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17953 case routing fails.
17954
17955
17956 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17957 .cindex "&(dnslookup)& router" "declines"
17958 There are a few cases where a &(dnslookup)& router will decline to accept
17959 an address; if such a router is expected to handle "all remaining non-local
17960 domains", then it is important to set &%no_more%&.
17961
17962 Reasons for a &(dnslookup)& router to decline currently include:
17963 .ilist
17964 The domain does not exist in DNS
17965 .next
17966 The domain exists but the MX record's host part is just "."; this is a common
17967 convention (borrowed from SRV) used to indicate that there is no such service
17968 for this domain and to not fall back to trying A/AAAA records.
17969 .next
17970 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17971 .next
17972 MX record points to a non-existent host.
17973 .next
17974 MX record points to an IP address and the main section option
17975 &%allow_mx_to_ip%& is not set.
17976 .next
17977 MX records exist and point to valid hosts, but all hosts resolve only to
17978 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17979 .next
17980 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17981 &%dns_check_names_pattern%& for handling one variant of this)
17982 .next
17983 &%check_secondary_mx%& is set on this router but the local host can
17984 not be found in the MX records (see below)
17985 .endlist
17986
17987
17988
17989
17990 .section "Private options for dnslookup" "SECID118"
17991 .cindex "options" "&(dnslookup)& router"
17992 The private options for the &(dnslookup)& router are as follows:
17993
17994 .option check_secondary_mx dnslookup boolean false
17995 .cindex "MX record" "checking for secondary"
17996 If this option is set, the router declines unless the local host is found in
17997 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17998 process domains for which the local host is a secondary mail exchanger
17999 differently to other domains. The way in which Exim decides whether a host is
18000 the local host is described in section &<<SECTreclocipadd>>&.
18001
18002
18003 .option check_srv dnslookup string&!! unset
18004 .cindex "SRV record" "enabling use of"
18005 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18006 addition to MX and address records. The support is disabled by default. To
18007 enable SRV support, set the &%check_srv%& option to the name of the service
18008 required. For example,
18009 .code
18010 check_srv = smtp
18011 .endd
18012 looks for SRV records that refer to the normal smtp service. The option is
18013 expanded, so the service name can vary from message to message or address
18014 to address. This might be helpful if SRV records are being used for a
18015 submission service. If the expansion is forced to fail, the &%check_srv%&
18016 option is ignored, and the router proceeds to look for MX records in the
18017 normal way.
18018
18019 When the expansion succeeds, the router searches first for SRV records for
18020 the given service (it assumes TCP protocol). A single SRV record with a
18021 host name that consists of just a single dot indicates &"no such service for
18022 this domain"&; if this is encountered, the router declines. If other kinds of
18023 SRV record are found, they are used to construct a host list for delivery
18024 according to the rules of RFC 2782. MX records are not sought in this case.
18025
18026 When no SRV records are found, MX records (and address records) are sought in
18027 the traditional way. In other words, SRV records take precedence over MX
18028 records, just as MX records take precedence over address records. Note that
18029 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18030 defined it. It is apparently believed that MX records are sufficient for email
18031 and that SRV records should not be used for this purpose. However, SRV records
18032 have an additional &"weight"& feature which some people might find useful when
18033 trying to split an SMTP load between hosts of different power.
18034
18035 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18036 when there is a DNS lookup error.
18037
18038
18039
18040 .option dnssec_request_domains dnslookup "domain list&!!" unset
18041 .cindex "MX record" "security"
18042 .cindex "DNSSEC" "MX lookup"
18043 .cindex "security" "MX lookup"
18044 .cindex "DNS" "DNSSEC"
18045 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18046 the dnssec request bit set.
18047 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18048
18049
18050
18051 .option dnssec_require_domains dnslookup "domain list&!!" unset
18052 .cindex "MX record" "security"
18053 .cindex "DNSSEC" "MX lookup"
18054 .cindex "security" "MX lookup"
18055 .cindex "DNS" "DNSSEC"
18056 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18057 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18058 (AD bit) set wil be ignored and logged as a host-lookup failure.
18059 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18060
18061
18062
18063 .option mx_domains dnslookup "domain list&!!" unset
18064 .cindex "MX record" "required to exist"
18065 .cindex "SRV record" "required to exist"
18066 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18067 record in order to be recognized. (The name of this option could be improved.)
18068 For example, if all the mail hosts in &'fict.example'& are known to have MX
18069 records, except for those in &'discworld.fict.example'&, you could use this
18070 setting:
18071 .code
18072 mx_domains = ! *.discworld.fict.example : *.fict.example
18073 .endd
18074 This specifies that messages addressed to a domain that matches the list but
18075 has no MX record should be bounced immediately instead of being routed using
18076 the address record.
18077
18078
18079 .option mx_fail_domains dnslookup "domain list&!!" unset
18080 If the DNS lookup for MX records for one of the domains in this list causes a
18081 DNS lookup error, Exim behaves as if no MX records were found. See section
18082 &<<SECTprowitdnsloo>>& for more discussion.
18083
18084
18085
18086
18087 .option qualify_single dnslookup boolean true
18088 .cindex "DNS" "resolver options"
18089 .cindex "DNS" "qualifying single-component names"
18090 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18091 lookups. Typically, but not standardly, this causes the resolver to qualify
18092 single-component names with the default domain. For example, on a machine
18093 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18094 &'thesaurus.ref.example'& inside the resolver. For details of what your
18095 resolver actually does, consult your man pages for &'resolver'& and
18096 &'resolv.conf'&.
18097
18098
18099
18100 .option rewrite_headers dnslookup boolean true
18101 .cindex "rewriting" "header lines"
18102 .cindex "header lines" "rewriting"
18103 If the domain name in the address that is being processed is not fully
18104 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18105 an address is specified as &'dormouse@teaparty'&, the domain might be
18106 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18107 occur as a result of setting the &%widen_domains%& option. If
18108 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18109 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18110 header lines of the message are rewritten with the full domain name.
18111
18112 This option should be turned off only when it is known that no message is
18113 ever going to be sent outside an environment where the abbreviation makes
18114 sense.
18115
18116 When an MX record is looked up in the DNS and matches a wildcard record, name
18117 servers normally return a record containing the name that has been looked up,
18118 making it impossible to detect whether a wildcard was present or not. However,
18119 some name servers have recently been seen to return the wildcard entry. If the
18120 name returned by a DNS lookup begins with an asterisk, it is not used for
18121 header rewriting.
18122
18123
18124 .option same_domain_copy_routing dnslookup boolean false
18125 .cindex "address" "copying routing"
18126 Addresses with the same domain are normally routed by the &(dnslookup)& router
18127 to the same list of hosts. However, this cannot be presumed, because the router
18128 options and preconditions may refer to the local part of the address. By
18129 default, therefore, Exim routes each address in a message independently. DNS
18130 servers run caches, so repeated DNS lookups are not normally expensive, and in
18131 any case, personal messages rarely have more than a few recipients.
18132
18133 If you are running mailing lists with large numbers of subscribers at the same
18134 domain, and you are using a &(dnslookup)& router which is independent of the
18135 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18136 lookups for identical domains in one message. In this case, when &(dnslookup)&
18137 routes an address to a remote transport, any other unrouted addresses in the
18138 message that have the same domain are automatically given the same routing
18139 without processing them independently,
18140 provided the following conditions are met:
18141
18142 .ilist
18143 No router that processed the address specified &%headers_add%& or
18144 &%headers_remove%&.
18145 .next
18146 The router did not change the address in any way, for example, by &"widening"&
18147 the domain.
18148 .endlist
18149
18150
18151
18152
18153 .option search_parents dnslookup boolean false
18154 .cindex "DNS" "resolver options"
18155 When this option is true, the resolver option RES_DNSRCH is set for DNS
18156 lookups. This is different from the &%qualify_single%& option in that it
18157 applies to domains containing dots. Typically, but not standardly, it causes
18158 the resolver to search for the name in the current domain and in parent
18159 domains. For example, on a machine in the &'fict.example'& domain, if looking
18160 up &'teaparty.wonderland'& failed, the resolver would try
18161 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18162 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18163
18164 Setting this option true can cause problems in domains that have a wildcard MX
18165 record, because any domain that does not have its own MX record matches the
18166 local wildcard.
18167
18168
18169
18170 .option srv_fail_domains dnslookup "domain list&!!" unset
18171 If the DNS lookup for SRV records for one of the domains in this list causes a
18172 DNS lookup error, Exim behaves as if no SRV records were found. See section
18173 &<<SECTprowitdnsloo>>& for more discussion.
18174
18175
18176
18177
18178 .option widen_domains dnslookup "string list" unset
18179 .cindex "domain" "partial; widening"
18180 If a DNS lookup fails and this option is set, each of its strings in turn is
18181 added onto the end of the domain, and the lookup is tried again. For example,
18182 if
18183 .code
18184 widen_domains = fict.example:ref.example
18185 .endd
18186 is set and a lookup of &'klingon.dictionary'& fails,
18187 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18188 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18189 and &%search_parents%& options can cause some widening to be undertaken inside
18190 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18191 when verifying, unless &%rewrite_headers%& is false (not the default).
18192
18193
18194 .section "Effect of qualify_single and search_parents" "SECID119"
18195 When a domain from an envelope recipient is changed by the resolver as a result
18196 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18197 corresponding address in the message's header lines unless &%rewrite_headers%&
18198 is set false. Exim then re-routes the address, using the full domain.
18199
18200 These two options affect only the DNS lookup that takes place inside the router
18201 for the domain of the address that is being routed. They do not affect lookups
18202 such as that implied by
18203 .code
18204 domains = @mx_any
18205 .endd
18206 that may happen while processing a router precondition before the router is
18207 entered. No widening ever takes place for these lookups.
18208 .ecindex IIDdnsrou1
18209 .ecindex IIDdnsrou2
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219 . ////////////////////////////////////////////////////////////////////////////
18220 . ////////////////////////////////////////////////////////////////////////////
18221
18222 .chapter "The ipliteral router" "CHID5"
18223 .cindex "&(ipliteral)& router"
18224 .cindex "domain literal" "routing"
18225 .cindex "routers" "&(ipliteral)&"
18226 This router has no private options. Unless it is being used purely for
18227 verification (see &%verify_only%&) a transport is required to be defined by the
18228 generic &%transport%& option. The router accepts the address if its domain part
18229 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18230 router handles the address
18231 .code
18232 root@[192.168.1.1]
18233 .endd
18234 by setting up delivery to the host with that IP address. IPv4 domain literals
18235 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18236 are similar, but the address is preceded by &`ipv6:`&. For example:
18237 .code
18238 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18239 .endd
18240 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18241 grounds that sooner or later somebody will try it.
18242
18243 .oindex "&%self%&" "in &(ipliteral)& router"
18244 If the IP address matches something in &%ignore_target_hosts%&, the router
18245 declines. If an IP literal turns out to refer to the local host, the generic
18246 &%self%& option determines what happens.
18247
18248 The RFCs require support for domain literals; however, their use is
18249 controversial in today's Internet. If you want to use this router, you must
18250 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18251 Exim will not recognize the domain literal syntax in addresses.
18252
18253
18254
18255 . ////////////////////////////////////////////////////////////////////////////
18256 . ////////////////////////////////////////////////////////////////////////////
18257
18258 .chapter "The iplookup router" "CHID6"
18259 .cindex "&(iplookup)& router"
18260 .cindex "routers" "&(iplookup)&"
18261 The &(iplookup)& router was written to fulfil a specific requirement in
18262 Cambridge University (which in fact no longer exists). For this reason, it is
18263 not included in the binary of Exim by default. If you want to include it, you
18264 must set
18265 .code
18266 ROUTER_IPLOOKUP=yes
18267 .endd
18268 in your &_Local/Makefile_& configuration file.
18269
18270 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18271 connection to one or more specific hosts. The host can then return the same or
18272 a different address &-- in effect rewriting the recipient address in the
18273 message's envelope. The new address is then passed on to subsequent routers. If
18274 this process fails, the address can be passed on to other routers, or delivery
18275 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18276 must not be specified for it.
18277
18278 .cindex "options" "&(iplookup)& router"
18279 .option hosts iplookup string unset
18280 This option must be supplied. Its value is a colon-separated list of host
18281 names. The hosts are looked up using &[gethostbyname()]&
18282 (or &[getipnodebyname()]& when available)
18283 and are tried in order until one responds to the query. If none respond, what
18284 happens is controlled by &%optional%&.
18285
18286
18287 .option optional iplookup boolean false
18288 If &%optional%& is true, if no response is obtained from any host, the address
18289 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18290 delivery to the address is deferred.
18291
18292
18293 .option port iplookup integer 0
18294 .cindex "port" "&(iplookup)& router"
18295 This option must be supplied. It specifies the port number for the TCP or UDP
18296 call.
18297
18298
18299 .option protocol iplookup string udp
18300 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18301 protocols is to be used.
18302
18303
18304 .option query iplookup string&!! "see below"
18305 This defines the content of the query that is sent to the remote hosts. The
18306 default value is:
18307 .code
18308 $local_part@$domain $local_part@$domain
18309 .endd
18310 The repetition serves as a way of checking that a response is to the correct
18311 query in the default case (see &%response_pattern%& below).
18312
18313
18314 .option reroute iplookup string&!! unset
18315 If this option is not set, the rerouted address is precisely the byte string
18316 returned by the remote host, up to the first white space, if any. If set, the
18317 string is expanded to form the rerouted address. It can include parts matched
18318 in the response by &%response_pattern%& by means of numeric variables such as
18319 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18320 whether or not a pattern is in use. In all cases, the rerouted address must end
18321 up in the form &'local_part@domain'&.
18322
18323
18324 .option response_pattern iplookup string unset
18325 This option can be set to a regular expression that is applied to the string
18326 returned from the remote host. If the pattern does not match the response, the
18327 router declines. If &%response_pattern%& is not set, no checking of the
18328 response is done, unless the query was defaulted, in which case there is a
18329 check that the text returned after the first white space is the original
18330 address. This checks that the answer that has been received is in response to
18331 the correct question. For example, if the response is just a new domain, the
18332 following could be used:
18333 .code
18334 response_pattern = ^([^@]+)$
18335 reroute = $local_part@$1
18336 .endd
18337
18338 .option timeout iplookup time 5s
18339 This specifies the amount of time to wait for a response from the remote
18340 machine. The same timeout is used for the &[connect()]& function for a TCP
18341 call. It does not apply to UDP.
18342
18343
18344
18345
18346 . ////////////////////////////////////////////////////////////////////////////
18347 . ////////////////////////////////////////////////////////////////////////////
18348
18349 .chapter "The manualroute router" "CHID7"
18350 .scindex IIDmanrou1 "&(manualroute)& router"
18351 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18352 .cindex "domain" "manually routing"
18353 The &(manualroute)& router is so-called because it provides a way of manually
18354 routing an address according to its domain. It is mainly used when you want to
18355 route addresses to remote hosts according to your own rules, bypassing the
18356 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18357 route to local transports, a facility that may be useful if you want to save
18358 messages for dial-in hosts in local files.
18359
18360 The &(manualroute)& router compares a list of domain patterns with the domain
18361 it is trying to route. If there is no match, the router declines. Each pattern
18362 has associated with it a list of hosts and some other optional data, which may
18363 include a transport. The combination of a pattern and its data is called a
18364 &"routing rule"&. For patterns that do not have an associated transport, the
18365 generic &%transport%& option must specify a transport, unless the router is
18366 being used purely for verification (see &%verify_only%&).
18367
18368 .vindex "&$host$&"
18369 In the case of verification, matching the domain pattern is sufficient for the
18370 router to accept the address. When actually routing an address for delivery,
18371 an address that matches a domain pattern is queued for the associated
18372 transport. If the transport is not a local one, a host list must be associated
18373 with the pattern; IP addresses are looked up for the hosts, and these are
18374 passed to the transport along with the mail address. For local transports, a
18375 host list is optional. If it is present, it is passed in &$host$& as a single
18376 text string.
18377
18378 The list of routing rules can be provided as an inline string in
18379 &%route_list%&, or the data can be obtained by looking up the domain in a file
18380 or database by setting &%route_data%&. Only one of these settings may appear in
18381 any one instance of &(manualroute)&. The format of routing rules is described
18382 below, following the list of private options.
18383
18384
18385 .section "Private options for manualroute" "SECTprioptman"
18386
18387 .cindex "options" "&(manualroute)& router"
18388 The private options for the &(manualroute)& router are as follows:
18389
18390 .option host_all_ignored manualroute string defer
18391 See &%host_find_failed%&.
18392
18393 .option host_find_failed manualroute string freeze
18394 This option controls what happens when &(manualroute)& tries to find an IP
18395 address for a host, and the host does not exist. The option can be set to one
18396 of the following values:
18397 .code
18398 decline
18399 defer
18400 fail
18401 freeze
18402 ignore
18403 pass
18404 .endd
18405 The default (&"freeze"&) assumes that this state is a serious configuration
18406 error. The difference between &"pass"& and &"decline"& is that the former
18407 forces the address to be passed to the next router (or the router defined by
18408 &%pass_router%&),
18409 .oindex "&%more%&"
18410 overriding &%no_more%&, whereas the latter passes the address to the next
18411 router only if &%more%& is true.
18412
18413 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18414 cannot be found. If all the hosts in the list are ignored, the behaviour is
18415 controlled by the &%host_all_ignored%& option. This takes the same values
18416 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18417
18418 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18419 state; if a host lookup gets a temporary error, delivery is deferred unless the
18420 generic &%pass_on_timeout%& option is set.
18421
18422
18423 .option hosts_randomize manualroute boolean false
18424 .cindex "randomized host list"
18425 .cindex "host" "list of; randomized"
18426 If this option is set, the order of the items in a host list in a routing rule
18427 is randomized each time the list is used, unless an option in the routing rule
18428 overrides (see below). Randomizing the order of a host list can be used to do
18429 crude load sharing. However, if more than one mail address is routed by the
18430 same router to the same host list, the host lists are considered to be the same
18431 (even though they may be randomized into different orders) for the purpose of
18432 deciding whether to batch the deliveries into a single SMTP transaction.
18433
18434 When &%hosts_randomize%& is true, a host list may be split
18435 into groups whose order is separately randomized. This makes it possible to
18436 set up MX-like behaviour. The boundaries between groups are indicated by an
18437 item that is just &`+`& in the host list. For example:
18438 .code
18439 route_list = * host1:host2:host3:+:host4:host5
18440 .endd
18441 The order of the first three hosts and the order of the last two hosts is
18442 randomized for each use, but the first three always end up before the last two.
18443 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18444 randomized host list is passed to an &(smtp)& transport that also has
18445 &%hosts_randomize set%&, the list is not re-randomized.
18446
18447
18448 .option route_data manualroute string&!! unset
18449 If this option is set, it must expand to yield the data part of a routing rule.
18450 Typically, the expansion string includes a lookup based on the domain. For
18451 example:
18452 .code
18453 route_data = ${lookup{$domain}dbm{/etc/routes}}
18454 .endd
18455 If the expansion is forced to fail, or the result is an empty string, the
18456 router declines. Other kinds of expansion failure cause delivery to be
18457 deferred.
18458
18459
18460 .option route_list manualroute "string list" unset
18461 This string is a list of routing rules, in the form defined below. Note that,
18462 unlike most string lists, the items are separated by semicolons. This is so
18463 that they may contain colon-separated host lists.
18464
18465
18466 .option same_domain_copy_routing manualroute boolean false
18467 .cindex "address" "copying routing"
18468 Addresses with the same domain are normally routed by the &(manualroute)&
18469 router to the same list of hosts. However, this cannot be presumed, because the
18470 router options and preconditions may refer to the local part of the address. By
18471 default, therefore, Exim routes each address in a message independently. DNS
18472 servers run caches, so repeated DNS lookups are not normally expensive, and in
18473 any case, personal messages rarely have more than a few recipients.
18474
18475 If you are running mailing lists with large numbers of subscribers at the same
18476 domain, and you are using a &(manualroute)& router which is independent of the
18477 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18478 lookups for identical domains in one message. In this case, when
18479 &(manualroute)& routes an address to a remote transport, any other unrouted
18480 addresses in the message that have the same domain are automatically given the
18481 same routing without processing them independently. However, this is only done
18482 if &%headers_add%& and &%headers_remove%& are unset.
18483
18484
18485
18486
18487 .section "Routing rules in route_list" "SECID120"
18488 The value of &%route_list%& is a string consisting of a sequence of routing
18489 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18490 entered as two semicolons. Alternatively, the list separator can be changed as
18491 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18492 Empty rules are ignored. The format of each rule is
18493 .display
18494 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18495 .endd
18496 The following example contains two rules, each with a simple domain pattern and
18497 no options:
18498 .code
18499 route_list = \
18500   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18501   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18502 .endd
18503 The three parts of a rule are separated by white space. The pattern and the
18504 list of hosts can be enclosed in quotes if necessary, and if they are, the
18505 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18506 single domain pattern, which is the only mandatory item in the rule. The
18507 pattern is in the same format as one item in a domain list (see section
18508 &<<SECTdomainlist>>&),
18509 except that it may not be the name of an interpolated file.
18510 That is, it may be wildcarded, or a regular expression, or a file or database
18511 lookup (with semicolons doubled, because of the use of semicolon as a separator
18512 in a &%route_list%&).
18513
18514 The rules in &%route_list%& are searched in order until one of the patterns
18515 matches the domain that is being routed. The list of hosts and then options are
18516 then used as described below. If there is no match, the router declines. When
18517 &%route_list%& is set, &%route_data%& must not be set.
18518
18519
18520
18521 .section "Routing rules in route_data" "SECID121"
18522 The use of &%route_list%& is convenient when there are only a small number of
18523 routing rules. For larger numbers, it is easier to use a file or database to
18524 hold the routing information, and use the &%route_data%& option instead.
18525 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18526 Most commonly, &%route_data%& is set as a string that contains an
18527 expansion lookup. For example, suppose we place two routing rules in a file
18528 like this:
18529 .code
18530 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18531 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18532 .endd
18533 This data can be accessed by setting
18534 .code
18535 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18536 .endd
18537 Failure of the lookup results in an empty string, causing the router to
18538 decline. However, you do not have to use a lookup in &%route_data%&. The only
18539 requirement is that the result of expanding the string is a list of hosts,
18540 possibly followed by options, separated by white space. The list of hosts must
18541 be enclosed in quotes if it contains white space.
18542
18543
18544
18545
18546 .section "Format of the list of hosts" "SECID122"
18547 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18548 always separately expanded before use. If the expansion fails, the router
18549 declines. The result of the expansion must be a colon-separated list of names
18550 and/or IP addresses, optionally also including ports. The format of each item
18551 in the list is described in the next section. The list separator can be changed
18552 as described in section &<<SECTlistconstruct>>&.
18553
18554 If the list of hosts was obtained from a &%route_list%& item, the following
18555 variables are set during its expansion:
18556
18557 .ilist
18558 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18559 If the domain was matched against a regular expression, the numeric variables
18560 &$1$&, &$2$&, etc. may be set. For example:
18561 .code
18562 route_list = ^domain(\d+)   host-$1.text.example
18563 .endd
18564 .next
18565 &$0$& is always set to the entire domain.
18566 .next
18567 &$1$& is also set when partial matching is done in a file lookup.
18568
18569 .next
18570 .vindex "&$value$&"
18571 If the pattern that matched the domain was a lookup item, the data that was
18572 looked up is available in the expansion variable &$value$&. For example:
18573 .code
18574 route_list = lsearch;;/some/file.routes  $value
18575 .endd
18576 .endlist
18577
18578 Note the doubling of the semicolon in the pattern that is necessary because
18579 semicolon is the default route list separator.
18580
18581
18582
18583 .section "Format of one host item" "SECTformatonehostitem"
18584 Each item in the list of hosts is either a host name or an IP address,
18585 optionally with an attached port number. When no port is given, an IP address
18586 is not enclosed in brackets. When a port is specified, it overrides the port
18587 specification on the transport. The port is separated from the name or address
18588 by a colon. This leads to some complications:
18589
18590 .ilist
18591 Because colon is the default separator for the list of hosts, either
18592 the colon that specifies a port must be doubled, or the list separator must
18593 be changed. The following two examples have the same effect:
18594 .code
18595 route_list = * "host1.tld::1225 : host2.tld::1226"
18596 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18597 .endd
18598 .next
18599 When IPv6 addresses are involved, it gets worse, because they contain
18600 colons of their own. To make this case easier, it is permitted to
18601 enclose an IP address (either v4 or v6) in square brackets if a port
18602 number follows. For example:
18603 .code
18604 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18605 .endd
18606 .endlist
18607
18608 .section "How the list of hosts is used" "SECThostshowused"
18609 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18610 the hosts is tried, in the order specified, when carrying out the SMTP
18611 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18612 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18613 transport.
18614
18615 Hosts may be listed by name or by IP address. An unadorned name in the list of
18616 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18617 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18618 records in the DNS. For example:
18619 .code
18620 route_list = *  x.y.z:p.q.r/MX:e.f.g
18621 .endd
18622 If this feature is used with a port specifier, the port must come last. For
18623 example:
18624 .code
18625 route_list = *  dom1.tld/mx::1225
18626 .endd
18627 If the &%hosts_randomize%& option is set, the order of the items in the list is
18628 randomized before any lookups are done. Exim then scans the list; for any name
18629 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18630 be an interface on the local host and the item is not the first in the list,
18631 Exim discards it and any subsequent items. If it is the first item, what
18632 happens is controlled by the
18633 .oindex "&%self%&" "in &(manualroute)& router"
18634 &%self%& option of the router.
18635
18636 A name on the list that is followed by &`/MX`& is replaced with the list of
18637 hosts obtained by looking up MX records for the name. This is always a DNS
18638 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18639 below) are not relevant here. The order of these hosts is determined by the
18640 preference values in the MX records, according to the usual rules. Because
18641 randomizing happens before the MX lookup, it does not affect the order that is
18642 defined by MX preferences.
18643
18644 If the local host is present in the sublist obtained from MX records, but is
18645 not the most preferred host in that list, it and any equally or less
18646 preferred hosts are removed before the sublist is inserted into the main list.
18647
18648 If the local host is the most preferred host in the MX list, what happens
18649 depends on where in the original list of hosts the &`/MX`& item appears. If it
18650 is not the first item (that is, there are previous hosts in the main list),
18651 Exim discards this name and any subsequent items in the main list.
18652
18653 If the MX item is first in the list of hosts, and the local host is the
18654 most preferred host, what happens is controlled by the &%self%& option of the
18655 router.
18656
18657 DNS failures when lookup up the MX records are treated in the same way as DNS
18658 failures when looking up IP addresses: &%pass_on_timeout%& and
18659 &%host_find_failed%& are used when relevant.
18660
18661 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18662 whether obtained from an MX lookup or not.
18663
18664
18665
18666 .section "How the options are used" "SECThowoptused"
18667 The options are a sequence of words; in practice no more than three are ever
18668 present. One of the words can be the name of a transport; this overrides the
18669 &%transport%& option on the router for this particular routing rule only. The
18670 other words (if present) control randomization of the list of hosts on a
18671 per-rule basis, and how the IP addresses of the hosts are to be found when
18672 routing to a remote transport. These options are as follows:
18673
18674 .ilist
18675 &%randomize%&: randomize the order of the hosts in this list, overriding the
18676 setting of &%hosts_randomize%& for this routing rule only.
18677 .next
18678 &%no_randomize%&: do not randomize the order of the hosts in this list,
18679 overriding the setting of &%hosts_randomize%& for this routing rule only.
18680 .next
18681 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18682 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18683 also look in &_/etc/hosts_& or other sources of information.
18684 .next
18685 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18686 no address records are found. If there is a temporary DNS error (such as a
18687 timeout), delivery is deferred.
18688 .endlist
18689
18690 For example:
18691 .code
18692 route_list = domain1  host1:host2:host3  randomize bydns;\
18693              domain2  host4:host5
18694 .endd
18695 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18696 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18697 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18698 or &[gethostbyname()]&, and the result of the lookup is the result of that
18699 call.
18700
18701 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18702 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18703 instead of TRY_AGAIN. That is why the default action is to try a DNS
18704 lookup first. Only if that gives a definite &"no such host"& is the local
18705 function called.
18706
18707
18708
18709 If no IP address for a host can be found, what happens is controlled by the
18710 &%host_find_failed%& option.
18711
18712 .vindex "&$host$&"
18713 When an address is routed to a local transport, IP addresses are not looked up.
18714 The host list is passed to the transport in the &$host$& variable.
18715
18716
18717
18718 .section "Manualroute examples" "SECID123"
18719 In some of the examples that follow, the presence of the &%remote_smtp%&
18720 transport, as defined in the default configuration file, is assumed:
18721
18722 .ilist
18723 .cindex "smart host" "example router"
18724 The &(manualroute)& router can be used to forward all external mail to a
18725 &'smart host'&. If you have set up, in the main part of the configuration, a
18726 named domain list that contains your local domains, for example:
18727 .code
18728 domainlist local_domains = my.domain.example
18729 .endd
18730 You can arrange for all other domains to be routed to a smart host by making
18731 your first router something like this:
18732 .code
18733 smart_route:
18734   driver = manualroute
18735   domains = !+local_domains
18736   transport = remote_smtp
18737   route_list = * smarthost.ref.example
18738 .endd
18739 This causes all non-local addresses to be sent to the single host
18740 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18741 they are tried in order
18742 (but you can use &%hosts_randomize%& to vary the order each time).
18743 Another way of configuring the same thing is this:
18744 .code
18745 smart_route:
18746   driver = manualroute
18747   transport = remote_smtp
18748   route_list = !+local_domains  smarthost.ref.example
18749 .endd
18750 There is no difference in behaviour between these two routers as they stand.
18751 However, they behave differently if &%no_more%& is added to them. In the first
18752 example, the router is skipped if the domain does not match the &%domains%&
18753 precondition; the following router is always tried. If the router runs, it
18754 always matches the domain and so can never decline. Therefore, &%no_more%&
18755 would have no effect. In the second case, the router is never skipped; it
18756 always runs. However, if it doesn't match the domain, it declines. In this case
18757 &%no_more%& would prevent subsequent routers from running.
18758
18759 .next
18760 .cindex "mail hub example"
18761 A &'mail hub'& is a host which receives mail for a number of domains via MX
18762 records in the DNS and delivers it via its own private routing mechanism. Often
18763 the final destinations are behind a firewall, with the mail hub being the one
18764 machine that can connect to machines both inside and outside the firewall. The
18765 &(manualroute)& router is usually used on a mail hub to route incoming messages
18766 to the correct hosts. For a small number of domains, the routing can be inline,
18767 using the &%route_list%& option, but for a larger number a file or database
18768 lookup is easier to manage.
18769
18770 If the domain names are in fact the names of the machines to which the mail is
18771 to be sent by the mail hub, the configuration can be quite simple. For
18772 example:
18773 .code
18774 hub_route:
18775   driver = manualroute
18776   transport = remote_smtp
18777   route_list = *.rhodes.tvs.example  $domain
18778 .endd
18779 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18780 whose names are the same as the mail domains. A similar approach can be taken
18781 if the host name can be obtained from the domain name by a string manipulation
18782 that the expansion facilities can handle. Otherwise, a lookup based on the
18783 domain can be used to find the host:
18784 .code
18785 through_firewall:
18786   driver = manualroute
18787   transport = remote_smtp
18788   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18789 .endd
18790 The result of the lookup must be the name or IP address of the host (or
18791 hosts) to which the address is to be routed. If the lookup fails, the route
18792 data is empty, causing the router to decline. The address then passes to the
18793 next router.
18794
18795 .next
18796 .cindex "batched SMTP output example"
18797 .cindex "SMTP" "batched outgoing; example"
18798 You can use &(manualroute)& to deliver messages to pipes or files in batched
18799 SMTP format for onward transportation by some other means. This is one way of
18800 storing mail for a dial-up host when it is not connected. The route list entry
18801 can be as simple as a single domain name in a configuration like this:
18802 .code
18803 save_in_file:
18804   driver = manualroute
18805   transport = batchsmtp_appendfile
18806   route_list = saved.domain.example
18807 .endd
18808 though often a pattern is used to pick up more than one domain. If there are
18809 several domains or groups of domains with different transport requirements,
18810 different transports can be listed in the routing information:
18811 .code
18812 save_in_file:
18813   driver = manualroute
18814   route_list = \
18815     *.saved.domain1.example  $domain  batch_appendfile; \
18816     *.saved.domain2.example  \
18817       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18818       batch_pipe
18819 .endd
18820 .vindex "&$domain$&"
18821 .vindex "&$host$&"
18822 The first of these just passes the domain in the &$host$& variable, which
18823 doesn't achieve much (since it is also in &$domain$&), but the second does a
18824 file lookup to find a value to pass, causing the router to decline to handle
18825 the address if the lookup fails.
18826
18827 .next
18828 .cindex "UUCP" "example of router for"
18829 Routing mail directly to UUCP software is a specific case of the use of
18830 &(manualroute)& in a gateway to another mail environment. This is an example of
18831 one way it can be done:
18832 .code
18833 # Transport
18834 uucp:
18835   driver = pipe
18836   user = nobody
18837   command = /usr/local/bin/uux -r - \
18838     ${substr_-5:$host}!rmail ${local_part}
18839   return_fail_output = true
18840
18841 # Router
18842 uucphost:
18843   transport = uucp
18844   driver = manualroute
18845   route_data = \
18846     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18847 .endd
18848 The file &_/usr/local/exim/uucphosts_& contains entries like
18849 .code
18850 darksite.ethereal.example:           darksite.UUCP
18851 .endd
18852 It can be set up more simply without adding and removing &".UUCP"& but this way
18853 makes clear the distinction between the domain name
18854 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18855 .endlist
18856 .ecindex IIDmanrou1
18857 .ecindex IIDmanrou2
18858
18859
18860
18861
18862
18863
18864
18865
18866 . ////////////////////////////////////////////////////////////////////////////
18867 . ////////////////////////////////////////////////////////////////////////////
18868
18869 .chapter "The queryprogram router" "CHAPdriverlast"
18870 .scindex IIDquerou1 "&(queryprogram)& router"
18871 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18872 .cindex "routing" "by external program"
18873 The &(queryprogram)& router routes an address by running an external command
18874 and acting on its output. This is an expensive way to route, and is intended
18875 mainly for use in lightly-loaded systems, or for performing experiments.
18876 However, if it is possible to use the precondition options (&%domains%&,
18877 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18878 be used in special cases, even on a busy host. There are the following private
18879 options:
18880 .cindex "options" "&(queryprogram)& router"
18881
18882 .option command queryprogram string&!! unset
18883 This option must be set. It specifies the command that is to be run. The
18884 command is split up into a command name and arguments, and then each is
18885 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18886 &<<CHAPpipetransport>>&).
18887
18888
18889 .option command_group queryprogram string unset
18890 .cindex "gid (group id)" "in &(queryprogram)& router"
18891 This option specifies a gid to be set when running the command while routing an
18892 address for deliver. It must be set if &%command_user%& specifies a numerical
18893 uid. If it begins with a digit, it is interpreted as the numerical value of the
18894 gid. Otherwise it is looked up using &[getgrnam()]&.
18895
18896
18897 .option command_user queryprogram string unset
18898 .cindex "uid (user id)" "for &(queryprogram)&"
18899 This option must be set. It specifies the uid which is set when running the
18900 command while routing an address for delivery. If the value begins with a digit,
18901 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18902 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18903 not set, a value for the gid also.
18904
18905 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18906 root, which it does during a normal delivery in a conventional configuration.
18907 However, when an address is being verified during message reception, Exim is
18908 usually running as the Exim user, not as root. If the &(queryprogram)& router
18909 is called from a non-root process, Exim cannot change uid or gid before running
18910 the command. In this circumstance the command runs under the current uid and
18911 gid.
18912
18913
18914 .option current_directory queryprogram string /
18915 This option specifies an absolute path which is made the current directory
18916 before running the command.
18917
18918
18919 .option timeout queryprogram time 1h
18920 If the command does not complete within the timeout period, its process group
18921 is killed and the message is frozen. A value of zero time specifies no
18922 timeout.
18923
18924
18925 The standard output of the command is connected to a pipe, which is read when
18926 the command terminates. It should consist of a single line of output,
18927 containing up to five fields, separated by white space. The maximum length of
18928 the line is 1023 characters. Longer lines are silently truncated. The first
18929 field is one of the following words (case-insensitive):
18930
18931 .ilist
18932 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18933 below).
18934 .next
18935 &'Decline'&: the router declines; pass the address to the next router, unless
18936 &%no_more%& is set.
18937 .next
18938 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18939 subsequent text on the line is an error message. If the router is run as part
18940 of address verification during an incoming SMTP message, the message is
18941 included in the SMTP response.
18942 .next
18943 &'Defer'&: routing could not be completed at this time; try again later. Any
18944 subsequent text on the line is an error message which is logged. It is not
18945 included in any SMTP response.
18946 .next
18947 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18948 .next
18949 &'Pass'&: pass the address to the next router (or the router specified by
18950 &%pass_router%&), overriding &%no_more%&.
18951 .next
18952 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18953 new addresses, which are routed independently, starting with the first router,
18954 or the router specified by &%redirect_router%&, if set.
18955 .endlist
18956
18957 When the first word is &'accept'&, the remainder of the line consists of a
18958 number of keyed data values, as follows (split into two lines here, to fit on
18959 the page):
18960 .code
18961 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18962 LOOKUP=byname|bydns DATA=<text>
18963 .endd
18964 The data items can be given in any order, and all are optional. If no transport
18965 is included, the transport specified by the generic &%transport%& option is
18966 used. The list of hosts and the lookup type are needed only if the transport is
18967 an &(smtp)& transport that does not itself supply a list of hosts.
18968
18969 The format of the list of hosts is the same as for the &(manualroute)& router.
18970 As well as host names and IP addresses with optional port numbers, as described
18971 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18972 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18973 (see section &<<SECThostshowused>>&).
18974
18975 If the lookup type is not specified, Exim behaves as follows when trying to
18976 find an IP address for each host: First, a DNS lookup is done. If this yields
18977 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18978 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18979 result of the lookup is the result of that call.
18980
18981 .vindex "&$address_data$&"
18982 If the DATA field is set, its value is placed in the &$address_data$&
18983 variable. For example, this return line
18984 .code
18985 accept hosts=x1.y.example:x2.y.example data="rule1"
18986 .endd
18987 routes the address to the default transport, passing a list of two hosts. When
18988 the transport runs, the string &"rule1"& is in &$address_data$&.
18989 .ecindex IIDquerou1
18990 .ecindex IIDquerou2
18991
18992
18993
18994
18995 . ////////////////////////////////////////////////////////////////////////////
18996 . ////////////////////////////////////////////////////////////////////////////
18997
18998 .chapter "The redirect router" "CHAPredirect"
18999 .scindex IIDredrou1 "&(redirect)& router"
19000 .scindex IIDredrou2 "routers" "&(redirect)&"
19001 .cindex "alias file" "in a &(redirect)& router"
19002 .cindex "address redirection" "&(redirect)& router"
19003 The &(redirect)& router handles several kinds of address redirection. Its most
19004 common uses are for resolving local part aliases from a central alias file
19005 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19006 files, but it has many other potential uses. The incoming address can be
19007 redirected in several different ways:
19008
19009 .ilist
19010 It can be replaced by one or more new addresses which are themselves routed
19011 independently.
19012 .next
19013 It can be routed to be delivered to a given file or directory.
19014 .next
19015 It can be routed to be delivered to a specified pipe command.
19016 .next
19017 It can cause an automatic reply to be generated.
19018 .next
19019 It can be forced to fail, optionally with a custom error message.
19020 .next
19021 It can be temporarily deferred, optionally with a custom message.
19022 .next
19023 It can be discarded.
19024 .endlist
19025
19026 The generic &%transport%& option must not be set for &(redirect)& routers.
19027 However, there are some private options which define transports for delivery to
19028 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19029 &%pipe_transport%& and &%reply_transport%& descriptions below.
19030
19031 If success DSNs have been requested
19032 .cindex "DSN" "success"
19033 .cindex "Delivery Status Notification" "success"
19034 redirection triggers one and the DSN options are not passed any further.
19035
19036
19037
19038 .section "Redirection data" "SECID124"
19039 The router operates by interpreting a text string which it obtains either by
19040 expanding the contents of the &%data%& option, or by reading the entire
19041 contents of a file whose name is given in the &%file%& option. These two
19042 options are mutually exclusive. The first is commonly used for handling system
19043 aliases, in a configuration like this:
19044 .code
19045 system_aliases:
19046   driver = redirect
19047   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19048 .endd
19049 If the lookup fails, the expanded string in this example is empty. When the
19050 expansion of &%data%& results in an empty string, the router declines. A forced
19051 expansion failure also causes the router to decline; other expansion failures
19052 cause delivery to be deferred.
19053
19054 A configuration using &%file%& is commonly used for handling users'
19055 &_.forward_& files, like this:
19056 .code
19057 userforward:
19058   driver = redirect
19059   check_local_user
19060   file = $home/.forward
19061   no_verify
19062 .endd
19063 If the file does not exist, or causes no action to be taken (for example, it is
19064 empty or consists only of comments), the router declines. &*Warning*&: This
19065 is not the case when the file contains syntactically valid items that happen to
19066 yield empty addresses, for example, items containing only RFC 2822 address
19067 comments.
19068
19069
19070
19071 .section "Forward files and address verification" "SECID125"
19072 .cindex "address redirection" "while verifying"
19073 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19074 &_.forward_& files, as in the example above. There are two reasons for this:
19075
19076 .ilist
19077 When Exim is receiving an incoming SMTP message from a remote host, it is
19078 running under the Exim uid, not as root. Exim is unable to change uid to read
19079 the file as the user, and it may not be able to read it as the Exim user. So in
19080 practice the router may not be able to operate.
19081 .next
19082 However, even when the router can operate, the existence of a &_.forward_& file
19083 is unimportant when verifying an address. What should be checked is whether the
19084 local part is a valid user name or not. Cutting out the redirection processing
19085 saves some resources.
19086 .endlist
19087
19088
19089
19090
19091
19092
19093 .section "Interpreting redirection data" "SECID126"
19094 .cindex "Sieve filter" "specifying in redirection data"
19095 .cindex "filter" "specifying in redirection data"
19096 The contents of the data string, whether obtained from &%data%& or &%file%&,
19097 can be interpreted in two different ways:
19098
19099 .ilist
19100 If the &%allow_filter%& option is set true, and the data begins with the text
19101 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19102 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19103 respectively. Details of the syntax and semantics of filter files are described
19104 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19105 document is intended for use by end users.
19106 .next
19107 Otherwise, the data must be a comma-separated list of redirection items, as
19108 described in the next section.
19109 .endlist
19110
19111 When a message is redirected to a file (a &"mail folder"&), the file name given
19112 in a non-filter redirection list must always be an absolute path. A filter may
19113 generate a relative path &-- how this is handled depends on the transport's
19114 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19115 for the &(appendfile)& transport.
19116
19117
19118
19119 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19120 .cindex "address redirection" "non-filter list items"
19121 When the redirection data is not an Exim or Sieve filter, for example, if it
19122 comes from a conventional alias or forward file, it consists of a list of
19123 addresses, file names, pipe commands, or certain special items (see section
19124 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19125 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19126 depending on their default values. The items in the list are separated by
19127 commas or newlines.
19128 If a comma is required in an item, the entire item must be enclosed in double
19129 quotes.
19130
19131 Lines starting with a # character are comments, and are ignored, and # may
19132 also appear following a comma, in which case everything between the # and the
19133 next newline character is ignored.
19134
19135 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19136 double quotes are retained because some forms of mail address require their use
19137 (but never to enclose the entire address). In the following description,
19138 &"item"& refers to what remains after any surrounding double quotes have been
19139 removed.
19140
19141 .vindex "&$local_part$&"
19142 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19143 and the expansion contains a reference to &$local_part$&, you should make use
19144 of the &%quote_local_part%& expansion operator, in case the local part contains
19145 special characters. For example, to redirect all mail for the domain
19146 &'obsolete.example'&, retaining the existing local part, you could use this
19147 setting:
19148 .code
19149 data = ${quote_local_part:$local_part}@newdomain.example
19150 .endd
19151
19152
19153 .section "Redirecting to a local mailbox" "SECTredlocmai"
19154 .cindex "routing" "loops in"
19155 .cindex "loop" "while routing, avoidance of"
19156 .cindex "address redirection" "to local mailbox"
19157 A redirection item may safely be the same as the address currently under
19158 consideration. This does not cause a routing loop, because a router is
19159 automatically skipped if any ancestor of the address that is being processed
19160 is the same as the current address and was processed by the current router.
19161 Such an address is therefore passed to the following routers, so it is handled
19162 as if there were no redirection. When making this loop-avoidance test, the
19163 complete local part, including any prefix or suffix, is used.
19164
19165 .cindex "address redirection" "local part without domain"
19166 Specifying the same local part without a domain is a common usage in personal
19167 filter files when the user wants to have messages delivered to the local
19168 mailbox and also forwarded elsewhere. For example, the user whose login is
19169 &'cleo'& might have a &_.forward_& file containing this:
19170 .code
19171 cleo, cleopatra@egypt.example
19172 .endd
19173 .cindex "backslash in alias file"
19174 .cindex "alias file" "backslash in"
19175 For compatibility with other MTAs, such unqualified local parts may be
19176 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19177 it does make a difference if more than one domain is being handled
19178 synonymously.
19179
19180 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19181 2822 address that does not include a domain, the item is qualified using the
19182 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19183 addresses are qualified using the value in &%qualify_recipient%&, but you can
19184 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19185
19186 Care must be taken if there are alias names for local users.
19187 Consider an MTA handling a single local domain where the system alias file
19188 contains:
19189 .code
19190 Sam.Reman: spqr
19191 .endd
19192 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19193 messages in the local mailbox, and also forward copies elsewhere. He creates
19194 this forward file:
19195 .code
19196 Sam.Reman, spqr@reme.elsewhere.example
19197 .endd
19198 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19199 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19200 second time round, because it has previously routed it,
19201 and the following routers presumably cannot handle the alias. The forward file
19202 should really contain
19203 .code
19204 spqr, spqr@reme.elsewhere.example
19205 .endd
19206 but because this is such a common error, the &%check_ancestor%& option (see
19207 below) exists to provide a way to get round it. This is normally set on a
19208 &(redirect)& router that is handling users' &_.forward_& files.
19209
19210
19211
19212 .section "Special items in redirection lists" "SECTspecitredli"
19213 In addition to addresses, the following types of item may appear in redirection
19214 lists (that is, in non-filter redirection data):
19215
19216 .ilist
19217 .cindex "pipe" "in redirection list"
19218 .cindex "address redirection" "to pipe"
19219 An item is treated as a pipe command if it begins with &"|"& and does not parse
19220 as a valid RFC 2822 address that includes a domain. A transport for running the
19221 command must be specified by the &%pipe_transport%& option.
19222 Normally, either the router or the transport specifies a user and a group under
19223 which to run the delivery. The default is to use the Exim user and group.
19224
19225 Single or double quotes can be used for enclosing the individual arguments of
19226 the pipe command; no interpretation of escapes is done for single quotes. If
19227 the command contains a comma character, it is necessary to put the whole item
19228 in double quotes, for example:
19229 .code
19230 "|/some/command ready,steady,go"
19231 .endd
19232 since items in redirection lists are terminated by commas. Do not, however,
19233 quote just the command. An item such as
19234 .code
19235 |"/some/command ready,steady,go"
19236 .endd
19237 is interpreted as a pipe with a rather strange command name, and no arguments.
19238
19239 Note that the above example assumes that the text comes from a lookup source
19240 of some sort, so that the quotes are part of the data.  If composing a
19241 redirect router with a &%data%& option directly specifying this command, the
19242 quotes will be used by the configuration parser to define the extent of one
19243 string, but will not be passed down into the redirect router itself.  There
19244 are two main approaches to get around this: escape quotes to be part of the
19245 data itself, or avoid using this mechanism and instead create a custom
19246 transport with the &%command%& option set and reference that transport from
19247 an &%accept%& router.
19248
19249 .next
19250 .cindex "file" "in redirection list"
19251 .cindex "address redirection" "to file"
19252 An item is interpreted as a path name if it begins with &"/"& and does not
19253 parse as a valid RFC 2822 address that includes a domain. For example,
19254 .code
19255 /home/world/minbari
19256 .endd
19257 is treated as a file name, but
19258 .code
19259 /s=molari/o=babylon/@x400gate.way
19260 .endd
19261 is treated as an address. For a file name, a transport must be specified using
19262 the &%file_transport%& option. However, if the generated path name ends with a
19263 forward slash character, it is interpreted as a directory name rather than a
19264 file name, and &%directory_transport%& is used instead.
19265
19266 Normally, either the router or the transport specifies a user and a group under
19267 which to run the delivery. The default is to use the Exim user and group.
19268
19269 .cindex "&_/dev/null_&"
19270 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19271 bypassed at a high level, and the log entry shows &"**bypassed**"&
19272 instead of a transport name. In this case the user and group are not used.
19273
19274 .next
19275 .cindex "included address list"
19276 .cindex "address redirection" "included external list"
19277 If an item is of the form
19278 .code
19279 :include:<path name>
19280 .endd
19281 a list of further items is taken from the given file and included at that
19282 point. &*Note*&: Such a file can not be a filter file; it is just an
19283 out-of-line addition to the list. The items in the included list are separated
19284 by commas or newlines and are not subject to expansion. If this is the first
19285 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19286 the alias name. This example is incorrect:
19287 .code
19288 list1    :include:/opt/lists/list1
19289 .endd
19290 It must be given as
19291 .code
19292 list1:   :include:/opt/lists/list1
19293 .endd
19294 .next
19295 .cindex "address redirection" "to black hole"
19296 Sometimes you want to throw away mail to a particular local part. Making the
19297 &%data%& option expand to an empty string does not work, because that causes
19298 the router to decline. Instead, the alias item
19299 .cindex "black hole"
19300 .cindex "abandoning mail"
19301 &':blackhole:'& can be used. It does what its name implies. No delivery is
19302 done, and no error message is generated. This has the same effect as specifing
19303 &_/dev/null_& as a destination, but it can be independently disabled.
19304
19305 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19306 delivery is done for the original local part, even if other redirection items
19307 are present. If you are generating a multi-item list (for example, by reading a
19308 database) and need the ability to provide a no-op item, you must use
19309 &_/dev/null_&.
19310
19311 .next
19312 .cindex "delivery" "forcing failure"
19313 .cindex "delivery" "forcing deferral"
19314 .cindex "failing delivery" "forcing"
19315 .cindex "deferred delivery, forcing"
19316 .cindex "customizing" "failure message"
19317 An attempt to deliver a particular address can be deferred or forced to fail by
19318 redirection items of the form
19319 .code
19320 :defer:
19321 :fail:
19322 .endd
19323 respectively. When a redirection list contains such an item, it applies
19324 to the entire redirection; any other items in the list are ignored. Any
19325 text following &':fail:'& or &':defer:'& is placed in the error text
19326 associated with the failure. For example, an alias file might contain:
19327 .code
19328 X.Employee:  :fail: Gone away, no forwarding address
19329 .endd
19330 In the case of an address that is being verified from an ACL or as the subject
19331 of a
19332 .cindex "VRFY" "error text, display of"
19333 VRFY command, the text is included in the SMTP error response by
19334 default.
19335 .cindex "EXPN" "error text, display of"
19336 The text is not included in the response to an EXPN command. In non-SMTP cases
19337 the text is included in the error message that Exim generates.
19338
19339 .cindex "SMTP" "error codes"
19340 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19341 &':fail:'&. However, if the message starts with three digits followed by a
19342 space, optionally followed by an extended code of the form &'n.n.n'&, also
19343 followed by a space, and the very first digit is the same as the default error
19344 code, the code from the message is used instead. If the very first digit is
19345 incorrect, a panic error is logged, and the default code is used. You can
19346 suppress the use of the supplied code in a redirect router by setting the
19347 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19348 ignored.
19349
19350 .vindex "&$acl_verify_message$&"
19351 In an ACL, an explicitly provided message overrides the default, but the
19352 default message is available in the variable &$acl_verify_message$& and can
19353 therefore be included in a custom message if this is desired.
19354
19355 Normally the error text is the rest of the redirection list &-- a comma does
19356 not terminate it &-- but a newline does act as a terminator. Newlines are not
19357 normally present in alias expansions. In &(lsearch)& lookups they are removed
19358 as part of the continuation process, but they may exist in other kinds of
19359 lookup and in &':include:'& files.
19360
19361 During routing for message delivery (as opposed to verification), a redirection
19362 containing &':fail:'& causes an immediate failure of the incoming address,
19363 whereas &':defer:'& causes the message to remain on the queue so that a
19364 subsequent delivery attempt can happen at a later time. If an address is
19365 deferred for too long, it will ultimately fail, because the normal retry
19366 rules still apply.
19367
19368 .next
19369 .cindex "alias file" "exception to default"
19370 Sometimes it is useful to use a single-key search type with a default (see
19371 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19372 for exceptions to the default. These can be handled by aliasing them to
19373 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19374 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19375 results in an empty redirection list has the same effect.
19376 .endlist
19377
19378
19379 .section "Duplicate addresses" "SECTdupaddr"
19380 .cindex "duplicate addresses"
19381 .cindex "address duplicate, discarding"
19382 .cindex "pipe" "duplicated"
19383 Exim removes duplicate addresses from the list to which it is delivering, so as
19384 to deliver just one copy to each address. This does not apply to deliveries
19385 routed to pipes by different immediate parent addresses, but an indirect
19386 aliasing scheme of the type
19387 .code
19388 pipe:       |/some/command $local_part
19389 localpart1: pipe
19390 localpart2: pipe
19391 .endd
19392 does not work with a message that is addressed to both local parts, because
19393 when the second is aliased to the intermediate local part &"pipe"& it gets
19394 discarded as being the same as a previously handled address. However, a scheme
19395 such as
19396 .code
19397 localpart1: |/some/command $local_part
19398 localpart2: |/some/command $local_part
19399 .endd
19400 does result in two different pipe deliveries, because the immediate parents of
19401 the pipes are distinct.
19402
19403
19404
19405 .section "Repeated redirection expansion" "SECID128"
19406 .cindex "repeated redirection expansion"
19407 .cindex "address redirection" "repeated for each delivery attempt"
19408 When a message cannot be delivered to all of its recipients immediately,
19409 leading to two or more delivery attempts, redirection expansion is carried out
19410 afresh each time for those addresses whose children were not all previously
19411 delivered. If redirection is being used as a mailing list, this can lead to new
19412 members of the list receiving copies of old messages. The &%one_time%& option
19413 can be used to avoid this.
19414
19415
19416 .section "Errors in redirection lists" "SECID129"
19417 .cindex "address redirection" "errors"
19418 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19419 error is skipped, and an entry is written to the main log. This may be useful
19420 for mailing lists that are automatically managed. Otherwise, if an error is
19421 detected while generating the list of new addresses, the original address is
19422 deferred. See also &%syntax_errors_to%&.
19423
19424
19425
19426 .section "Private options for the redirect router" "SECID130"
19427
19428 .cindex "options" "&(redirect)& router"
19429 The private options for the &(redirect)& router are as follows:
19430
19431
19432 .option allow_defer redirect boolean false
19433 Setting this option allows the use of &':defer:'& in non-filter redirection
19434 data, or the &%defer%& command in an Exim filter file.
19435
19436
19437 .option allow_fail redirect boolean false
19438 .cindex "failing delivery" "from filter"
19439 If this option is true, the &':fail:'& item can be used in a redirection list,
19440 and the &%fail%& command may be used in an Exim filter file.
19441
19442
19443 .option allow_filter redirect boolean false
19444 .cindex "filter" "enabling use of"
19445 .cindex "Sieve filter" "enabling use of"
19446 Setting this option allows Exim to interpret redirection data that starts with
19447 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19448 are some features of Exim filter files that some administrators may wish to
19449 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19450
19451 It is also possible to lock out Exim filters or Sieve filters while allowing
19452 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19453
19454
19455 The filter is run using the uid and gid set by the generic &%user%& and
19456 &%group%& options. These take their defaults from the password data if
19457 &%check_local_user%& is set, so in the normal case of users' personal filter
19458 files, the filter is run as the relevant user. When &%allow_filter%& is set
19459 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19460
19461
19462
19463 .option allow_freeze redirect boolean false
19464 .cindex "freezing messages" "allowing in filter"
19465 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19466 This command is more normally encountered in system filters, and is disabled by
19467 default for redirection filters because it isn't something you usually want to
19468 let ordinary users do.
19469
19470
19471
19472 .option check_ancestor redirect boolean false
19473 This option is concerned with handling generated addresses that are the same
19474 as some address in the list of redirection ancestors of the current address.
19475 Although it is turned off by default in the code, it is set in the default
19476 configuration file for handling users' &_.forward_& files. It is recommended
19477 for this use of the &(redirect)& router.
19478
19479 When &%check_ancestor%& is set, if a generated address (including the domain)
19480 is the same as any ancestor of the current address, it is replaced by a copy of
19481 the current address. This helps in the case where local part A is aliased to B,
19482 and B has a &_.forward_& file pointing back to A. For example, within a single
19483 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19484 &_&~jb/.forward_& contains:
19485 .code
19486 \Joe.Bloggs, <other item(s)>
19487 .endd
19488 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19489 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19490 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19491 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19492 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19493 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19494 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19495 original address. See also the &%repeat_use%& option below.
19496
19497
19498 .option check_group redirect boolean "see below"
19499 When the &%file%& option is used, the group owner of the file is checked only
19500 when this option is set. The permitted groups are those listed in the
19501 &%owngroups%& option, together with the user's default group if
19502 &%check_local_user%& is set. If the file has the wrong group, routing is
19503 deferred. The default setting for this option is true if &%check_local_user%&
19504 is set and the &%modemask%& option permits the group write bit, or if the
19505 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19506
19507
19508
19509 .option check_owner redirect boolean "see below"
19510 When the &%file%& option is used, the owner of the file is checked only when
19511 this option is set. If &%check_local_user%& is set, the local user is
19512 permitted; otherwise the owner must be one of those listed in the &%owners%&
19513 option. The default value for this option is true if &%check_local_user%& or
19514 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19515
19516
19517 .option data redirect string&!! unset
19518 This option is mutually exclusive with &%file%&. One or other of them must be
19519 set, but not both. The contents of &%data%& are expanded, and then used as the
19520 list of forwarding items, or as a set of filtering instructions. If the
19521 expansion is forced to fail, or the result is an empty string or a string that
19522 has no effect (consists entirely of comments), the router declines.
19523
19524 When filtering instructions are used, the string must begin with &"#Exim
19525 filter"&, and all comments in the string, including this initial one, must be
19526 terminated with newline characters. For example:
19527 .code
19528 data = #Exim filter\n\
19529        if $h_to: contains Exim then save $home/mail/exim endif
19530 .endd
19531 If you are reading the data from a database where newlines cannot be included,
19532 you can use the &${sg}$& expansion item to turn the escape string of your
19533 choice into a newline.
19534
19535
19536 .option directory_transport redirect string&!! unset
19537 A &(redirect)& router sets up a direct delivery to a directory when a path name
19538 ending with a slash is specified as a new &"address"&. The transport used is
19539 specified by this option, which, after expansion, must be the name of a
19540 configured transport. This should normally be an &(appendfile)& transport.
19541
19542
19543 .option file redirect string&!! unset
19544 This option specifies the name of a file that contains the redirection data. It
19545 is mutually exclusive with the &%data%& option. The string is expanded before
19546 use; if the expansion is forced to fail, the router declines. Other expansion
19547 failures cause delivery to be deferred. The result of a successful expansion
19548 must be an absolute path. The entire file is read and used as the redirection
19549 data. If the data is an empty string or a string that has no effect (consists
19550 entirely of comments), the router declines.
19551
19552 .cindex "NFS" "checking for file existence"
19553 If the attempt to open the file fails with a &"does not exist"& error, Exim
19554 runs a check on the containing directory,
19555 unless &%ignore_enotdir%& is true (see below).
19556 If the directory does not appear to exist, delivery is deferred. This can
19557 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19558 is a mount problem. If the containing directory does exist, but the file does
19559 not, the router declines.
19560
19561
19562 .option file_transport redirect string&!! unset
19563 .vindex "&$address_file$&"
19564 A &(redirect)& router sets up a direct delivery to a file when a path name not
19565 ending in a slash is specified as a new &"address"&. The transport used is
19566 specified by this option, which, after expansion, must be the name of a
19567 configured transport. This should normally be an &(appendfile)& transport. When
19568 it is running, the file name is in &$address_file$&.
19569
19570
19571 .option filter_prepend_home redirect boolean true
19572 When this option is true, if a &(save)& command in an Exim filter specifies a
19573 relative path, and &$home$& is defined, it is automatically prepended to the
19574 relative path. If this option is set false, this action does not happen. The
19575 relative path is then passed to the transport unmodified.
19576
19577
19578 .option forbid_blackhole redirect boolean false
19579 If this option is true, the &':blackhole:'& item may not appear in a
19580 redirection list.
19581
19582
19583 .option forbid_exim_filter redirect boolean false
19584 If this option is set true, only Sieve filters are permitted when
19585 &%allow_filter%& is true.
19586
19587
19588
19589
19590 .option forbid_file redirect boolean false
19591 .cindex "delivery" "to file; forbidding"
19592 .cindex "Sieve filter" "forbidding delivery to a file"
19593 .cindex "Sieve filter" "&""keep""& facility; disabling"
19594 If this option is true, this router may not generate a new address that
19595 specifies delivery to a local file or directory, either from a filter or from a
19596 conventional forward file. This option is forced to be true if &%one_time%& is
19597 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19598 locks out the Sieve's &"keep"& facility.
19599
19600
19601 .option forbid_filter_dlfunc redirect boolean false
19602 .cindex "filter" "locking out certain features"
19603 If this option is true, string expansions in Exim filters are not allowed to
19604 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19605 functions.
19606
19607 .option forbid_filter_existstest redirect boolean false
19608 .cindex "expansion" "statting a file"
19609 If this option is true, string expansions in Exim filters are not allowed to
19610 make use of the &%exists%& condition or the &%stat%& expansion item.
19611
19612 .option forbid_filter_logwrite redirect boolean false
19613 If this option is true, use of the logging facility in Exim filters is not
19614 permitted. Logging is in any case available only if the filter is being run
19615 under some unprivileged uid (which is normally the case for ordinary users'
19616 &_.forward_& files).
19617
19618
19619 .option forbid_filter_lookup redirect boolean false
19620 If this option is true, string expansions in Exim filter files are not allowed
19621 to make use of &%lookup%& items.
19622
19623
19624 .option forbid_filter_perl redirect boolean false
19625 This option has an effect only if Exim is built with embedded Perl support. If
19626 it is true, string expansions in Exim filter files are not allowed to make use
19627 of the embedded Perl support.
19628
19629
19630 .option forbid_filter_readfile redirect boolean false
19631 If this option is true, string expansions in Exim filter files are not allowed
19632 to make use of &%readfile%& items.
19633
19634
19635 .option forbid_filter_readsocket redirect boolean false
19636 If this option is true, string expansions in Exim filter files are not allowed
19637 to make use of &%readsocket%& items.
19638
19639
19640 .option forbid_filter_reply redirect boolean false
19641 If this option is true, this router may not generate an automatic reply
19642 message. Automatic replies can be generated only from Exim or Sieve filter
19643 files, not from traditional forward files. This option is forced to be true if
19644 &%one_time%& is set.
19645
19646
19647 .option forbid_filter_run redirect boolean false
19648 If this option is true, string expansions in Exim filter files are not allowed
19649 to make use of &%run%& items.
19650
19651
19652 .option forbid_include redirect boolean false
19653 If this option is true, items of the form
19654 .code
19655 :include:<path name>
19656 .endd
19657 are not permitted in non-filter redirection lists.
19658
19659
19660 .option forbid_pipe redirect boolean false
19661 .cindex "delivery" "to pipe; forbidding"
19662 If this option is true, this router may not generate a new address which
19663 specifies delivery to a pipe, either from an Exim filter or from a conventional
19664 forward file. This option is forced to be true if &%one_time%& is set.
19665
19666
19667 .option forbid_sieve_filter redirect boolean false
19668 If this option is set true, only Exim filters are permitted when
19669 &%allow_filter%& is true.
19670
19671
19672 .cindex "SMTP" "error codes"
19673 .option forbid_smtp_code redirect boolean false
19674 If this option is set true, any SMTP error codes that are present at the start
19675 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19676 the default codes (451 and 550, respectively) are always used.
19677
19678
19679
19680
19681 .option hide_child_in_errmsg redirect boolean false
19682 .cindex "bounce message" "redirection details; suppressing"
19683 If this option is true, it prevents Exim from quoting a child address if it
19684 generates a bounce or delay message for it. Instead it says &"an address
19685 generated from <&'the top level address'&>"&. Of course, this applies only to
19686 bounces generated locally. If a message is forwarded to another host, &'its'&
19687 bounce may well quote the generated address.
19688
19689
19690 .option ignore_eacces redirect boolean false
19691 .cindex "EACCES"
19692 If this option is set and an attempt to open a redirection file yields the
19693 EACCES error (permission denied), the &(redirect)& router behaves as if the
19694 file did not exist.
19695
19696
19697 .option ignore_enotdir redirect boolean false
19698 .cindex "ENOTDIR"
19699 If this option is set and an attempt to open a redirection file yields the
19700 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19701 router behaves as if the file did not exist.
19702
19703 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19704 router that has the &%file%& option set discovers that the file does not exist
19705 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19706 against unmounted NFS directories. If the parent can not be statted, delivery
19707 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19708 is set, because that option tells Exim to ignore &"something on the path is not
19709 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19710 that some operating systems give ENOENT where others give ENOTDIR.
19711
19712
19713
19714 .option include_directory redirect string unset
19715 If this option is set, the path names of any &':include:'& items in a
19716 redirection list must start with this directory.
19717
19718
19719 .option modemask redirect "octal integer" 022
19720 This specifies mode bits which must not be set for a file specified by the
19721 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19722
19723
19724 .option one_time redirect boolean false
19725 .cindex "one-time aliasing/forwarding expansion"
19726 .cindex "alias file" "one-time expansion"
19727 .cindex "forward file" "one-time expansion"
19728 .cindex "mailing lists" "one-time expansion"
19729 .cindex "address redirection" "one-time expansion"
19730 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19731 files each time it tries to deliver a message causes a problem when one or more
19732 of the generated addresses fails be delivered at the first attempt. The problem
19733 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19734 but of what happens when the redirection list changes during the time that the
19735 message is on Exim's queue. This is particularly true in the case of mailing
19736 lists, where new subscribers might receive copies of messages that were posted
19737 before they subscribed.
19738
19739 If &%one_time%& is set and any addresses generated by the router fail to
19740 deliver at the first attempt, the failing addresses are added to the message as
19741 &"top level"& addresses, and the parent address that generated them is marked
19742 &"delivered"&. Thus, redirection does not happen again at the next delivery
19743 attempt.
19744
19745 &*Warning 1*&: Any header line addition or removal that is specified by this
19746 router would be lost if delivery did not succeed at the first attempt. For this
19747 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19748 permitted when &%one_time%& is set.
19749
19750 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19751 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19752 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19753
19754 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19755 &%one_time%&.
19756
19757 The original top-level address is remembered with each of the generated
19758 addresses, and is output in any log messages. However, any intermediate parent
19759 addresses are not recorded. This makes a difference to the log only if
19760 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19761 typically be used for mailing lists, where there is normally just one level of
19762 expansion.
19763
19764
19765 .option owners redirect "string list" unset
19766 .cindex "ownership" "alias file"
19767 .cindex "ownership" "forward file"
19768 .cindex "alias file" "ownership"
19769 .cindex "forward file" "ownership"
19770 This specifies a list of permitted owners for the file specified by &%file%&.
19771 This list is in addition to the local user when &%check_local_user%& is set.
19772 See &%check_owner%& above.
19773
19774
19775 .option owngroups redirect "string list" unset
19776 This specifies a list of permitted groups for the file specified by &%file%&.
19777 The list is in addition to the local user's primary group when
19778 &%check_local_user%& is set. See &%check_group%& above.
19779
19780
19781 .option pipe_transport redirect string&!! unset
19782 .vindex "&$address_pipe$&"
19783 A &(redirect)& router sets up a direct delivery to a pipe when a string
19784 starting with a vertical bar character is specified as a new &"address"&. The
19785 transport used is specified by this option, which, after expansion, must be the
19786 name of a configured transport. This should normally be a &(pipe)& transport.
19787 When the transport is run, the pipe command is in &$address_pipe$&.
19788
19789
19790 .option qualify_domain redirect string&!! unset
19791 .vindex "&$qualify_recipient$&"
19792 If this option is set, and an unqualified address (one without a domain) is
19793 generated, and that address would normally be qualified by the global setting
19794 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19795 expanding this string. If the expansion fails, the router declines. If you want
19796 to revert to the default, you can have the expansion generate
19797 &$qualify_recipient$&.
19798
19799 This option applies to all unqualified addresses generated by Exim filters,
19800 but for traditional &_.forward_& files, it applies only to addresses that are
19801 not preceded by a backslash. Sieve filters cannot generate unqualified
19802 addresses.
19803
19804 .option qualify_preserve_domain redirect boolean false
19805 .cindex "domain" "in redirection; preserving"
19806 .cindex "preserving domain in redirection"
19807 .cindex "address redirection" "domain; preserving"
19808 If this option is set, the router's local &%qualify_domain%& option must not be
19809 set (a configuration error occurs if it is). If an unqualified address (one
19810 without a domain) is generated, it is qualified with the domain of the parent
19811 address (the immediately preceding ancestor) instead of the global
19812 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19813 this applies whether or not the address is preceded by a backslash.
19814
19815
19816 .option repeat_use redirect boolean true
19817 If this option is set false, the router is skipped for a child address that has
19818 any ancestor that was routed by this router. This test happens before any of
19819 the other preconditions are tested. Exim's default anti-looping rules skip
19820 only when the ancestor is the same as the current address. See also
19821 &%check_ancestor%& above and the generic &%redirect_router%& option.
19822
19823
19824 .option reply_transport redirect string&!! unset
19825 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19826 &%vacation%& command is used in a filter file. The transport used is specified
19827 by this option, which, after expansion, must be the name of a configured
19828 transport. This should normally be an &(autoreply)& transport. Other transports
19829 are unlikely to do anything sensible or useful.
19830
19831
19832 .option rewrite redirect boolean true
19833 .cindex "address redirection" "disabling rewriting"
19834 If this option is set false, addresses generated by the router are not
19835 subject to address rewriting. Otherwise, they are treated like new addresses
19836 and are rewritten according to the global rewriting rules.
19837
19838
19839 .option sieve_subaddress redirect string&!! unset
19840 The value of this option is passed to a Sieve filter to specify the
19841 :subaddress part of an address.
19842
19843 .option sieve_useraddress redirect string&!! unset
19844 The value of this option is passed to a Sieve filter to specify the :user part
19845 of an address. However, if it is unset, the entire original local part
19846 (including any prefix or suffix) is used for :user.
19847
19848
19849 .option sieve_vacation_directory redirect string&!! unset
19850 .cindex "Sieve filter" "vacation directory"
19851 To enable the &"vacation"& extension for Sieve filters, you must set
19852 &%sieve_vacation_directory%& to the directory where vacation databases are held
19853 (do not put anything else in that directory), and ensure that the
19854 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19855 needs their own directory; Exim will create it if necessary.
19856
19857
19858
19859 .option skip_syntax_errors redirect boolean false
19860 .cindex "forward file" "broken"
19861 .cindex "address redirection" "broken files"
19862 .cindex "alias file" "broken"
19863 .cindex "broken alias or forward files"
19864 .cindex "ignoring faulty addresses"
19865 .cindex "skipping faulty addresses"
19866 .cindex "error" "skipping bad syntax"
19867 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19868 non-filter redirection data are skipped, and each failing address is logged. If
19869 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19870 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19871 are expanded and placed at the head of the error message generated by
19872 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19873 be the same address as the generic &%errors_to%& option. The
19874 &%skip_syntax_errors%& option is often used when handling mailing lists.
19875
19876 If all the addresses in a redirection list are skipped because of syntax
19877 errors, the router declines to handle the original address, and it is passed to
19878 the following routers.
19879
19880 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19881 error in the filter causes filtering to be abandoned without any action being
19882 taken. The incident is logged, and the router declines to handle the address,
19883 so it is passed to the following routers.
19884
19885 .cindex "Sieve filter" "syntax errors in"
19886 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19887 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19888 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19889
19890 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19891 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19892 option, used with an address that does not get redirected, can be used to
19893 notify users of these errors, by means of a router like this:
19894 .code
19895 userforward:
19896   driver = redirect
19897   allow_filter
19898   check_local_user
19899   file = $home/.forward
19900   file_transport = address_file
19901   pipe_transport = address_pipe
19902   reply_transport = address_reply
19903   no_verify
19904   skip_syntax_errors
19905   syntax_errors_to = real-$local_part@$domain
19906   syntax_errors_text = \
19907    This is an automatically generated message. An error has\n\
19908    been found in your .forward file. Details of the error are\n\
19909    reported below. While this error persists, you will receive\n\
19910    a copy of this message for every message that is addressed\n\
19911    to you. If your .forward file is a filter file, or if it is\n\
19912    a non-filter file containing no valid forwarding addresses,\n\
19913    a copy of each incoming message will be put in your normal\n\
19914    mailbox. If a non-filter file contains at least one valid\n\
19915    forwarding address, forwarding to the valid addresses will\n\
19916    happen, and those will be the only deliveries that occur.
19917 .endd
19918 You also need a router to ensure that local addresses that are prefixed by
19919 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19920 put this immediately before the &(userforward)& router:
19921 .code
19922 real_localuser:
19923   driver = accept
19924   check_local_user
19925   local_part_prefix = real-
19926   transport = local_delivery
19927 .endd
19928 For security, it would probably be a good idea to restrict the use of this
19929 router to locally-generated messages, using a condition such as this:
19930 .code
19931   condition = ${if match {$sender_host_address}\
19932                          {\N^(|127\.0\.0\.1)$\N}}
19933 .endd
19934
19935
19936 .option syntax_errors_text redirect string&!! unset
19937 See &%skip_syntax_errors%& above.
19938
19939
19940 .option syntax_errors_to redirect string unset
19941 See &%skip_syntax_errors%& above.
19942 .ecindex IIDredrou1
19943 .ecindex IIDredrou2
19944
19945
19946
19947
19948
19949
19950 . ////////////////////////////////////////////////////////////////////////////
19951 . ////////////////////////////////////////////////////////////////////////////
19952
19953 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19954          "Environment for local transports"
19955 .scindex IIDenvlotra1 "local transports" "environment for"
19956 .scindex IIDenvlotra2 "environment for local transports"
19957 .scindex IIDenvlotra3 "transport" "local; environment for"
19958 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19959 transport can be thought of as similar to a pipe.) Exim always runs transports
19960 in subprocesses, under specified uids and gids. Typical deliveries to local
19961 mailboxes run under the uid and gid of the local user.
19962
19963 Exim also sets a specific current directory while running the transport; for
19964 some transports a home directory setting is also relevant. The &(pipe)&
19965 transport is the only one that sets up environment variables; see section
19966 &<<SECTpipeenv>>& for details.
19967
19968 The values used for the uid, gid, and the directories may come from several
19969 different places. In many cases, the router that handles the address associates
19970 settings with that address as a result of its &%check_local_user%&, &%group%&,
19971 or &%user%& options. However, values may also be given in the transport's own
19972 configuration, and these override anything that comes from the router.
19973
19974
19975
19976 .section "Concurrent deliveries" "SECID131"
19977 .cindex "concurrent deliveries"
19978 .cindex "simultaneous deliveries"
19979 If two different messages for the same local recipient arrive more or less
19980 simultaneously, the two delivery processes are likely to run concurrently. When
19981 the &(appendfile)& transport is used to write to a file, Exim applies locking
19982 rules to stop concurrent processes from writing to the same file at the same
19983 time.
19984
19985 However, when you use a &(pipe)& transport, it is up to you to arrange any
19986 locking that is needed. Here is a silly example:
19987 .code
19988 my_transport:
19989   driver = pipe
19990   command = /bin/sh -c 'cat >>/some/file'
19991 .endd
19992 This is supposed to write the message at the end of the file. However, if two
19993 messages arrive at the same time, the file will be scrambled. You can use the
19994 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19995 file using the same algorithm that Exim itself uses.
19996
19997
19998
19999
20000 .section "Uids and gids" "SECTenvuidgid"
20001 .cindex "local transports" "uid and gid"
20002 .cindex "transport" "local; uid and gid"
20003 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20004 overrides any group that the router set in the address, even if &%user%& is not
20005 set for the transport. This makes it possible, for example, to run local mail
20006 delivery under the uid of the recipient (set by the router), but in a special
20007 group (set by the transport). For example:
20008 .code
20009 # Routers ...
20010 # User/group are set by check_local_user in this router
20011 local_users:
20012   driver = accept
20013   check_local_user
20014   transport = group_delivery
20015
20016 # Transports ...
20017 # This transport overrides the group
20018 group_delivery:
20019   driver = appendfile
20020   file = /var/spool/mail/$local_part
20021   group = mail
20022 .endd
20023 If &%user%& is set for a transport, its value overrides what is set in the
20024 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20025 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20026 set.
20027
20028 .oindex "&%initgroups%&"
20029 When the uid is taken from the transport's configuration, the &[initgroups()]&
20030 function is called for the groups associated with that uid if the
20031 &%initgroups%& option is set for the transport. When the uid is not specified
20032 by the transport, but is associated with the address by a router, the option
20033 for calling &[initgroups()]& is taken from the router configuration.
20034
20035 .cindex "&(pipe)& transport" "uid for"
20036 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20037 is set and &%user%& is not set, the uid of the process that called Exim to
20038 receive the message is used, and if &%group%& is not set, the corresponding
20039 original gid is also used.
20040
20041 This is the detailed preference order for obtaining a gid; the first of the
20042 following that is set is used:
20043
20044 .ilist
20045 A &%group%& setting of the transport;
20046 .next
20047 A &%group%& setting of the router;
20048 .next
20049 A gid associated with a user setting of the router, either as a result of
20050 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20051 .next
20052 The group associated with a non-numeric &%user%& setting of the transport;
20053 .next
20054 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20055 the uid is the creator's uid;
20056 .next
20057 The Exim gid if the Exim uid is being used as a default.
20058 .endlist
20059
20060 If, for example, the user is specified numerically on the router and there are
20061 no group settings, no gid is available. In this situation, an error occurs.
20062 This is different for the uid, for which there always is an ultimate default.
20063 The first of the following that is set is used:
20064
20065 .ilist
20066 A &%user%& setting of the transport;
20067 .next
20068 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20069 .next
20070 A &%user%& setting of the router;
20071 .next
20072 A &%check_local_user%& setting of the router;
20073 .next
20074 The Exim uid.
20075 .endlist
20076
20077 Of course, an error will still occur if the uid that is chosen is on the
20078 &%never_users%& list.
20079
20080
20081
20082
20083
20084 .section "Current and home directories" "SECID132"
20085 .cindex "current directory for local transport"
20086 .cindex "home directory" "for local transport"
20087 .cindex "transport" "local; home directory for"
20088 .cindex "transport" "local; current directory for"
20089 Routers may set current and home directories for local transports by means of
20090 the &%transport_current_directory%& and &%transport_home_directory%& options.
20091 However, if the transport's &%current_directory%& or &%home_directory%& options
20092 are set, they override the router's values. In detail, the home directory
20093 for a local transport is taken from the first of these values that is set:
20094
20095 .ilist
20096 The &%home_directory%& option on the transport;
20097 .next
20098 The &%transport_home_directory%& option on the router;
20099 .next
20100 The password data if &%check_local_user%& is set on the router;
20101 .next
20102 The &%router_home_directory%& option on the router.
20103 .endlist
20104
20105 The current directory is taken from the first of these values that is set:
20106
20107 .ilist
20108 The &%current_directory%& option on the transport;
20109 .next
20110 The &%transport_current_directory%& option on the router.
20111 .endlist
20112
20113
20114 If neither the router nor the transport sets a current directory, Exim uses the
20115 value of the home directory, if it is set. Otherwise it sets the current
20116 directory to &_/_& before running a local transport.
20117
20118
20119
20120 .section "Expansion variables derived from the address" "SECID133"
20121 .vindex "&$domain$&"
20122 .vindex "&$local_part$&"
20123 .vindex "&$original_domain$&"
20124 Normally a local delivery is handling a single address, and in that case the
20125 variables such as &$domain$& and &$local_part$& are set during local
20126 deliveries. However, in some circumstances more than one address may be handled
20127 at once (for example, while writing batch SMTP for onward transmission by some
20128 other means). In this case, the variables associated with the local part are
20129 never set, &$domain$& is set only if all the addresses have the same domain,
20130 and &$original_domain$& is never set.
20131 .ecindex IIDenvlotra1
20132 .ecindex IIDenvlotra2
20133 .ecindex IIDenvlotra3
20134
20135
20136
20137
20138
20139
20140
20141 . ////////////////////////////////////////////////////////////////////////////
20142 . ////////////////////////////////////////////////////////////////////////////
20143
20144 .chapter "Generic options for transports" "CHAPtransportgeneric"
20145 .scindex IIDgenoptra1 "generic options" "transport"
20146 .scindex IIDgenoptra2 "options" "generic; for transports"
20147 .scindex IIDgenoptra3 "transport" "generic options for"
20148 The following generic options apply to all transports:
20149
20150
20151 .option body_only transports boolean false
20152 .cindex "transport" "body only"
20153 .cindex "message" "transporting body only"
20154 .cindex "body of message" "transporting"
20155 If this option is set, the message's headers are not transported. It is
20156 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20157 or &(pipe)& transports, the settings of &%message_prefix%& and
20158 &%message_suffix%& should be checked, because this option does not
20159 automatically suppress them.
20160
20161
20162 .option current_directory transports string&!! unset
20163 .cindex "transport" "current directory for"
20164 This specifies the current directory that is to be set while running the
20165 transport, overriding any value that may have been set by the router.
20166 If the expansion fails for any reason, including forced failure, an error is
20167 logged, and delivery is deferred.
20168
20169
20170 .option disable_logging transports boolean false
20171 If this option is set true, nothing is logged for any
20172 deliveries by the transport or for any
20173 transport errors. You should not set this option unless you really, really know
20174 what you are doing.
20175
20176
20177 .option debug_print transports string&!! unset
20178 .cindex "testing" "variables in drivers"
20179 If this option is set and debugging is enabled (see the &%-d%& command line
20180 option), the string is expanded and included in the debugging output when the
20181 transport is run.
20182 If expansion of the string fails, the error message is written to the debugging
20183 output, and Exim carries on processing.
20184 This facility is provided to help with checking out the values of variables and
20185 so on when debugging driver configurations. For example, if a &%headers_add%&
20186 option is not working properly, &%debug_print%& could be used to output the
20187 variables it references. A newline is added to the text if it does not end with
20188 one.
20189 The variables &$transport_name$& and &$router_name$& contain the name of the
20190 transport and the router that called it.
20191
20192 .option delivery_date_add transports boolean false
20193 .cindex "&'Delivery-date:'& header line"
20194 If this option is true, a &'Delivery-date:'& header is added to the message.
20195 This gives the actual time the delivery was made. As this is not a standard
20196 header, Exim has a configuration option (&%delivery_date_remove%&) which
20197 requests its removal from incoming messages, so that delivered messages can
20198 safely be resent to other recipients.
20199
20200
20201 .option driver transports string unset
20202 This specifies which of the available transport drivers is to be used.
20203 There is no default, and this option must be set for every transport.
20204
20205
20206 .option envelope_to_add transports boolean false
20207 .cindex "&'Envelope-to:'& header line"
20208 If this option is true, an &'Envelope-to:'& header is added to the message.
20209 This gives the original address(es) in the incoming envelope that caused this
20210 delivery to happen. More than one address may be present if the transport is
20211 configured to handle several addresses at once, or if more than one original
20212 address was redirected to the same final address. As this is not a standard
20213 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20214 its removal from incoming messages, so that delivered messages can safely be
20215 resent to other recipients.
20216
20217
20218 .option group transports string&!! "Exim group"
20219 .cindex "transport" "group; specifying"
20220 This option specifies a gid for running the transport process, overriding any
20221 value that the router supplies, and also overriding any value associated with
20222 &%user%& (see below).
20223
20224
20225 .option headers_add transports list&!! unset
20226 .cindex "header lines" "adding in transport"
20227 .cindex "transport" "header lines; adding"
20228 This option specifies a list of text headers, newline-separated,
20229 which are (separately) expanded and added to the header
20230 portion of a message as it is transported, as described in section
20231 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20232 routers. If the result of the expansion is an empty string, or if the expansion
20233 is forced to fail, no action is taken. Other expansion failures are treated as
20234 errors and cause the delivery to be deferred.
20235
20236 Unlike most options, &%headers_add%& can be specified multiple times
20237 for a transport; all listed headers are added.
20238
20239
20240 .option headers_only transports boolean false
20241 .cindex "transport" "header lines only"
20242 .cindex "message" "transporting headers only"
20243 .cindex "header lines" "transporting"
20244 If this option is set, the message's body is not transported. It is mutually
20245 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20246 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20247 checked, since this option does not automatically suppress them.
20248
20249
20250 .option headers_remove transports list&!! unset
20251 .cindex "header lines" "removing"
20252 .cindex "transport" "header lines; removing"
20253 This option specifies a list of header names, colon-separated;
20254 these headers are omitted from the message as it is transported, as described
20255 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20256 routers.
20257 Each list item is separately expanded.
20258 If the result of the expansion is an empty string, or if the expansion
20259 is forced to fail, no action is taken. Other expansion failures are treated as
20260 errors and cause the delivery to be deferred.
20261
20262 Unlike most options, &%headers_remove%& can be specified multiple times
20263 for a router; all listed headers are removed.
20264
20265
20266
20267 .option headers_rewrite transports string unset
20268 .cindex "transport" "header lines; rewriting"
20269 .cindex "rewriting" "at transport time"
20270 This option allows addresses in header lines to be rewritten at transport time,
20271 that is, as the message is being copied to its destination. The contents of the
20272 option are a colon-separated list of rewriting rules. Each rule is in exactly
20273 the same form as one of the general rewriting rules that are applied when a
20274 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20275 example,
20276 .code
20277 headers_rewrite = a@b c@d f : \
20278                   x@y w@z
20279 .endd
20280 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20281 &'w@z'& in all address-bearing header lines. The rules are applied to the
20282 header lines just before they are written out at transport time, so they affect
20283 only those copies of the message that pass through the transport. However, only
20284 the message's original header lines, and any that were added by a system
20285 filter, are rewritten. If a router or transport adds header lines, they are not
20286 affected by this option. These rewriting rules are &'not'& applied to the
20287 envelope. You can change the return path using &%return_path%&, but you cannot
20288 change envelope recipients at this time.
20289
20290
20291 .option home_directory transports string&!! unset
20292 .cindex "transport" "home directory for"
20293 .vindex "&$home$&"
20294 This option specifies a home directory setting for a local transport,
20295 overriding any value that may be set by the router. The home directory is
20296 placed in &$home$& while expanding the transport's private options. It is also
20297 used as the current directory if no current directory is set by the
20298 &%current_directory%& option on the transport or the
20299 &%transport_current_directory%& option on the router. If the expansion fails
20300 for any reason, including forced failure, an error is logged, and delivery is
20301 deferred.
20302
20303
20304 .option initgroups transports boolean false
20305 .cindex "additional groups"
20306 .cindex "groups" "additional"
20307 .cindex "transport" "group; additional"
20308 If this option is true and the uid for the delivery process is provided by the
20309 transport, the &[initgroups()]& function is called when running the transport
20310 to ensure that any additional groups associated with the uid are set up.
20311
20312
20313 .option message_size_limit transports string&!! 0
20314 .cindex "limit" "message size per transport"
20315 .cindex "size" "of message, limit"
20316 .cindex "transport" "message size; limiting"
20317 This option controls the size of messages passed through the transport. It is
20318 expanded before use; the result of the expansion must be a sequence of decimal
20319 digits, optionally followed by K or M. If the expansion fails for any reason,
20320 including forced failure, or if the result is not of the required form,
20321 delivery is deferred. If the value is greater than zero and the size of a
20322 message exceeds this limit, the address is failed. If there is any chance that
20323 the resulting bounce message could be routed to the same transport, you should
20324 ensure that &%return_size_limit%& is less than the transport's
20325 &%message_size_limit%&, as otherwise the bounce message will fail to get
20326 delivered.
20327
20328
20329
20330 .option rcpt_include_affixes transports boolean false
20331 .cindex "prefix" "for local part, including in envelope"
20332 .cindex "suffix for local part" "including in envelope"
20333 .cindex "local part" "prefix"
20334 .cindex "local part" "suffix"
20335 When this option is false (the default), and an address that has had any
20336 affixes (prefixes or suffixes) removed from the local part is delivered by any
20337 form of SMTP or LMTP, the affixes are not included. For example, if a router
20338 that contains
20339 .code
20340 local_part_prefix = *-
20341 .endd
20342 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20343 is delivered with
20344 .code
20345 RCPT TO:<xyz@some.domain>
20346 .endd
20347 This is also the case when an ACL-time callout is being used to verify a
20348 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20349 whole local part is included in the RCPT command. This option applies to BSMTP
20350 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20351 &(lmtp)& and &(smtp)& transports.
20352
20353
20354 .option retry_use_local_part transports boolean "see below"
20355 .cindex "hints database" "retry keys"
20356 When a delivery suffers a temporary failure, a retry record is created
20357 in Exim's hints database. For remote deliveries, the key for the retry record
20358 is based on the name and/or IP address of the failing remote host. For local
20359 deliveries, the key is normally the entire address, including both the local
20360 part and the domain. This is suitable for most common cases of local delivery
20361 temporary failure &-- for example, exceeding a mailbox quota should delay only
20362 deliveries to that mailbox, not to the whole domain.
20363
20364 However, in some special cases you may want to treat a temporary local delivery
20365 as a failure associated with the domain, and not with a particular local part.
20366 (For example, if you are storing all mail for some domain in files.) You can do
20367 this by setting &%retry_use_local_part%& false.
20368
20369 For all the local transports, its default value is true. For remote transports,
20370 the default value is false for tidiness, but changing the value has no effect
20371 on a remote transport in the current implementation.
20372
20373
20374 .option return_path transports string&!! unset
20375 .cindex "envelope sender"
20376 .cindex "transport" "return path; changing"
20377 .cindex "return path" "changing in transport"
20378 If this option is set, the string is expanded at transport time and replaces
20379 the existing return path (envelope sender) value in the copy of the message
20380 that is being delivered. An empty return path is permitted. This feature is
20381 designed for remote deliveries, where the value of this option is used in the
20382 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20383 only effect is to change the address that is placed in the &'Return-path:'&
20384 header line, if one is added to the message (see the next option).
20385
20386 &*Note:*& A changed return path is not logged unless you add
20387 &%return_path_on_delivery%& to the log selector.
20388
20389 .vindex "&$return_path$&"
20390 The expansion can refer to the existing value via &$return_path$&. This is
20391 either the message's envelope sender, or an address set by the
20392 &%errors_to%& option on a router. If the expansion is forced to fail, no
20393 replacement occurs; if it fails for another reason, delivery is deferred. This
20394 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20395 section &<<SECTverp>>&.
20396
20397 &*Note*&: If a delivery error is detected locally, including the case when a
20398 remote server rejects a message at SMTP time, the bounce message is not sent to
20399 the value of this option. It is sent to the previously set errors address.
20400 This defaults to the incoming sender address, but can be changed by setting
20401 &%errors_to%& in a router.
20402
20403
20404
20405 .option return_path_add transports boolean false
20406 .cindex "&'Return-path:'& header line"
20407 If this option is true, a &'Return-path:'& header is added to the message.
20408 Although the return path is normally available in the prefix line of BSD
20409 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20410 have easy access to it.
20411
20412 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20413 the delivery SMTP server makes the final delivery"&. This implies that this
20414 header should not be present in incoming messages. Exim has a configuration
20415 option, &%return_path_remove%&, which requests removal of this header from
20416 incoming messages, so that delivered messages can safely be resent to other
20417 recipients.
20418
20419
20420 .option shadow_condition transports string&!! unset
20421 See &%shadow_transport%& below.
20422
20423
20424 .option shadow_transport transports string unset
20425 .cindex "shadow transport"
20426 .cindex "transport" "shadow"
20427 A local transport may set the &%shadow_transport%& option to the name of
20428 another local transport. Shadow remote transports are not supported.
20429
20430 Whenever a delivery to the main transport succeeds, and either
20431 &%shadow_condition%& is unset, or its expansion does not result in the empty
20432 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20433 passed to the shadow transport, with the same delivery address or addresses. If
20434 expansion fails, no action is taken except that non-forced expansion failures
20435 cause a log line to be written.
20436
20437 The result of the shadow transport is discarded and does not affect the
20438 subsequent processing of the message. Only a single level of shadowing is
20439 provided; the &%shadow_transport%& option is ignored on any transport when it
20440 is running as a shadow. Options concerned with output from pipes are also
20441 ignored. The log line for the successful delivery has an item added on the end,
20442 of the form
20443 .code
20444 ST=<shadow transport name>
20445 .endd
20446 If the shadow transport did not succeed, the error message is put in
20447 parentheses afterwards. Shadow transports can be used for a number of different
20448 purposes, including keeping more detailed log information than Exim normally
20449 provides, and implementing automatic acknowledgment policies based on message
20450 headers that some sites insist on.
20451
20452
20453 .option transport_filter transports string&!! unset
20454 .cindex "transport" "filter"
20455 .cindex "filter" "transport filter"
20456 This option sets up a filtering (in the Unix shell sense) process for messages
20457 at transport time. It should not be confused with mail filtering as set up by
20458 individual users or via a system filter.
20459
20460 When the message is about to be written out, the command specified by
20461 &%transport_filter%& is started up in a separate, parallel process, and
20462 the entire message, including the header lines, is passed to it on its standard
20463 input (this in fact is done from a third process, to avoid deadlock). The
20464 command must be specified as an absolute path.
20465
20466 The lines of the message that are written to the transport filter are
20467 terminated by newline (&"\n"&). The message is passed to the filter before any
20468 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20469 lines beginning with a dot, and also before any processing implied by the
20470 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20471 &(pipe)& transports.
20472
20473 The standard error for the filter process is set to the same destination as its
20474 standard output; this is read and written to the message's ultimate
20475 destination. The process that writes the message to the filter, the
20476 filter itself, and the original process that reads the result and delivers it
20477 are all run in parallel, like a shell pipeline.
20478
20479 The filter can perform any transformations it likes, but of course should take
20480 care not to break RFC 2822 syntax. Exim does not check the result, except to
20481 test for a final newline when SMTP is in use. All messages transmitted over
20482 SMTP must end with a newline, so Exim supplies one if it is missing.
20483
20484 .cindex "content scanning" "per user"
20485 A transport filter can be used to provide content-scanning on a per-user basis
20486 at delivery time if the only required effect of the scan is to modify the
20487 message. For example, a content scan could insert a new header line containing
20488 a spam score. This could be interpreted by a filter in the user's MUA. It is
20489 not possible to discard a message at this stage.
20490
20491 .cindex "SMTP" "SIZE"
20492 A problem might arise if the filter increases the size of a message that is
20493 being sent down an SMTP connection. If the receiving SMTP server has indicated
20494 support for the SIZE parameter, Exim will have sent the size of the message
20495 at the start of the SMTP session. If what is actually sent is substantially
20496 more, the server might reject the message. This can be worked round by setting
20497 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20498 additions to the message, or to disable the use of SIZE altogether.
20499
20500 .vindex "&$pipe_addresses$&"
20501 The value of the &%transport_filter%& option is the command string for starting
20502 the filter, which is run directly from Exim, not under a shell. The string is
20503 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20504 Exim breaks it up into arguments and then expands each argument separately (see
20505 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20506 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20507 of arguments, one for each address that applies to this delivery. (This isn't
20508 an ideal name for this feature here, but as it was already implemented for the
20509 &(pipe)& transport, it seemed sensible not to change it.)
20510
20511 .vindex "&$host$&"
20512 .vindex "&$host_address$&"
20513 The expansion variables &$host$& and &$host_address$& are available when the
20514 transport is a remote one. They contain the name and IP address of the host to
20515 which the message is being sent. For example:
20516 .code
20517 transport_filter = /some/directory/transport-filter.pl \
20518   $host $host_address $sender_address $pipe_addresses
20519 .endd
20520
20521 Two problems arise if you want to use more complicated expansion items to
20522 generate transport filter commands, both of which due to the fact that the
20523 command is split up &'before'& expansion.
20524 .ilist
20525 If an expansion item contains white space, you must quote it, so that it is all
20526 part of the same command item. If the entire option setting is one such
20527 expansion item, you have to take care what kind of quoting you use. For
20528 example:
20529 .code
20530 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20531 .endd
20532 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20533 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20534 stripped by Exim when it read the option's value. When the value is used, if
20535 the single quotes were missing, the line would be split into two items,
20536 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20537 Exim tried to expand the first one.
20538 .next
20539 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20540 expansion cannot generate multiple arguments, or a command name followed by
20541 arguments. Consider this example:
20542 .code
20543 transport_filter = ${lookup{$host}lsearch{/a/file}\
20544                     {$value}{/bin/cat}}
20545 .endd
20546 The result of the lookup is interpreted as the name of the command, even
20547 if it contains white space. The simplest way round this is to use a shell:
20548 .code
20549 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20550                                {$value}{/bin/cat}}
20551 .endd
20552 .endlist
20553
20554 The filter process is run under the same uid and gid as the normal delivery.
20555 For remote deliveries this is the Exim uid/gid by default. The command should
20556 normally yield a zero return code. Transport filters are not supposed to fail.
20557 A non-zero code is taken to mean that the transport filter encountered some
20558 serious problem. Delivery of the message is deferred; the message remains on
20559 the queue and is tried again later. It is not possible to cause a message to be
20560 bounced from a transport filter.
20561
20562 If a transport filter is set on an autoreply transport, the original message is
20563 passed through the filter as it is being copied into the newly generated
20564 message, which happens if the &%return_message%& option is set.
20565
20566
20567 .option transport_filter_timeout transports time 5m
20568 .cindex "transport" "filter, timeout"
20569 When Exim is reading the output of a transport filter, it applies a timeout
20570 that can be set by this option. Exceeding the timeout is normally treated as a
20571 temporary delivery failure. However, if a transport filter is used with a
20572 &(pipe)& transport, a timeout in the transport filter is treated in the same
20573 way as a timeout in the pipe command itself. By default, a timeout is a hard
20574 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20575 becomes a temporary error.
20576
20577
20578 .option user transports string&!! "Exim user"
20579 .cindex "uid (user id)" "local delivery"
20580 .cindex "transport" "user, specifying"
20581 This option specifies the user under whose uid the delivery process is to be
20582 run, overriding any uid that may have been set by the router. If the user is
20583 given as a name, the uid is looked up from the password data, and the
20584 associated group is taken as the value of the gid to be used if the &%group%&
20585 option is not set.
20586
20587 For deliveries that use local transports, a user and group are normally
20588 specified explicitly or implicitly (for example, as a result of
20589 &%check_local_user%&) by the router or transport.
20590
20591 .cindex "hints database" "access by remote transport"
20592 For remote transports, you should leave this option unset unless you really are
20593 sure you know what you are doing. When a remote transport is running, it needs
20594 to be able to access Exim's hints databases, because each host may have its own
20595 retry data.
20596 .ecindex IIDgenoptra1
20597 .ecindex IIDgenoptra2
20598 .ecindex IIDgenoptra3
20599
20600
20601
20602
20603
20604
20605 . ////////////////////////////////////////////////////////////////////////////
20606 . ////////////////////////////////////////////////////////////////////////////
20607
20608 .chapter "Address batching in local transports" "CHAPbatching" &&&
20609          "Address batching"
20610 .cindex "transport" "local; address batching in"
20611 The only remote transport (&(smtp)&) is normally configured to handle more than
20612 one address at a time, so that when several addresses are routed to the same
20613 remote host, just one copy of the message is sent. Local transports, however,
20614 normally handle one address at a time. That is, a separate instance of the
20615 transport is run for each address that is routed to the transport. A separate
20616 copy of the message is delivered each time.
20617
20618 .cindex "batched local delivery"
20619 .oindex "&%batch_max%&"
20620 .oindex "&%batch_id%&"
20621 In special cases, it may be desirable to handle several addresses at once in a
20622 local transport, for example:
20623
20624 .ilist
20625 In an &(appendfile)& transport, when storing messages in files for later
20626 delivery by some other means, a single copy of the message with multiple
20627 recipients saves space.
20628 .next
20629 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20630 a single copy saves time, and is the normal way LMTP is expected to work.
20631 .next
20632 In a &(pipe)& transport, when passing the message
20633 to a scanner program or
20634 to some other delivery mechanism such as UUCP, multiple recipients may be
20635 acceptable.
20636 .endlist
20637
20638 These three local transports all have the same options for controlling multiple
20639 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20640 repeating the information for each transport, these options are described here.
20641
20642 The &%batch_max%& option specifies the maximum number of addresses that can be
20643 delivered together in a single run of the transport. Its default value is one
20644 (no batching). When more than one address is routed to a transport that has a
20645 &%batch_max%& value greater than one, the addresses are delivered in a batch
20646 (that is, in a single run of the transport with multiple recipients), subject
20647 to certain conditions:
20648
20649 .ilist
20650 .vindex "&$local_part$&"
20651 If any of the transport's options contain a reference to &$local_part$&, no
20652 batching is possible.
20653 .next
20654 .vindex "&$domain$&"
20655 If any of the transport's options contain a reference to &$domain$&, only
20656 addresses with the same domain are batched.
20657 .next
20658 .cindex "customizing" "batching condition"
20659 If &%batch_id%& is set, it is expanded for each address, and only those
20660 addresses with the same expanded value are batched. This allows you to specify
20661 customized batching conditions. Failure of the expansion for any reason,
20662 including forced failure, disables batching, but it does not stop the delivery
20663 from taking place.
20664 .next
20665 Batched addresses must also have the same errors address (where to send
20666 delivery errors), the same header additions and removals, the same user and
20667 group for the transport, and if a host list is present, the first host must
20668 be the same.
20669 .endlist
20670
20671 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20672 both when the file or pipe command is specified in the transport, and when it
20673 is specified by a &(redirect)& router, but all the batched addresses must of
20674 course be routed to the same file or pipe command. These two transports have an
20675 option called &%use_bsmtp%&, which causes them to deliver the message in
20676 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20677 &%check_string%& and &%escape_string%& options are forced to the values
20678 .code
20679 check_string = "."
20680 escape_string = ".."
20681 .endd
20682 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20683 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20684 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20685
20686 .cindex "&'Envelope-to:'& header line"
20687 If the generic &%envelope_to_add%& option is set for a batching transport, the
20688 &'Envelope-to:'& header that is added to the message contains all the addresses
20689 that are being processed together. If you are using a batching &(appendfile)&
20690 transport without &%use_bsmtp%&, the only way to preserve the recipient
20691 addresses is to set the &%envelope_to_add%& option.
20692
20693 .cindex "&(pipe)& transport" "with multiple addresses"
20694 .vindex "&$pipe_addresses$&"
20695 If you are using a &(pipe)& transport without BSMTP, and setting the
20696 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20697 the command. This is not a true variable; it is a bit of magic that causes each
20698 of the recipient addresses to be inserted into the command as a separate
20699 argument. This provides a way of accessing all the addresses that are being
20700 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20701 are specified by a &(redirect)& router.
20702
20703
20704
20705
20706 . ////////////////////////////////////////////////////////////////////////////
20707 . ////////////////////////////////////////////////////////////////////////////
20708
20709 .chapter "The appendfile transport" "CHAPappendfile"
20710 .scindex IIDapptra1 "&(appendfile)& transport"
20711 .scindex IIDapptra2 "transports" "&(appendfile)&"
20712 .cindex "directory creation"
20713 .cindex "creating directories"
20714 The &(appendfile)& transport delivers a message by appending it to an existing
20715 file, or by creating an entirely new file in a specified directory. Single
20716 files to which messages are appended can be in the traditional Unix mailbox
20717 format, or optionally in the MBX format supported by the Pine MUA and
20718 University of Washington IMAP daemon, &'inter alia'&. When each message is
20719 being delivered as a separate file, &"maildir"& format can optionally be used
20720 to give added protection against failures that happen part-way through the
20721 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20722 supported. For all file formats, Exim attempts to create as many levels of
20723 directory as necessary, provided that &%create_directory%& is set.
20724
20725 The code for the optional formats is not included in the Exim binary by
20726 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20727 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20728 included.
20729
20730 .cindex "quota" "system"
20731 Exim recognizes system quota errors, and generates an appropriate message. Exim
20732 also supports its own quota control within the transport, for use when the
20733 system facility is unavailable or cannot be used for some reason.
20734
20735 If there is an error while appending to a file (for example, quota exceeded or
20736 partition filled), Exim attempts to reset the file's length and last
20737 modification time back to what they were before. If there is an error while
20738 creating an entirely new file, the new file is removed.
20739
20740 Before appending to a file, a number of security checks are made, and the
20741 file is locked. A detailed description is given below, after the list of
20742 private options.
20743
20744 The &(appendfile)& transport is most commonly used for local deliveries to
20745 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20746 putting messages into files for remote delivery by some means other than Exim.
20747 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20748 option).
20749
20750
20751
20752 .section "The file and directory options" "SECTfildiropt"
20753 The &%file%& option specifies a single file, to which the message is appended;
20754 the &%directory%& option specifies a directory, in which a new file containing
20755 the message is created. Only one of these two options can be set, and for
20756 normal deliveries to mailboxes, one of them &'must'& be set.
20757
20758 .vindex "&$address_file$&"
20759 .vindex "&$local_part$&"
20760 However, &(appendfile)& is also used for delivering messages to files or
20761 directories whose names (or parts of names) are obtained from alias,
20762 forwarding, or filtering operations (for example, a &%save%& command in a
20763 user's Exim filter). When such a transport is running, &$local_part$& contains
20764 the local part that was aliased or forwarded, and &$address_file$& contains the
20765 name (or partial name) of the file or directory generated by the redirection
20766 operation. There are two cases:
20767
20768 .ilist
20769 If neither &%file%& nor &%directory%& is set, the redirection operation
20770 must specify an absolute path (one that begins with &`/`&). This is the most
20771 common case when users with local accounts use filtering to sort mail into
20772 different folders. See for example, the &(address_file)& transport in the
20773 default configuration. If the path ends with a slash, it is assumed to be the
20774 name of a directory. A delivery to a directory can also be forced by setting
20775 &%maildir_format%& or &%mailstore_format%&.
20776 .next
20777 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20778 used to determine the file or directory name for the delivery. Normally, the
20779 contents of &$address_file$& are used in some way in the string expansion.
20780 .endlist
20781
20782
20783 .cindex "Sieve filter" "configuring &(appendfile)&"
20784 .cindex "Sieve filter" "relative mailbox path handling"
20785 As an example of the second case, consider an environment where users do not
20786 have home directories. They may be permitted to use Exim filter commands of the
20787 form:
20788 .code
20789 save folder23
20790 .endd
20791 or Sieve filter commands of the form:
20792 .code
20793 require "fileinto";
20794 fileinto "folder23";
20795 .endd
20796 In this situation, the expansion of &%file%& or &%directory%& in the transport
20797 must transform the relative path into an appropriate absolute file name. In the
20798 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20799 is used as a result of a &"keep"& action in the filter. This example shows one
20800 way of handling this requirement:
20801 .code
20802 file = ${if eq{$address_file}{inbox} \
20803             {/var/mail/$local_part} \
20804             {${if eq{${substr_0_1:$address_file}}{/} \
20805                   {$address_file} \
20806                   {$home/mail/$address_file} \
20807             }} \
20808        }
20809 .endd
20810 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20811 location, absolute paths are used without change, and other folders are in the
20812 &_mail_& directory within the home directory.
20813
20814 &*Note 1*&: While processing an Exim filter, a relative path such as
20815 &_folder23_& is turned into an absolute path if a home directory is known to
20816 the router. In particular, this is the case if &%check_local_user%& is set. If
20817 you want to prevent this happening at routing time, you can set
20818 &%router_home_directory%& empty. This forces the router to pass the relative
20819 path to the transport.
20820
20821 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20822 the &%file%& or &%directory%& option is still used if it is set.
20823
20824
20825
20826
20827 .section "Private options for appendfile" "SECID134"
20828 .cindex "options" "&(appendfile)& transport"
20829
20830
20831
20832 .option allow_fifo appendfile boolean false
20833 .cindex "fifo (named pipe)"
20834 .cindex "named pipe (fifo)"
20835 .cindex "pipe" "named (fifo)"
20836 Setting this option permits delivery to named pipes (FIFOs) as well as to
20837 regular files. If no process is reading the named pipe at delivery time, the
20838 delivery is deferred.
20839
20840
20841 .option allow_symlink appendfile boolean false
20842 .cindex "symbolic link" "to mailbox"
20843 .cindex "mailbox" "symbolic link"
20844 By default, &(appendfile)& will not deliver if the path name for the file is
20845 that of a symbolic link. Setting this option relaxes that constraint, but there
20846 are security issues involved in the use of symbolic links. Be sure you know
20847 what you are doing if you set this. Details of exactly what this option affects
20848 are included in the discussion which follows this list of options.
20849
20850
20851 .option batch_id appendfile string&!! unset
20852 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20853 However, batching is automatically disabled for &(appendfile)& deliveries that
20854 happen as a result of forwarding or aliasing or other redirection directly to a
20855 file.
20856
20857
20858 .option batch_max appendfile integer 1
20859 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20860
20861
20862 .option check_group appendfile boolean false
20863 When this option is set, the group owner of the file defined by the &%file%&
20864 option is checked to see that it is the same as the group under which the
20865 delivery process is running. The default setting is false because the default
20866 file mode is 0600, which means that the group is irrelevant.
20867
20868
20869 .option check_owner appendfile boolean true
20870 When this option is set, the owner of the file defined by the &%file%& option
20871 is checked to ensure that it is the same as the user under which the delivery
20872 process is running.
20873
20874
20875 .option check_string appendfile string "see below"
20876 .cindex "&""From""& line"
20877 As &(appendfile)& writes the message, the start of each line is tested for
20878 matching &%check_string%&, and if it does, the initial matching characters are
20879 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20880 a literal string, not a regular expression, and the case of any letters it
20881 contains is significant.
20882
20883 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20884 are forced to &"."& and &".."& respectively, and any settings in the
20885 configuration are ignored. Otherwise, they default to &"From&~"& and
20886 &">From&~"& when the &%file%& option is set, and unset when any of the
20887 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20888
20889 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20890 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20891 &"From&~"& indicates the start of a new message. All four options need changing
20892 if another format is used. For example, to deliver to mailboxes in MMDF format:
20893 .cindex "MMDF format mailbox"
20894 .cindex "mailbox" "MMDF format"
20895 .code
20896 check_string = "\1\1\1\1\n"
20897 escape_string = "\1\1\1\1 \n"
20898 message_prefix = "\1\1\1\1\n"
20899 message_suffix = "\1\1\1\1\n"
20900 .endd
20901 .option create_directory appendfile boolean true
20902 .cindex "directory creation"
20903 When this option is true, Exim attempts to create any missing superior
20904 directories for the file that it is about to write. A created directory's mode
20905 is given by the &%directory_mode%& option.
20906
20907 The group ownership of a newly created directory is highly dependent on the
20908 operating system (and possibly the file system) that is being used. For
20909 example, in Solaris, if the parent directory has the setgid bit set, its group
20910 is propagated to the child; if not, the currently set group is used. However,
20911 in FreeBSD, the parent's group is always used.
20912
20913
20914
20915 .option create_file appendfile string anywhere
20916 This option constrains the location of files and directories that are created
20917 by this transport. It applies to files defined by the &%file%& option and
20918 directories defined by the &%directory%& option. In the case of maildir
20919 delivery, it applies to the top level directory, not the maildir directories
20920 beneath.
20921
20922 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20923 &"belowhome"&. In the second and third cases, a home directory must have been
20924 set for the transport. This option is not useful when an explicit file name is
20925 given for normal mailbox deliveries. It is intended for the case when file
20926 names are generated from users' &_.forward_& files. These are usually handled
20927 by an &(appendfile)& transport called &%address_file%&. See also
20928 &%file_must_exist%&.
20929
20930
20931 .option directory appendfile string&!! unset
20932 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20933 or &%directory%& must be set, unless the delivery is the direct result of a
20934 redirection (see section &<<SECTfildiropt>>&).
20935
20936 When &%directory%& is set, the string is expanded, and the message is delivered
20937 into a new file or files in or below the given directory, instead of being
20938 appended to a single mailbox file. A number of different formats are provided
20939 (see &%maildir_format%& and &%mailstore_format%&), and see section
20940 &<<SECTopdir>>& for further details of this form of delivery.
20941
20942
20943 .option directory_file appendfile string&!! "see below"
20944 .cindex "base62"
20945 .vindex "&$inode$&"
20946 When &%directory%& is set, but neither &%maildir_format%& nor
20947 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20948 whose name is obtained by expanding this string. The default value is:
20949 .code
20950 q${base62:$tod_epoch}-$inode
20951 .endd
20952 This generates a unique name from the current time, in base 62 form, and the
20953 inode of the file. The variable &$inode$& is available only when expanding this
20954 option.
20955
20956
20957 .option directory_mode appendfile "octal integer" 0700
20958 If &(appendfile)& creates any directories as a result of the
20959 &%create_directory%& option, their mode is specified by this option.
20960
20961
20962 .option escape_string appendfile string "see description"
20963 See &%check_string%& above.
20964
20965
20966 .option file appendfile string&!! unset
20967 This option is mutually exclusive with the &%directory%& option, but one of
20968 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20969 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20970 specifies a single file, to which the message is appended. One or more of
20971 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20972 &%file%&.
20973
20974 .cindex "NFS" "lock file"
20975 .cindex "locking files"
20976 .cindex "lock files"
20977 If you are using more than one host to deliver over NFS into the same
20978 mailboxes, you should always use lock files.
20979
20980 The string value is expanded for each delivery, and must yield an absolute
20981 path. The most common settings of this option are variations on one of these
20982 examples:
20983 .code
20984 file = /var/spool/mail/$local_part
20985 file = /home/$local_part/inbox
20986 file = $home/inbox
20987 .endd
20988 .cindex "&""sticky""& bit"
20989 In the first example, all deliveries are done into the same directory. If Exim
20990 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20991 create a file in the directory, so the &"sticky"& bit must be turned on for
20992 deliveries to be possible, or alternatively the &%group%& option can be used to
20993 run the delivery under a group id which has write access to the directory.
20994
20995
20996
20997 .option file_format appendfile string unset
20998 .cindex "file" "mailbox; checking existing format"
20999 This option requests the transport to check the format of an existing file
21000 before adding to it. The check consists of matching a specific string at the
21001 start of the file. The value of the option consists of an even number of
21002 colon-separated strings. The first of each pair is the test string, and the
21003 second is the name of a transport. If the transport associated with a matched
21004 string is not the current transport, control is passed over to the other
21005 transport. For example, suppose the standard &(local_delivery)& transport has
21006 this added to it:
21007 .code
21008 file_format = "From       : local_delivery :\
21009                \1\1\1\1\n : local_mmdf_delivery"
21010 .endd
21011 Mailboxes that begin with &"From"& are still handled by this transport, but if
21012 a mailbox begins with four binary ones followed by a newline, control is passed
21013 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21014 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21015 is assumed to match the current transport. If the start of a mailbox doesn't
21016 match any string, or if the transport named for a given string is not defined,
21017 delivery is deferred.
21018
21019
21020 .option file_must_exist appendfile boolean false
21021 If this option is true, the file specified by the &%file%& option must exist.
21022 A temporary error occurs if it does not, causing delivery to be deferred.
21023 If this option is false, the file is created if it does not exist.
21024
21025
21026 .option lock_fcntl_timeout appendfile time 0s
21027 .cindex "timeout" "mailbox locking"
21028 .cindex "mailbox" "locking, blocking and non-blocking"
21029 .cindex "locking files"
21030 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21031 when locking an open mailbox file. If the call fails, the delivery process
21032 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21033 Non-blocking calls are used so that the file is not kept open during the wait
21034 for the lock; the reason for this is to make it as safe as possible for
21035 deliveries over NFS in the case when processes might be accessing an NFS
21036 mailbox without using a lock file. This should not be done, but
21037 misunderstandings and hence misconfigurations are not unknown.
21038
21039 On a busy system, however, the performance of a non-blocking lock approach is
21040 not as good as using a blocking lock with a timeout. In this case, the waiting
21041 is done inside the system call, and Exim's delivery process acquires the lock
21042 and can proceed as soon as the previous lock holder releases it.
21043
21044 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21045 timeout, are used. There may still be some retrying: the maximum number of
21046 retries is
21047 .code
21048 (lock_retries * lock_interval) / lock_fcntl_timeout
21049 .endd
21050 rounded up to the next whole number. In other words, the total time during
21051 which &(appendfile)& is trying to get a lock is roughly the same, unless
21052 &%lock_fcntl_timeout%& is set very large.
21053
21054 You should consider setting this option if you are getting a lot of delayed
21055 local deliveries because of errors of the form
21056 .code
21057 failed to lock mailbox /some/file (fcntl)
21058 .endd
21059
21060 .option lock_flock_timeout appendfile time 0s
21061 This timeout applies to file locking when using &[flock()]& (see
21062 &%use_flock%&); the timeout operates in a similar manner to
21063 &%lock_fcntl_timeout%&.
21064
21065
21066 .option lock_interval appendfile time 3s
21067 This specifies the time to wait between attempts to lock the file. See below
21068 for details of locking.
21069
21070
21071 .option lock_retries appendfile integer 10
21072 This specifies the maximum number of attempts to lock the file. A value of zero
21073 is treated as 1. See below for details of locking.
21074
21075
21076 .option lockfile_mode appendfile "octal integer" 0600
21077 This specifies the mode of the created lock file, when a lock file is being
21078 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21079
21080
21081 .option lockfile_timeout appendfile time 30m
21082 .cindex "timeout" "mailbox locking"
21083 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21084 exists and is older than this value, it is assumed to have been left behind by
21085 accident, and Exim attempts to remove it.
21086
21087
21088 .option mailbox_filecount appendfile string&!! unset
21089 .cindex "mailbox" "specifying size of"
21090 .cindex "size" "of mailbox"
21091 If this option is set, it is expanded, and the result is taken as the current
21092 number of files in the mailbox. It must be a decimal number, optionally
21093 followed by K or M. This provides a way of obtaining this information from an
21094 external source that maintains the data.
21095
21096
21097 .option mailbox_size appendfile string&!! unset
21098 .cindex "mailbox" "specifying size of"
21099 .cindex "size" "of mailbox"
21100 If this option is set, it is expanded, and the result is taken as the current
21101 size the mailbox. It must be a decimal number, optionally followed by K or M.
21102 This provides a way of obtaining this information from an external source that
21103 maintains the data. This is likely to be helpful for maildir deliveries where
21104 it is computationally expensive to compute the size of a mailbox.
21105
21106
21107
21108 .option maildir_format appendfile boolean false
21109 .cindex "maildir format" "specifying"
21110 If this option is set with the &%directory%& option, the delivery is into a new
21111 file, in the &"maildir"& format that is used by other mail software. When the
21112 transport is activated directly from a &(redirect)& router (for example, the
21113 &(address_file)& transport in the default configuration), setting
21114 &%maildir_format%& causes the path received from the router to be treated as a
21115 directory, whether or not it ends with &`/`&. This option is available only if
21116 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21117 &<<SECTmaildirdelivery>>& below for further details.
21118
21119
21120 .option maildir_quota_directory_regex appendfile string "See below"
21121 .cindex "maildir format" "quota; directories included in"
21122 .cindex "quota" "maildir; directories included in"
21123 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21124 a regular expression for specifying directories, relative to the quota
21125 directory (see &%quota_directory%&), that should be included in the quota
21126 calculation. The default value is:
21127 .code
21128 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21129 .endd
21130 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21131 (directories whose names begin with a dot). If you want to exclude the
21132 &_Trash_&
21133 folder from the count (as some sites do), you need to change this setting to
21134 .code
21135 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21136 .endd
21137 This uses a negative lookahead in the regular expression to exclude the
21138 directory whose name is &_.Trash_&. When a directory is excluded from quota
21139 calculations, quota processing is bypassed for any messages that are delivered
21140 directly into that directory.
21141
21142
21143 .option maildir_retries appendfile integer 10
21144 This option specifies the number of times to retry when writing a file in
21145 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21146
21147
21148 .option maildir_tag appendfile string&!! unset
21149 This option applies only to deliveries in maildir format, and is described in
21150 section &<<SECTmaildirdelivery>>& below.
21151
21152
21153 .option maildir_use_size_file appendfile&!! boolean false
21154 .cindex "maildir format" "&_maildirsize_& file"
21155 The result of string expansion for this option must be a valid boolean value.
21156 If it is true, it enables support for &_maildirsize_& files. Exim
21157 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21158 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21159 value is zero. See &%maildir_quota_directory_regex%& above and section
21160 &<<SECTmaildirdelivery>>& below for further details.
21161
21162 .option maildirfolder_create_regex appendfile string unset
21163 .cindex "maildir format" "&_maildirfolder_& file"
21164 .cindex "&_maildirfolder_&, creating"
21165 The value of this option is a regular expression. If it is unset, it has no
21166 effect. Otherwise, before a maildir delivery takes place, the pattern is
21167 matched against the name of the maildir directory, that is, the directory
21168 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21169 delivery. If there is a match, Exim checks for the existence of a file called
21170 &_maildirfolder_& in the directory, and creates it if it does not exist.
21171 See section &<<SECTmaildirdelivery>>& for more details.
21172
21173
21174 .option mailstore_format appendfile boolean false
21175 .cindex "mailstore format" "specifying"
21176 If this option is set with the &%directory%& option, the delivery is into two
21177 new files in  &"mailstore"& format. The option is available only if
21178 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21179 below for further details.
21180
21181
21182 .option mailstore_prefix appendfile string&!! unset
21183 This option applies only to deliveries in mailstore format, and is described in
21184 section &<<SECTopdir>>& below.
21185
21186
21187 .option mailstore_suffix appendfile string&!! unset
21188 This option applies only to deliveries in mailstore format, and is described in
21189 section &<<SECTopdir>>& below.
21190
21191
21192 .option mbx_format appendfile boolean false
21193 .cindex "locking files"
21194 .cindex "file" "locking"
21195 .cindex "file" "MBX format"
21196 .cindex "MBX format, specifying"
21197 This option is available only if Exim has been compiled with SUPPORT_MBX
21198 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21199 the message is appended to the mailbox file in MBX format instead of
21200 traditional Unix format. This format is supported by Pine4 and its associated
21201 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21202
21203 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21204 automatically changed by the use of &%mbx_format%&. They should normally be set
21205 empty when using MBX format, so this option almost always appears in this
21206 combination:
21207 .code
21208 mbx_format = true
21209 message_prefix =
21210 message_suffix =
21211 .endd
21212 If none of the locking options are mentioned in the configuration,
21213 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21214 is possible to specify the other kinds of locking with &%mbx_format%&, but
21215 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21216 interworks with &'c-client'&, providing for shared access to the mailbox. It
21217 should not be used if any program that does not use this form of locking is
21218 going to access the mailbox, nor should it be used if the mailbox file is NFS
21219 mounted, because it works only when the mailbox is accessed from a single host.
21220
21221 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21222 the standard version of &'c-client'&, because as long as it has a mailbox open
21223 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21224 append messages to it.
21225
21226
21227 .option message_prefix appendfile string&!! "see below"
21228 .cindex "&""From""& line"
21229 The string specified here is expanded and output at the start of every message.
21230 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21231 in which case it is:
21232 .code
21233 message_prefix = "From ${if def:return_path{$return_path}\
21234   {MAILER-DAEMON}} $tod_bsdinbox\n"
21235 .endd
21236 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21237 &`\n`& to &`\r\n`& in &%message_prefix%&.
21238
21239 .option message_suffix appendfile string&!! "see below"
21240 The string specified here is expanded and output at the end of every message.
21241 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21242 in which case it is a single newline character. The suffix can be suppressed by
21243 setting
21244 .code
21245 message_suffix =
21246 .endd
21247 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21248 &`\n`& to &`\r\n`& in &%message_suffix%&.
21249
21250 .option mode appendfile "octal integer" 0600
21251 If the output file is created, it is given this mode. If it already exists and
21252 has wider permissions, they are reduced to this mode. If it has narrower
21253 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21254 if the delivery is the result of a &%save%& command in a filter file specifying
21255 a particular mode, the mode of the output file is always forced to take that
21256 value, and this option is ignored.
21257
21258
21259 .option mode_fail_narrower appendfile boolean true
21260 This option applies in the case when an existing mailbox file has a narrower
21261 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21262 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21263 continues with the delivery attempt, using the existing mode of the file.
21264
21265
21266 .option notify_comsat appendfile boolean false
21267 If this option is true, the &'comsat'& daemon is notified after every
21268 successful delivery to a user mailbox. This is the daemon that notifies logged
21269 on users about incoming mail.
21270
21271
21272 .option quota appendfile string&!! unset
21273 .cindex "quota" "imposed by Exim"
21274 This option imposes a limit on the size of the file to which Exim is appending,
21275 or to the total space used in the directory tree when the &%directory%& option
21276 is set. In the latter case, computation of the space used is expensive, because
21277 all the files in the directory (and any sub-directories) have to be
21278 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21279 &%maildir_use_size_file%& for ways to avoid this in environments where users
21280 have no shell access to their mailboxes).
21281
21282 As there is no interlock against two simultaneous deliveries into a
21283 multi-file mailbox, it is possible for the quota to be overrun in this case.
21284 For single-file mailboxes, of course, an interlock is a necessity.
21285
21286 A file's size is taken as its &'used'& value. Because of blocking effects, this
21287 may be a lot less than the actual amount of disk space allocated to the file.
21288 If the sizes of a number of files are being added up, the rounding effect can
21289 become quite noticeable, especially on systems that have large block sizes.
21290 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21291 the obvious value which users understand most easily.
21292
21293 The value of the option is expanded, and must then be a numerical value
21294 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21295 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21296 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21297 be handled.
21298
21299 &*Note*&: A value of zero is interpreted as &"no quota"&.
21300
21301 The expansion happens while Exim is running as root, before it changes uid for
21302 the delivery. This means that files that are inaccessible to the end user can
21303 be used to hold quota values that are looked up in the expansion. When delivery
21304 fails because this quota is exceeded, the handling of the error is as for
21305 system quota failures.
21306
21307 By default, Exim's quota checking mimics system quotas, and restricts the
21308 mailbox to the specified maximum size, though the value is not accurate to the
21309 last byte, owing to separator lines and additional headers that may get added
21310 during message delivery. When a mailbox is nearly full, large messages may get
21311 refused even though small ones are accepted, because the size of the current
21312 message is added to the quota when the check is made. This behaviour can be
21313 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21314 for exceeding the quota does not include the current message. Thus, deliveries
21315 continue until the quota has been exceeded; thereafter, no further messages are
21316 delivered. See also &%quota_warn_threshold%&.
21317
21318
21319 .option quota_directory appendfile string&!! unset
21320 This option defines the directory to check for quota purposes when delivering
21321 into individual files. The default is the delivery directory, or, if a file
21322 called &_maildirfolder_& exists in a maildir directory, the parent of the
21323 delivery directory.
21324
21325
21326 .option quota_filecount appendfile string&!! 0
21327 This option applies when the &%directory%& option is set. It limits the total
21328 number of files in the directory (compare the inode limit in system quotas). It
21329 can only be used if &%quota%& is also set. The value is expanded; an expansion
21330 failure causes delivery to be deferred. A value of zero is interpreted as
21331 &"no quota"&.
21332
21333
21334 .option quota_is_inclusive appendfile boolean true
21335 See &%quota%& above.
21336
21337
21338 .option quota_size_regex appendfile string unset
21339 This option applies when one of the delivery modes that writes a separate file
21340 for each message is being used. When Exim wants to find the size of one of
21341 these files in order to test the quota, it first checks &%quota_size_regex%&.
21342 If this is set to a regular expression that matches the file name, and it
21343 captures one string, that string is interpreted as a representation of the
21344 file's size. The value of &%quota_size_regex%& is not expanded.
21345
21346 This feature is useful only when users have no shell access to their mailboxes
21347 &-- otherwise they could defeat the quota simply by renaming the files. This
21348 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21349 the file length to the file name. For example:
21350 .code
21351 maildir_tag = ,S=$message_size
21352 quota_size_regex = ,S=(\d+)
21353 .endd
21354 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21355 number of lines in the message.
21356
21357 The regular expression should not assume that the length is at the end of the
21358 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21359 sometimes add other information onto the ends of message file names.
21360
21361 Section &<<SECID136>>& contains further information.
21362
21363
21364 .option quota_warn_message appendfile string&!! "see below"
21365 See below for the use of this option. If it is not set when
21366 &%quota_warn_threshold%& is set, it defaults to
21367 .code
21368 quota_warn_message = "\
21369   To: $local_part@$domain\n\
21370   Subject: Your mailbox\n\n\
21371   This message is automatically created \
21372   by mail delivery software.\n\n\
21373   The size of your mailbox has exceeded \
21374   a warning threshold that is\n\
21375   set by the system administrator.\n"
21376 .endd
21377
21378
21379 .option quota_warn_threshold appendfile string&!! 0
21380 .cindex "quota" "warning threshold"
21381 .cindex "mailbox" "size warning"
21382 .cindex "size" "of mailbox"
21383 This option is expanded in the same way as &%quota%& (see above). If the
21384 resulting value is greater than zero, and delivery of the message causes the
21385 size of the file or total space in the directory tree to cross the given
21386 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21387 may be specified as a percentage of it by following the value with a percent
21388 sign. For example:
21389 .code
21390 quota = 10M
21391 quota_warn_threshold = 75%
21392 .endd
21393 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21394 percent sign is ignored.
21395
21396 The warning message itself is specified by the &%quota_warn_message%& option,
21397 and it must start with a &'To:'& header line containing the recipient(s) of the
21398 warning message. These do not necessarily have to include the recipient(s) of
21399 the original message. A &'Subject:'& line should also normally be supplied. You
21400 can include any other header lines that you want. If you do not include a
21401 &'From:'& line, the default is:
21402 .code
21403 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21404 .endd
21405 .oindex &%errors_reply_to%&
21406 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21407 option.
21408
21409 The &%quota%& option does not have to be set in order to use this option; they
21410 are independent of one another except when the threshold is specified as a
21411 percentage.
21412
21413
21414 .option use_bsmtp appendfile boolean false
21415 .cindex "envelope sender"
21416 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21417 format, with the envelope sender and recipient(s) included as SMTP commands. If
21418 you want to include a leading HELO command with such messages, you can do
21419 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21420 for details of batch SMTP.
21421
21422
21423 .option use_crlf appendfile boolean false
21424 .cindex "carriage return"
21425 .cindex "linefeed"
21426 This option causes lines to be terminated with the two-character CRLF sequence
21427 (carriage return, linefeed) instead of just a linefeed character. In the case
21428 of batched SMTP, the byte sequence written to the file is then an exact image
21429 of what would be sent down a real SMTP connection.
21430
21431 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21432 (which are used to supply the traditional &"From&~"& and blank line separators
21433 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21434 carriage return characters if these are needed. In cases where these options
21435 have non-empty defaults, the values end with a single linefeed, so they must be
21436 changed to end with &`\r\n`& if &%use_crlf%& is set.
21437
21438
21439 .option use_fcntl_lock appendfile boolean "see below"
21440 This option controls the use of the &[fcntl()]& function to lock a file for
21441 exclusive use when a message is being appended. It is set by default unless
21442 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21443 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21444 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21445
21446
21447 .option use_flock_lock appendfile boolean false
21448 This option is provided to support the use of &[flock()]& for file locking, for
21449 the few situations where it is needed. Most modern operating systems support
21450 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21451 each other. Exim uses &[fcntl()]& locking by default.
21452
21453 This option is required only if you are using an operating system where
21454 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21455 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21456 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21457
21458 .cindex "Solaris" "&[flock()]& support"
21459 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21460 have it (and some, I think, provide a not quite right version built on top of
21461 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21462 the ability to use it, and any attempt to do so will cause a configuration
21463 error.
21464
21465 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21466 is just being mapped onto &[fcntl()]& by the OS).
21467
21468
21469 .option use_lockfile appendfile boolean "see below"
21470 If this option is turned off, Exim does not attempt to create a lock file when
21471 appending to a mailbox file. In this situation, the only locking is by
21472 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21473 sure that every MUA that is ever going to look at your users' mailboxes uses
21474 &[fcntl()]& rather than a lock file, and even then only when you are not
21475 delivering over NFS from more than one host.
21476
21477 .cindex "NFS" "lock file"
21478 In order to append to an NFS file safely from more than one host, it is
21479 necessary to take out a lock &'before'& opening the file, and the lock file
21480 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21481 file corruption.
21482
21483 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21484 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21485 except when &%mbx_format%& is set.
21486
21487
21488 .option use_mbx_lock appendfile boolean "see below"
21489 This option is available only if Exim has been compiled with SUPPORT_MBX
21490 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21491 locking rules be used. It is set by default if &%mbx_format%& is set and none
21492 of the locking options are mentioned in the configuration. The locking rules
21493 are the same as are used by the &'c-client'& library that underlies Pine and
21494 the IMAP4 and POP daemons that come with it (see the discussion below). The
21495 rules allow for shared access to the mailbox. However, this kind of locking
21496 does not work when the mailbox is NFS mounted.
21497
21498 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21499 &%use_flock_lock%& to control what kind of locking is used in implementing the
21500 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21501 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21502
21503
21504
21505
21506 .section "Operational details for appending" "SECTopappend"
21507 .cindex "appending to a file"
21508 .cindex "file" "appending"
21509 Before appending to a file, the following preparations are made:
21510
21511 .ilist
21512 If the name of the file is &_/dev/null_&, no action is taken, and a success
21513 return is given.
21514
21515 .next
21516 .cindex "directory creation"
21517 If any directories on the file's path are missing, Exim creates them if the
21518 &%create_directory%& option is set. A created directory's mode is given by the
21519 &%directory_mode%& option.
21520
21521 .next
21522 If &%file_format%& is set, the format of an existing file is checked. If this
21523 indicates that a different transport should be used, control is passed to that
21524 transport.
21525
21526 .next
21527 .cindex "file" "locking"
21528 .cindex "locking files"
21529 .cindex "NFS" "lock file"
21530 If &%use_lockfile%& is set, a lock file is built in a way that will work
21531 reliably over NFS, as follows:
21532
21533 .olist
21534 Create a &"hitching post"& file whose name is that of the lock file with the
21535 current time, primary host name, and process id added, by opening for writing
21536 as a new file. If this fails with an access error, delivery is deferred.
21537 .next
21538 Close the hitching post file, and hard link it to the lock file name.
21539 .next
21540 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21541 Unlink the hitching post name.
21542 .next
21543 Otherwise, use &[stat()]& to get information about the hitching post file, and
21544 then unlink hitching post name. If the number of links is exactly two, creation
21545 of the lock file succeeded but something (for example, an NFS server crash and
21546 restart) caused this fact not to be communicated to the &[link()]& call.
21547 .next
21548 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21549 up to &%lock_retries%& times. However, since any program that writes to a
21550 mailbox should complete its task very quickly, it is reasonable to time out old
21551 lock files that are normally the result of user agent and system crashes. If an
21552 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21553 it before trying again.
21554 .endlist olist
21555
21556 .next
21557 A call is made to &[lstat()]& to discover whether the main file exists, and if
21558 so, what its characteristics are. If &[lstat()]& fails for any reason other
21559 than non-existence, delivery is deferred.
21560
21561 .next
21562 .cindex "symbolic link" "to mailbox"
21563 .cindex "mailbox" "symbolic link"
21564 If the file does exist and is a symbolic link, delivery is deferred, unless the
21565 &%allow_symlink%& option is set, in which case the ownership of the link is
21566 checked, and then &[stat()]& is called to find out about the real file, which
21567 is then subjected to the checks below. The check on the top-level link
21568 ownership prevents one user creating a link for another's mailbox in a sticky
21569 directory, though allowing symbolic links in this case is definitely not a good
21570 idea. If there is a chain of symbolic links, the intermediate ones are not
21571 checked.
21572
21573 .next
21574 If the file already exists but is not a regular file, or if the file's owner
21575 and group (if the group is being checked &-- see &%check_group%& above) are
21576 different from the user and group under which the delivery is running,
21577 delivery is deferred.
21578
21579 .next
21580 If the file's permissions are more generous than specified, they are reduced.
21581 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21582 is set false, in which case the delivery is tried using the existing
21583 permissions.
21584
21585 .next
21586 The file's inode number is saved, and the file is then opened for appending.
21587 If this fails because the file has vanished, &(appendfile)& behaves as if it
21588 hadn't existed (see below). For any other failures, delivery is deferred.
21589
21590 .next
21591 If the file is opened successfully, check that the inode number hasn't
21592 changed, that it is still a regular file, and that the owner and permissions
21593 have not changed. If anything is wrong, defer delivery and freeze the message.
21594
21595 .next
21596 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21597 option is set. Otherwise, check that the file is being created in a permitted
21598 directory if the &%create_file%& option is set (deferring on failure), and then
21599 open for writing as a new file, with the O_EXCL and O_CREAT options,
21600 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21601 set). In this case, which can happen if the link points to a non-existent file,
21602 the file is opened for writing using O_CREAT but not O_EXCL, because
21603 that prevents link following.
21604
21605 .next
21606 .cindex "loop" "while file testing"
21607 If opening fails because the file exists, obey the tests given above for
21608 existing files. However, to avoid looping in a situation where the file is
21609 being continuously created and destroyed, the exists/not-exists loop is broken
21610 after 10 repetitions, and the message is then frozen.
21611
21612 .next
21613 If opening fails with any other error, defer delivery.
21614
21615 .next
21616 .cindex "file" "locking"
21617 .cindex "locking files"
21618 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21619 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21620 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21621 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21622 file, and an exclusive lock on the file whose name is
21623 .code
21624 /tmp/.<device-number>.<inode-number>
21625 .endd
21626 using the device and inode numbers of the open mailbox file, in accordance with
21627 the MBX locking rules. This file is created with a mode that is specified by
21628 the &%lockfile_mode%& option.
21629
21630 If Exim fails to lock the file, there are two possible courses of action,
21631 depending on the value of the locking timeout. This is obtained from
21632 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21633
21634 If the timeout value is zero, the file is closed, Exim waits for
21635 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21636 to lock it again. This happens up to &%lock_retries%& times, after which the
21637 delivery is deferred.
21638
21639 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21640 &[flock()]& are used (with the given timeout), so there has already been some
21641 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21642 immediately. It retries up to
21643 .code
21644 (lock_retries * lock_interval) / <timeout>
21645 .endd
21646 times (rounded up).
21647 .endlist
21648
21649 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21650 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21651
21652
21653 .section "Operational details for delivery to a new file" "SECTopdir"
21654 .cindex "delivery" "to single file"
21655 .cindex "&""From""& line"
21656 When the &%directory%& option is set instead of &%file%&, each message is
21657 delivered into a newly-created file or set of files. When &(appendfile)& is
21658 activated directly from a &(redirect)& router, neither &%file%& nor
21659 &%directory%& is normally set, because the path for delivery is supplied by the
21660 router. (See for example, the &(address_file)& transport in the default
21661 configuration.) In this case, delivery is to a new file if either the path name
21662 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21663
21664 No locking is required while writing the message to a new file, so the various
21665 locking options of the transport are ignored. The &"From"& line that by default
21666 separates messages in a single file is not normally needed, nor is the escaping
21667 of message lines that start with &"From"&, and there is no need to ensure a
21668 newline at the end of each message. Consequently, the default values for
21669 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21670 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21671
21672 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21673 the files in the delivery directory by default. However, you can specify a
21674 different directory by setting &%quota_directory%&. Also, for maildir
21675 deliveries (see below) the &_maildirfolder_& convention is honoured.
21676
21677
21678 .cindex "maildir format"
21679 .cindex "mailstore format"
21680 There are three different ways in which delivery to individual files can be
21681 done, controlled by the settings of the &%maildir_format%& and
21682 &%mailstore_format%& options. Note that code to support maildir or mailstore
21683 formats is not included in the binary unless SUPPORT_MAILDIR or
21684 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21685
21686 .cindex "directory creation"
21687 In all three cases an attempt is made to create the directory and any necessary
21688 sub-directories if they do not exist, provided that the &%create_directory%&
21689 option is set (the default). The location of a created directory can be
21690 constrained by setting &%create_file%&. A created directory's mode is given by
21691 the &%directory_mode%& option. If creation fails, or if the
21692 &%create_directory%& option is not set when creation is required, delivery is
21693 deferred.
21694
21695
21696
21697 .section "Maildir delivery" "SECTmaildirdelivery"
21698 .cindex "maildir format" "description of"
21699 If the &%maildir_format%& option is true, Exim delivers each message by writing
21700 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21701 directory that is defined by the &%directory%& option (the &"delivery
21702 directory"&). If the delivery is successful, the file is renamed into the
21703 &_new_& subdirectory.
21704
21705 In the file name, <&'stime'&> is the current time of day in seconds, and
21706 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21707 Exim checks that the time-of-day clock has moved on by at least one microsecond
21708 before terminating the delivery process. This guarantees uniqueness for the
21709 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21710 opening it. If any response other than ENOENT (does not exist) is given,
21711 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21712
21713 Before Exim carries out a maildir delivery, it ensures that subdirectories
21714 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21715 do not exist, Exim tries to create them and any superior directories in their
21716 path, subject to the &%create_directory%& and &%create_file%& options. If the
21717 &%maildirfolder_create_regex%& option is set, and the regular expression it
21718 contains matches the delivery directory, Exim also ensures that a file called
21719 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21720 &_maildirfolder_& file cannot be created, delivery is deferred.
21721
21722 These features make it possible to use Exim to create all the necessary files
21723 and directories in a maildir mailbox, including subdirectories for maildir++
21724 folders. Consider this example:
21725 .code
21726 maildir_format = true
21727 directory = /var/mail/$local_part\
21728            ${if eq{$local_part_suffix}{}{}\
21729            {/.${substr_1:$local_part_suffix}}}
21730 maildirfolder_create_regex = /\.[^/]+$
21731 .endd
21732 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21733 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21734 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21735 not match this name, so Exim will not look for or create the file
21736 &_/var/mail/pimbo/maildirfolder_&, though it will create
21737 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21738
21739 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21740 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21741 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21742 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21743 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21744
21745 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21746 not inadvertently match the toplevel maildir directory, because a
21747 &_maildirfolder_& file at top level would completely break quota calculations.
21748
21749 .cindex "quota" "in maildir delivery"
21750 .cindex "maildir++"
21751 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21752 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21753 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21754 Exim assumes the directory is a maildir++ folder directory, which is one level
21755 down from the user's top level mailbox directory. This causes it to start at
21756 the parent directory instead of the current directory when calculating the
21757 amount of space used.
21758
21759 One problem with delivering into a multi-file mailbox is that it is
21760 computationally expensive to compute the size of the mailbox for quota
21761 checking. Various approaches have been taken to reduce the amount of work
21762 needed. The next two sections describe two of them. A third alternative is to
21763 use some external process for maintaining the size data, and use the expansion
21764 of the &%mailbox_size%& option as a way of importing it into Exim.
21765
21766
21767
21768
21769 .section "Using tags to record message sizes" "SECID135"
21770 If &%maildir_tag%& is set, the string is expanded for each delivery.
21771 When the maildir file is renamed into the &_new_& sub-directory, the
21772 tag is added to its name. However, if adding the tag takes the length of the
21773 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21774 the tag is dropped and the maildir file is created with no tag.
21775
21776
21777 .vindex "&$message_size$&"
21778 Tags can be used to encode the size of files in their names; see
21779 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21780 happens after the message has been written. The value of the &$message_size$&
21781 variable is set to the number of bytes actually written. If the expansion is
21782 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21783 be deferred. The expanded tag may contain any printing characters except &"/"&.
21784 Non-printing characters in the string are ignored; if the resulting string is
21785 empty, it is ignored. If it starts with an alphanumeric character, a leading
21786 colon is inserted; this default has not proven to be the path that popular
21787 maildir implementations have chosen (but changing it in Exim would break
21788 backwards compatibility).
21789
21790 For one common implementation, you might set:
21791 .code
21792 maildir_tag = ,S=${message_size}
21793 .endd
21794 but you should check the documentation of the other software to be sure.
21795
21796 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21797 as this allows Exim to extract the size from your tag, instead of having to
21798 &[stat()]& each message file.
21799
21800
21801 .section "Using a maildirsize file" "SECID136"
21802 .cindex "quota" "in maildir delivery"
21803 .cindex "maildir format" "&_maildirsize_& file"
21804 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21805 storing quota and message size information in a file called &_maildirsize_&
21806 within the toplevel maildir directory. If this file does not exist, Exim
21807 creates it, setting the quota from the &%quota%& option of the transport. If
21808 the maildir directory itself does not exist, it is created before any attempt
21809 to write a &_maildirsize_& file.
21810
21811 The &_maildirsize_& file is used to hold information about the sizes of
21812 messages in the maildir, thus speeding up quota calculations. The quota value
21813 in the file is just a cache; if the quota is changed in the transport, the new
21814 value overrides the cached value when the next message is delivered. The cache
21815 is maintained for the benefit of other programs that access the maildir and
21816 need to know the quota.
21817
21818 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21819 file is maintained (with a zero quota setting), but no quota is imposed.
21820
21821 A regular expression is available for controlling which directories in the
21822 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21823 See the description of the &%maildir_quota_directory_regex%& option above for
21824 details.
21825
21826
21827 .section "Mailstore delivery" "SECID137"
21828 .cindex "mailstore format" "description of"
21829 If the &%mailstore_format%& option is true, each message is written as two
21830 files in the given directory. A unique base name is constructed from the
21831 message id and the current delivery process, and the files that are written use
21832 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21833 contains the message's envelope, and the &_.msg_& file contains the message
21834 itself. The base name is placed in the variable &$mailstore_basename$&.
21835
21836 During delivery, the envelope is first written to a file with the suffix
21837 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21838 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21839 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21840 file before accessing either of them. An alternative approach is to wait for
21841 the absence of a &_.tmp_& file.
21842
21843 The envelope file starts with any text defined by the &%mailstore_prefix%&
21844 option, expanded and terminated by a newline if there isn't one. Then follows
21845 the sender address on one line, then all the recipient addresses, one per line.
21846 There can be more than one recipient only if the &%batch_max%& option is set
21847 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21848 appended to the file, followed by a newline if it does not end with one.
21849
21850 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21851 failure, it is ignored. Other expansion errors are treated as serious
21852 configuration errors, and delivery is deferred. The variable
21853 &$mailstore_basename$& is available for use during these expansions.
21854
21855
21856 .section "Non-special new file delivery" "SECID138"
21857 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21858 file is created directly in the named directory. For example, when delivering
21859 messages into files in batched SMTP format for later delivery to some host (see
21860 section &<<SECTbatchSMTP>>&), a setting such as
21861 .code
21862 directory = /var/bsmtp/$host
21863 .endd
21864 might be used. A message is written to a file with a temporary name, which is
21865 then renamed when the delivery is complete. The final name is obtained by
21866 expanding the contents of the &%directory_file%& option.
21867 .ecindex IIDapptra1
21868 .ecindex IIDapptra2
21869
21870
21871
21872
21873
21874
21875 . ////////////////////////////////////////////////////////////////////////////
21876 . ////////////////////////////////////////////////////////////////////////////
21877
21878 .chapter "The autoreply transport" "CHID8"
21879 .scindex IIDauttra1 "transports" "&(autoreply)&"
21880 .scindex IIDauttra2 "&(autoreply)& transport"
21881 The &(autoreply)& transport is not a true transport in that it does not cause
21882 the message to be transmitted. Instead, it generates a new mail message as an
21883 automatic reply to the incoming message. &'References:'& and
21884 &'Auto-Submitted:'& header lines are included. These are constructed according
21885 to the rules in RFCs 2822 and 3834, respectively.
21886
21887 If the router that passes the message to this transport does not have the
21888 &%unseen%& option set, the original message (for the current recipient) is not
21889 delivered anywhere. However, when the &%unseen%& option is set on the router
21890 that passes the message to this transport, routing of the address continues, so
21891 another router can set up a normal message delivery.
21892
21893
21894 The &(autoreply)& transport is usually run as the result of mail filtering, a
21895 &"vacation"& message being the standard example. However, it can also be run
21896 directly from a router like any other transport. To reduce the possibility of
21897 message cascades, messages created by the &(autoreply)& transport always have
21898 empty envelope sender addresses, like bounce messages.
21899
21900 The parameters of the message to be sent can be specified in the configuration
21901 by options described below. However, these are used only when the address
21902 passed to the transport does not contain its own reply information. When the
21903 transport is run as a consequence of a
21904 &%mail%&
21905 or &%vacation%& command in a filter file, the parameters of the message are
21906 supplied by the filter, and passed with the address. The transport's options
21907 that define the message are then ignored (so they are not usually set in this
21908 case). The message is specified entirely by the filter or by the transport; it
21909 is never built from a mixture of options. However, the &%file_optional%&,
21910 &%mode%&, and &%return_message%& options apply in all cases.
21911
21912 &(Autoreply)& is implemented as a local transport. When used as a result of a
21913 command in a user's filter file, &(autoreply)& normally runs under the uid and
21914 gid of the user, and with appropriate current and home directories (see chapter
21915 &<<CHAPenvironment>>&).
21916
21917 There is a subtle difference between routing a message to a &(pipe)& transport
21918 that generates some text to be returned to the sender, and routing it to an
21919 &(autoreply)& transport. This difference is noticeable only if more than one
21920 address from the same message is so handled. In the case of a pipe, the
21921 separate outputs from the different addresses are gathered up and returned to
21922 the sender in a single message, whereas if &(autoreply)& is used, a separate
21923 message is generated for each address that is passed to it.
21924
21925 Non-printing characters are not permitted in the header lines generated for the
21926 message that &(autoreply)& creates, with the exception of newlines that are
21927 immediately followed by white space. If any non-printing characters are found,
21928 the transport defers.
21929 Whether characters with the top bit set count as printing characters or not is
21930 controlled by the &%print_topbitchars%& global option.
21931
21932 If any of the generic options for manipulating headers (for example,
21933 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21934 of the original message that is included in the generated message when
21935 &%return_message%& is set. They do not apply to the generated message itself.
21936
21937 .vindex "&$sender_address$&"
21938 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21939 the message, indicating that there were no recipients, it does not treat this
21940 as an error. This means that autoreplies sent to &$sender_address$& when this
21941 is empty (because the incoming message is a bounce message) do not cause
21942 problems. They are just discarded.
21943
21944
21945
21946 .section "Private options for autoreply" "SECID139"
21947 .cindex "options" "&(autoreply)& transport"
21948
21949 .option bcc autoreply string&!! unset
21950 This specifies the addresses that are to receive &"blind carbon copies"& of the
21951 message when the message is specified by the transport.
21952
21953
21954 .option cc autoreply string&!! unset
21955 This specifies recipients of the message and the contents of the &'Cc:'& header
21956 when the message is specified by the transport.
21957
21958
21959 .option file autoreply string&!! unset
21960 The contents of the file are sent as the body of the message when the message
21961 is specified by the transport. If both &%file%& and &%text%& are set, the text
21962 string comes first.
21963
21964
21965 .option file_expand autoreply boolean false
21966 If this is set, the contents of the file named by the &%file%& option are
21967 subjected to string expansion as they are added to the message.
21968
21969
21970 .option file_optional autoreply boolean false
21971 If this option is true, no error is generated if the file named by the &%file%&
21972 option or passed with the address does not exist or cannot be read.
21973
21974
21975 .option from autoreply string&!! unset
21976 This specifies the contents of the &'From:'& header when the message is
21977 specified by the transport.
21978
21979
21980 .option headers autoreply string&!! unset
21981 This specifies additional RFC 2822 headers that are to be added to the message
21982 when the message is specified by the transport. Several can be given by using
21983 &"\n"& to separate them. There is no check on the format.
21984
21985
21986 .option log autoreply string&!! unset
21987 This option names a file in which a record of every message sent is logged when
21988 the message is specified by the transport.
21989
21990
21991 .option mode autoreply "octal integer" 0600
21992 If either the log file or the &"once"& file has to be created, this mode is
21993 used.
21994
21995
21996 .option never_mail autoreply "address list&!!" unset
21997 If any run of the transport creates a message with a recipient that matches any
21998 item in the list, that recipient is quietly discarded. If all recipients are
21999 discarded, no message is created. This applies both when the recipients are
22000 generated by a filter and when they are specified in the transport.
22001
22002
22003
22004 .option once autoreply string&!! unset
22005 This option names a file or DBM database in which a record of each &'To:'&
22006 recipient is kept when the message is specified by the transport. &*Note*&:
22007 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22008
22009 If &%once%& is unset, or is set to an empty string, the message is always sent.
22010 By default, if &%once%& is set to a non-empty file name, the message
22011 is not sent if a potential recipient is already listed in the database.
22012 However, if the &%once_repeat%& option specifies a time greater than zero, the
22013 message is sent if that much time has elapsed since a message was last sent to
22014 this recipient. A setting of zero time for &%once_repeat%& (the default)
22015 prevents a message from being sent a second time &-- in this case, zero means
22016 infinity.
22017
22018 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22019 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22020 greater than zero, it changes the way Exim implements the &%once%& option.
22021 Instead of using a DBM file to record every recipient it sends to, it uses a
22022 regular file, whose size will never get larger than the given value.
22023
22024 In the file, Exim keeps a linear list of recipient addresses and the times at
22025 which they were sent messages. If the file is full when a new address needs to
22026 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22027 means that a given recipient may receive multiple messages, but at
22028 unpredictable intervals that depend on the rate of turnover of addresses in the
22029 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22030
22031
22032 .option once_file_size autoreply integer 0
22033 See &%once%& above.
22034
22035
22036 .option once_repeat autoreply time&!! 0s
22037 See &%once%& above.
22038 After expansion, the value of this option must be a valid time value.
22039
22040
22041 .option reply_to autoreply string&!! unset
22042 This specifies the contents of the &'Reply-To:'& header when the message is
22043 specified by the transport.
22044
22045
22046 .option return_message autoreply boolean false
22047 If this is set, a copy of the original message is returned with the new
22048 message, subject to the maximum size set in the &%return_size_limit%& global
22049 configuration option.
22050
22051
22052 .option subject autoreply string&!! unset
22053 This specifies the contents of the &'Subject:'& header when the message is
22054 specified by the transport. It is tempting to quote the original subject in
22055 automatic responses. For example:
22056 .code
22057 subject = Re: $h_subject:
22058 .endd
22059 There is a danger in doing this, however. It may allow a third party to
22060 subscribe your users to an opt-in mailing list, provided that the list accepts
22061 bounce messages as subscription confirmations. Well-managed lists require a
22062 non-bounce message to confirm a subscription, so the danger is relatively
22063 small.
22064
22065
22066
22067 .option text autoreply string&!! unset
22068 This specifies a single string to be used as the body of the message when the
22069 message is specified by the transport. If both &%text%& and &%file%& are set,
22070 the text comes first.
22071
22072
22073 .option to autoreply string&!! unset
22074 This specifies recipients of the message and the contents of the &'To:'& header
22075 when the message is specified by the transport.
22076 .ecindex IIDauttra1
22077 .ecindex IIDauttra2
22078
22079
22080
22081
22082 . ////////////////////////////////////////////////////////////////////////////
22083 . ////////////////////////////////////////////////////////////////////////////
22084
22085 .chapter "The lmtp transport" "CHAPLMTP"
22086 .cindex "transports" "&(lmtp)&"
22087 .cindex "&(lmtp)& transport"
22088 .cindex "LMTP" "over a pipe"
22089 .cindex "LMTP" "over a socket"
22090 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22091 specified command
22092 or by interacting with a Unix domain socket.
22093 This transport is something of a cross between the &(pipe)& and &(smtp)&
22094 transports. Exim also has support for using LMTP over TCP/IP; this is
22095 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22096 to be of minority interest, the default build-time configure in &_src/EDITME_&
22097 has it commented out. You need to ensure that
22098 .code
22099 TRANSPORT_LMTP=yes
22100 .endd
22101 .cindex "options" "&(lmtp)& transport"
22102 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22103 included in the Exim binary. The private options of the &(lmtp)& transport are
22104 as follows:
22105
22106 .option batch_id lmtp string&!! unset
22107 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22108
22109
22110 .option batch_max lmtp integer 1
22111 This limits the number of addresses that can be handled in a single delivery.
22112 Most LMTP servers can handle several addresses at once, so it is normally a
22113 good idea to increase this value. See the description of local delivery
22114 batching in chapter &<<CHAPbatching>>&.
22115
22116
22117 .option command lmtp string&!! unset
22118 This option must be set if &%socket%& is not set. The string is a command which
22119 is run in a separate process. It is split up into a command name and list of
22120 arguments, each of which is separately expanded (so expansion cannot change the
22121 number of arguments). The command is run directly, not via a shell. The message
22122 is passed to the new process using the standard input and output to operate the
22123 LMTP protocol.
22124
22125 .option ignore_quota lmtp boolean false
22126 .cindex "LMTP" "ignoring quota errors"
22127 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22128 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22129 in its response to the LHLO command.
22130
22131 .option socket lmtp string&!! unset
22132 This option must be set if &%command%& is not set. The result of expansion must
22133 be the name of a Unix domain socket. The transport connects to the socket and
22134 delivers the message to it using the LMTP protocol.
22135
22136
22137 .option timeout lmtp time 5m
22138 The transport is aborted if the created process or Unix domain socket does not
22139 respond to LMTP commands or message input within this timeout. Delivery
22140 is deferred, and will be tried again later. Here is an example of a typical
22141 LMTP transport:
22142 .code
22143 lmtp:
22144   driver = lmtp
22145   command = /some/local/lmtp/delivery/program
22146   batch_max = 20
22147   user = exim
22148 .endd
22149 This delivers up to 20 addresses at a time, in a mixture of domains if
22150 necessary, running as the user &'exim'&.
22151
22152
22153
22154 . ////////////////////////////////////////////////////////////////////////////
22155 . ////////////////////////////////////////////////////////////////////////////
22156
22157 .chapter "The pipe transport" "CHAPpipetransport"
22158 .scindex IIDpiptra1 "transports" "&(pipe)&"
22159 .scindex IIDpiptra2 "&(pipe)& transport"
22160 The &(pipe)& transport is used to deliver messages via a pipe to a command
22161 running in another process. One example is the use of &(pipe)& as a
22162 pseudo-remote transport for passing messages to some other delivery mechanism
22163 (such as UUCP). Another is the use by individual users to automatically process
22164 their incoming messages. The &(pipe)& transport can be used in one of the
22165 following ways:
22166
22167 .ilist
22168 .vindex "&$local_part$&"
22169 A router routes one address to a transport in the normal way, and the
22170 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22171 contains the local part of the address (as usual), and the command that is run
22172 is specified by the &%command%& option on the transport.
22173 .next
22174 .vindex "&$pipe_addresses$&"
22175 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22176 transport can handle more than one address in a single run. In this case, when
22177 more than one address is routed to the transport, &$local_part$& is not set
22178 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22179 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22180 that are routed to the transport.
22181 .next
22182 .vindex "&$address_pipe$&"
22183 A router redirects an address directly to a pipe command (for example, from an
22184 alias or forward file). In this case, &$address_pipe$& contains the text of the
22185 pipe command, and the &%command%& option on the transport is ignored unless
22186 &%force_command%& is set. If only one address is being transported
22187 (&%batch_max%& is not greater than one, or only one address was redirected to
22188 this pipe command), &$local_part$& contains the local part that was redirected.
22189 .endlist
22190
22191
22192 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22193 deliver messages over pipes using the LMTP interactive protocol. This is
22194 implemented by the &(lmtp)& transport.
22195
22196 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22197 &_.forward_& file, the command runs under the uid and gid of that user. In
22198 other cases, the uid and gid have to be specified explicitly, either on the
22199 transport or on the router that handles the address. Current and &"home"&
22200 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22201 details of the local delivery environment and chapter &<<CHAPbatching>>&
22202 for a discussion of local delivery batching.
22203
22204
22205 .section "Concurrent delivery" "SECID140"
22206 If two messages arrive at almost the same time, and both are routed to a pipe
22207 delivery, the two pipe transports may be run concurrently. You must ensure that
22208 any pipe commands you set up are robust against this happening. If the commands
22209 write to a file, the &%exim_lock%& utility might be of use.
22210
22211
22212
22213
22214 .section "Returned status and data" "SECID141"
22215 .cindex "&(pipe)& transport" "returned data"
22216 If the command exits with a non-zero return code, the delivery is deemed to
22217 have failed, unless either the &%ignore_status%& option is set (in which case
22218 the return code is treated as zero), or the return code is one of those listed
22219 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22220 later"&. In this case, delivery is deferred. Details of a permanent failure are
22221 logged, but are not included in the bounce message, which merely contains
22222 &"local delivery failed"&.
22223
22224 If the command exits on a signal and the &%freeze_signal%& option is set then
22225 the message will be frozen in the queue. If that option is not set, a bounce
22226 will be sent as normal.
22227
22228 If the return code is greater than 128 and the command being run is a shell
22229 script, it normally means that the script was terminated by a signal whose
22230 value is the return code minus 128. The &%freeze_signal%& option does not
22231 apply in this case.
22232
22233 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22234 return code is set to 127. This is the value that a shell returns if it is
22235 asked to run a non-existent command. The wording for the log line suggests that
22236 a non-existent command may be the problem.
22237
22238 The &%return_output%& option can affect the result of a pipe delivery. If it is
22239 set and the command produces any output on its standard output or standard
22240 error streams, the command is considered to have failed, even if it gave a zero
22241 return code or if &%ignore_status%& is set. The output from the command is
22242 included as part of the bounce message. The &%return_fail_output%& option is
22243 similar, except that output is returned only when the command exits with a
22244 failure return code, that is, a value other than zero or a code that matches
22245 &%temp_errors%&.
22246
22247
22248
22249 .section "How the command is run" "SECThowcommandrun"
22250 .cindex "&(pipe)& transport" "path for command"
22251 The command line is (by default) broken down into a command name and arguments
22252 by the &(pipe)& transport itself. The &%allow_commands%& and
22253 &%restrict_to_path%& options can be used to restrict the commands that may be
22254 run.
22255
22256 .cindex "quoting" "in pipe command"
22257 Unquoted arguments are delimited by white space. If an argument appears in
22258 double quotes, backslash is interpreted as an escape character in the usual
22259 way. If an argument appears in single quotes, no escaping is done.
22260
22261 String expansion is applied to the command line except when it comes from a
22262 traditional &_.forward_& file (commands from a filter file are expanded). The
22263 expansion is applied to each argument in turn rather than to the whole line.
22264 For this reason, any string expansion item that contains white space must be
22265 quoted so as to be contained within a single argument. A setting such as
22266 .code
22267 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22268 .endd
22269 will not work, because the expansion item gets split between several
22270 arguments. You have to write
22271 .code
22272 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22273 .endd
22274 to ensure that it is all in one argument. The expansion is done in this way,
22275 argument by argument, so that the number of arguments cannot be changed as a
22276 result of expansion, and quotes or backslashes in inserted variables do not
22277 interact with external quoting. However, this leads to problems if you want to
22278 generate multiple arguments (or the command name plus arguments) from a single
22279 expansion. In this situation, the simplest solution is to use a shell. For
22280 example:
22281 .code
22282 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22283 .endd
22284
22285 .cindex "transport" "filter"
22286 .cindex "filter" "transport filter"
22287 .vindex "&$pipe_addresses$&"
22288 Special handling takes place when an argument consists of precisely the text
22289 &`$pipe_addresses`&. This is not a general expansion variable; the only
22290 place this string is recognized is when it appears as an argument for a pipe or
22291 transport filter command. It causes each address that is being handled to be
22292 inserted in the argument list at that point &'as a separate argument'&. This
22293 avoids any problems with spaces or shell metacharacters, and is of use when a
22294 &(pipe)& transport is handling groups of addresses in a batch.
22295
22296 If &%force_command%& is enabled on the transport, Special handling takes place
22297 for an argument that consists of precisely the text &`$address_pipe`&.  It
22298 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22299 argument is inserted in the argument list at that point
22300 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22301 the only item in the argument; in fact, if it were then &%force_command%&
22302 should behave as a no-op.  Rather, it should be used to adjust the command
22303 run while preserving the argument vector separation.
22304
22305 After splitting up into arguments and expansion, the resulting command is run
22306 in a subprocess directly from the transport, &'not'& under a shell. The
22307 message that is being delivered is supplied on the standard input, and the
22308 standard output and standard error are both connected to a single pipe that is
22309 read by Exim. The &%max_output%& option controls how much output the command
22310 may produce, and the &%return_output%& and &%return_fail_output%& options
22311 control what is done with it.
22312
22313 Not running the command under a shell (by default) lessens the security risks
22314 in cases when a command from a user's filter file is built out of data that was
22315 taken from an incoming message. If a shell is required, it can of course be
22316 explicitly specified as the command to be run. However, there are circumstances
22317 where existing commands (for example, in &_.forward_& files) expect to be run
22318 under a shell and cannot easily be modified. To allow for these cases, there is
22319 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22320 works. Instead of breaking up the command line as just described, it expands it
22321 as a single string and passes the result to &_/bin/sh_&. The
22322 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22323 with &%use_shell%&, and the whole mechanism is inherently less secure.
22324
22325
22326
22327 .section "Environment variables" "SECTpipeenv"
22328 .cindex "&(pipe)& transport" "environment for command"
22329 .cindex "environment for pipe transport"
22330 The environment variables listed below are set up when the command is invoked.
22331 This list is a compromise for maximum compatibility with other MTAs. Note that
22332 the &%environment%& option can be used to add additional variables to this
22333 environment.
22334 .display
22335 &`DOMAIN            `&   the domain of the address
22336 &`HOME              `&   the home directory, if set
22337 &`HOST              `&   the host name when called from a router (see below)
22338 &`LOCAL_PART        `&   see below
22339 &`LOCAL_PART_PREFIX `&   see below
22340 &`LOCAL_PART_SUFFIX `&   see below
22341 &`LOGNAME           `&   see below
22342 &`MESSAGE_ID        `&   Exim's local ID for the message
22343 &`PATH              `&   as specified by the &%path%& option below
22344 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22345 &`RECIPIENT         `&   the complete recipient address
22346 &`SENDER            `&   the sender of the message (empty if a bounce)
22347 &`SHELL             `&   &`/bin/sh`&
22348 &`TZ                `&   the value of the &%timezone%& option, if set
22349 &`USER              `&   see below
22350 .endd
22351 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22352 router, LOCAL_PART is set to the local part of the address. When it is
22353 called as a result of a forward or alias expansion, LOCAL_PART is set to
22354 the local part of the address that was expanded. In both cases, any affixes are
22355 removed from the local part, and made available in LOCAL_PART_PREFIX and
22356 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22357 same value as LOCAL_PART for compatibility with other MTAs.
22358
22359 .cindex "HOST"
22360 HOST is set only when a &(pipe)& transport is called from a router that
22361 associates hosts with an address, typically when using &(pipe)& as a
22362 pseudo-remote transport. HOST is set to the first host name specified by
22363 the router.
22364
22365 .cindex "HOME"
22366 If the transport's generic &%home_directory%& option is set, its value is used
22367 for the HOME environment variable. Otherwise, a home directory may be set
22368 by the router's &%transport_home_directory%& option, which defaults to the
22369 user's home directory if &%check_local_user%& is set.
22370
22371
22372 .section "Private options for pipe" "SECID142"
22373 .cindex "options" "&(pipe)& transport"
22374
22375
22376
22377 .option allow_commands pipe "string list&!!" unset
22378 .cindex "&(pipe)& transport" "permitted commands"
22379 The string is expanded, and is then interpreted as a colon-separated list of
22380 permitted commands. If &%restrict_to_path%& is not set, the only commands
22381 permitted are those in the &%allow_commands%& list. They need not be absolute
22382 paths; the &%path%& option is still used for relative paths. If
22383 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22384 in the &%allow_commands%& list, or a name without any slashes that is found on
22385 the path. In other words, if neither &%allow_commands%& nor
22386 &%restrict_to_path%& is set, there is no restriction on the command, but
22387 otherwise only commands that are permitted by one or the other are allowed. For
22388 example, if
22389 .code
22390 allow_commands = /usr/bin/vacation
22391 .endd
22392 and &%restrict_to_path%& is not set, the only permitted command is
22393 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22394 &%use_shell%& is set.
22395
22396
22397 .option batch_id pipe string&!! unset
22398 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22399
22400
22401 .option batch_max pipe integer 1
22402 This limits the number of addresses that can be handled in a single delivery.
22403 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22404
22405
22406 .option check_string pipe string unset
22407 As &(pipe)& writes the message, the start of each line is tested for matching
22408 &%check_string%&, and if it does, the initial matching characters are replaced
22409 by the contents of &%escape_string%&, provided both are set. The value of
22410 &%check_string%& is a literal string, not a regular expression, and the case of
22411 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22412 of &%check_string%& and &%escape_string%& are forced to values that implement
22413 the SMTP escaping protocol. Any settings made in the configuration file are
22414 ignored.
22415
22416
22417 .option command pipe string&!! unset
22418 This option need not be set when &(pipe)& is being used to deliver to pipes
22419 obtained directly from address redirections. In other cases, the option must be
22420 set, to provide a command to be run. It need not yield an absolute path (see
22421 the &%path%& option below). The command is split up into separate arguments by
22422 Exim, and each argument is separately expanded, as described in section
22423 &<<SECThowcommandrun>>& above.
22424
22425
22426 .option environment pipe string&!! unset
22427 .cindex "&(pipe)& transport" "environment for command"
22428 .cindex "environment for &(pipe)& transport"
22429 This option is used to add additional variables to the environment in which the
22430 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22431 a string which is expanded, and then interpreted as a colon-separated list of
22432 environment settings of the form <&'name'&>=<&'value'&>.
22433
22434
22435 .option escape_string pipe string unset
22436 See &%check_string%& above.
22437
22438
22439 .option freeze_exec_fail pipe boolean false
22440 .cindex "exec failure"
22441 .cindex "failure of exec"
22442 .cindex "&(pipe)& transport" "failure of exec"
22443 Failure to exec the command in a pipe transport is by default treated like
22444 any other failure while running the command. However, if &%freeze_exec_fail%&
22445 is set, failure to exec is treated specially, and causes the message to be
22446 frozen, whatever the setting of &%ignore_status%&.
22447
22448
22449 .option freeze_signal pipe boolean false
22450 .cindex "signal exit"
22451 .cindex "&(pipe)& transport", "signal exit"
22452 Normally if the process run by a command in a pipe transport exits on a signal,
22453 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22454 frozen in Exim's queue instead.
22455
22456
22457 .option force_command pipe boolean false
22458 .cindex "force command"
22459 .cindex "&(pipe)& transport", "force command"
22460 Normally when a router redirects an address directly to a pipe command
22461 the &%command%& option on the transport is ignored.  If &%force_command%&
22462 is set, the &%command%& option will used. This is especially
22463 useful for forcing a wrapper or additional argument to be added to the
22464 command. For example:
22465 .code
22466 command = /usr/bin/remote_exec myhost -- $address_pipe
22467 force_command
22468 .endd
22469
22470 Note that &$address_pipe$& is handled specially in &%command%& when
22471 &%force_command%& is set, expanding out to the original argument vector as
22472 separate items, similarly to a Unix shell &`"$@"`& construct.
22473
22474 .option ignore_status pipe boolean false
22475 If this option is true, the status returned by the subprocess that is set up to
22476 run the command is ignored, and Exim behaves as if zero had been returned.
22477 Otherwise, a non-zero status or termination by signal causes an error return
22478 from the transport unless the status value is one of those listed in
22479 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22480
22481 &*Note*&: This option does not apply to timeouts, which do not return a status.
22482 See the &%timeout_defer%& option for how timeouts are handled.
22483
22484 .option log_defer_output pipe boolean false
22485 .cindex "&(pipe)& transport" "logging output"
22486 If this option is set, and the status returned by the command is
22487 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22488 and any output was produced, the first line of it is written to the main log.
22489
22490
22491 .option log_fail_output pipe boolean false
22492 If this option is set, and the command returns any output, and also ends with a
22493 return code that is neither zero nor one of the return codes listed in
22494 &%temp_errors%& (that is, the delivery failed), the first line of output is
22495 written to the main log. This option and &%log_output%& are mutually exclusive.
22496 Only one of them may be set.
22497
22498
22499
22500 .option log_output pipe boolean false
22501 If this option is set and the command returns any output, the first line of
22502 output is written to the main log, whatever the return code. This option and
22503 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22504
22505
22506
22507 .option max_output pipe integer 20K
22508 This specifies the maximum amount of output that the command may produce on its
22509 standard output and standard error file combined. If the limit is exceeded, the
22510 process running the command is killed. This is intended as a safety measure to
22511 catch runaway processes. The limit is applied independently of the settings of
22512 the options that control what is done with such output (for example,
22513 &%return_output%&). Because of buffering effects, the amount of output may
22514 exceed the limit by a small amount before Exim notices.
22515
22516
22517 .option message_prefix pipe string&!! "see below"
22518 The string specified here is expanded and output at the start of every message.
22519 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22520 .code
22521 message_prefix = \
22522   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22523   ${tod_bsdinbox}\n
22524 .endd
22525 .cindex "Cyrus"
22526 .cindex "&%tmail%&"
22527 .cindex "&""From""& line"
22528 This is required by the commonly used &_/usr/bin/vacation_& program.
22529 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22530 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22531 setting
22532 .code
22533 message_prefix =
22534 .endd
22535 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22536 &`\n`& to &`\r\n`& in &%message_prefix%&.
22537
22538
22539 .option message_suffix pipe string&!! "see below"
22540 The string specified here is expanded and output at the end of every message.
22541 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22542 The suffix can be suppressed by setting
22543 .code
22544 message_suffix =
22545 .endd
22546 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22547 &`\n`& to &`\r\n`& in &%message_suffix%&.
22548
22549
22550 .option path pipe string "see below"
22551 This option specifies the string that is set up in the PATH environment
22552 variable of the subprocess. The default is:
22553 .code
22554 /bin:/usr/bin
22555 .endd
22556 If the &%command%& option does not yield an absolute path name, the command is
22557 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22558 apply to a command specified as a transport filter.
22559
22560
22561 .option permit_coredump pipe boolean false
22562 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22563 a core-dump of a pipe command, enable this command.  This enables core-dumps
22564 during delivery and affects both the Exim binary and the pipe command run.
22565 It is recommended that this option remain off unless and until you have a need
22566 for it and that this only be enabled when needed, as the risk of excessive
22567 resource consumption can be quite high.  Note also that Exim is typically
22568 installed as a setuid binary and most operating systems will inhibit coredumps
22569 of these by default, so further OS-specific action may be required.
22570
22571
22572 .option pipe_as_creator pipe boolean false
22573 .cindex "uid (user id)" "local delivery"
22574 If the generic &%user%& option is not set and this option is true, the delivery
22575 process is run under the uid that was in force when Exim was originally called
22576 to accept the message. If the group id is not otherwise set (via the generic
22577 &%group%& option), the gid that was in force when Exim was originally called to
22578 accept the message is used.
22579
22580
22581 .option restrict_to_path pipe boolean false
22582 When this option is set, any command name not listed in &%allow_commands%& must
22583 contain no slashes. The command is searched for only in the directories listed
22584 in the &%path%& option. This option is intended for use in the case when a pipe
22585 command has been generated from a user's &_.forward_& file. This is usually
22586 handled by a &(pipe)& transport called &%address_pipe%&.
22587
22588
22589 .option return_fail_output pipe boolean false
22590 If this option is true, and the command produced any output and ended with a
22591 return code other than zero or one of the codes listed in &%temp_errors%& (that
22592 is, the delivery failed), the output is returned in the bounce message.
22593 However, if the message has a null sender (that is, it is itself a bounce
22594 message), output from the command is discarded. This option and
22595 &%return_output%& are mutually exclusive. Only one of them may be set.
22596
22597
22598
22599 .option return_output pipe boolean false
22600 If this option is true, and the command produced any output, the delivery is
22601 deemed to have failed whatever the return code from the command, and the output
22602 is returned in the bounce message. Otherwise, the output is just discarded.
22603 However, if the message has a null sender (that is, it is a bounce message),
22604 output from the command is always discarded, whatever the setting of this
22605 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22606 of them may be set.
22607
22608
22609
22610 .option temp_errors pipe "string list" "see below"
22611 .cindex "&(pipe)& transport" "temporary failure"
22612 This option contains either a colon-separated list of numbers, or a single
22613 asterisk. If &%ignore_status%& is false
22614 and &%return_output%& is not set,
22615 and the command exits with a non-zero return code, the failure is treated as
22616 temporary and the delivery is deferred if the return code matches one of the
22617 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22618 codes are treated as permanent errors. The default setting contains the codes
22619 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22620 compiled on a system that does not define these macros, it assumes values of 75
22621 and 73, respectively.
22622
22623
22624 .option timeout pipe time 1h
22625 If the command fails to complete within this time, it is killed. This normally
22626 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22627 specifies no timeout. In order to ensure that any subprocesses created by the
22628 command are also killed, Exim makes the initial process a process group leader,
22629 and kills the whole process group on a timeout. However, this can be defeated
22630 if one of the processes starts a new process group.
22631
22632 .option timeout_defer pipe boolean false
22633 A timeout in a &(pipe)& transport, either in the command that the transport
22634 runs, or in a transport filter that is associated with it, is by default
22635 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22636 is set true, both kinds of timeout become temporary errors, causing the
22637 delivery to be deferred.
22638
22639 .option umask pipe "octal integer" 022
22640 This specifies the umask setting for the subprocess that runs the command.
22641
22642
22643 .option use_bsmtp pipe boolean false
22644 .cindex "envelope sender"
22645 If this option is set true, the &(pipe)& transport writes messages in &"batch
22646 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22647 commands. If you want to include a leading HELO command with such messages,
22648 you can do so by setting the &%message_prefix%& option. See section
22649 &<<SECTbatchSMTP>>& for details of batch SMTP.
22650
22651 .option use_classresources pipe boolean false
22652 .cindex "class resources (BSD)"
22653 This option is available only when Exim is running on FreeBSD, NetBSD, or
22654 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22655 resource limits when a &(pipe)& transport is run to perform a delivery. The
22656 limits for the uid under which the pipe is to run are obtained from the login
22657 class database.
22658
22659
22660 .option use_crlf pipe boolean false
22661 .cindex "carriage return"
22662 .cindex "linefeed"
22663 This option causes lines to be terminated with the two-character CRLF sequence
22664 (carriage return, linefeed) instead of just a linefeed character. In the case
22665 of batched SMTP, the byte sequence written to the pipe is then an exact image
22666 of what would be sent down a real SMTP connection.
22667
22668 The contents of the &%message_prefix%& and &%message_suffix%& options are
22669 written verbatim, so must contain their own carriage return characters if these
22670 are needed. When &%use_bsmtp%& is not set, the default values for both
22671 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22672 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22673
22674
22675 .option use_shell pipe boolean false
22676 .vindex "&$pipe_addresses$&"
22677 If this option is set, it causes the command to be passed to &_/bin/sh_&
22678 instead of being run directly from the transport, as described in section
22679 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22680 where the command is expected to be run under a shell and cannot easily be
22681 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22682 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22683 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22684 its &%-c%& option.
22685
22686
22687
22688 .section "Using an external local delivery agent" "SECID143"
22689 .cindex "local delivery" "using an external agent"
22690 .cindex "&'procmail'&"
22691 .cindex "external local delivery"
22692 .cindex "delivery" "&'procmail'&"
22693 .cindex "delivery" "by external agent"
22694 The &(pipe)& transport can be used to pass all messages that require local
22695 delivery to a separate local delivery agent such as &%procmail%&. When doing
22696 this, care must be taken to ensure that the pipe is run under an appropriate
22697 uid and gid. In some configurations one wants this to be a uid that is trusted
22698 by the delivery agent to supply the correct sender of the message. It may be
22699 necessary to recompile or reconfigure the delivery agent so that it trusts an
22700 appropriate user. The following is an example transport and router
22701 configuration for &%procmail%&:
22702 .code
22703 # transport
22704 procmail_pipe:
22705   driver = pipe
22706   command = /usr/local/bin/procmail -d $local_part
22707   return_path_add
22708   delivery_date_add
22709   envelope_to_add
22710   check_string = "From "
22711   escape_string = ">From "
22712   umask = 077
22713   user = $local_part
22714   group = mail
22715
22716 # router
22717 procmail:
22718   driver = accept
22719   check_local_user
22720   transport = procmail_pipe
22721 .endd
22722 In this example, the pipe is run as the local user, but with the group set to
22723 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22724 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22725 user to supply a correct sender address. If you do not specify either a
22726 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22727 home directory is the user's home directory by default.
22728
22729 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22730 .code
22731 IFS=" "
22732 .endd
22733 as shown in some &%procmail%& documentation, because Exim does not by default
22734 use a shell to run pipe commands.
22735
22736 .cindex "Cyrus"
22737 The next example shows a transport and a router for a system where local
22738 deliveries are handled by the Cyrus IMAP server.
22739 .code
22740 # transport
22741 local_delivery_cyrus:
22742   driver = pipe
22743   command = /usr/cyrus/bin/deliver \
22744             -m ${substr_1:$local_part_suffix} -- $local_part
22745   user = cyrus
22746   group = mail
22747   return_output
22748   log_output
22749   message_prefix =
22750   message_suffix =
22751
22752 # router
22753 local_user_cyrus:
22754   driver = accept
22755   check_local_user
22756   local_part_suffix = .*
22757   transport = local_delivery_cyrus
22758 .endd
22759 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22760 &%return_output%& to cause any text written by Cyrus to be returned to the
22761 sender.
22762 .ecindex IIDpiptra1
22763 .ecindex IIDpiptra2
22764
22765
22766 . ////////////////////////////////////////////////////////////////////////////
22767 . ////////////////////////////////////////////////////////////////////////////
22768
22769 .chapter "The smtp transport" "CHAPsmtptrans"
22770 .scindex IIDsmttra1 "transports" "&(smtp)&"
22771 .scindex IIDsmttra2 "&(smtp)& transport"
22772 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22773 or LMTP protocol. The list of hosts to try can either be taken from the address
22774 that is being processed (having been set up by the router), or specified
22775 explicitly for the transport. Timeout and retry processing (see chapter
22776 &<<CHAPretry>>&) is applied to each IP address independently.
22777
22778
22779 .section "Multiple messages on a single connection" "SECID144"
22780 The sending of multiple messages over a single TCP/IP connection can arise in
22781 two ways:
22782
22783 .ilist
22784 If a message contains more than &%max_rcpt%& (see below) addresses that are
22785 routed to the same host, more than one copy of the message has to be sent to
22786 that host. In this situation, multiple copies may be sent in a single run of
22787 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22788 does when it has too many addresses to send in one message also depends on the
22789 value of the global &%remote_max_parallel%& option. Details are given in
22790 section &<<SECToutSMTPTCP>>&.)
22791 .next
22792 .cindex "hints database" "remembering routing"
22793 When a message has been successfully delivered over a TCP/IP connection, Exim
22794 looks in its hints database to see if there are any other messages awaiting a
22795 connection to the same host. If there are, a new delivery process is started
22796 for one of them, and the current TCP/IP connection is passed on to it. The new
22797 process may in turn send multiple copies and possibly create yet another
22798 process.
22799 .endlist
22800
22801
22802 For each copy sent over the same TCP/IP connection, a sequence counter is
22803 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22804 no further messages are sent over that connection.
22805
22806
22807
22808 .section "Use of the $host and $host_address variables" "SECID145"
22809 .vindex "&$host$&"
22810 .vindex "&$host_address$&"
22811 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22812 &$host_address$& are the name and IP address of the first host on the host list
22813 passed by the router. However, when the transport is about to connect to a
22814 specific host, and while it is connected to that host, &$host$& and
22815 &$host_address$& are set to the values for that host. These are the values
22816 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22817 &%serialize_hosts%&, and the various TLS options are expanded.
22818
22819
22820 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22821 .vindex &$tls_bits$&
22822 .vindex &$tls_cipher$&
22823 .vindex &$tls_peerdn$&
22824 .vindex &$tls_sni$&
22825 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22826 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22827 are the values that were set when the message was received.
22828 These are the values that are used for options that are expanded before any
22829 SMTP connections are made. Just before each connection is made, these four
22830 variables are emptied. If TLS is subsequently started, they are set to the
22831 appropriate values for the outgoing connection, and these are the values that
22832 are in force when any authenticators are run and when the
22833 &%authenticated_sender%& option is expanded.
22834
22835 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22836 and will be removed in a future release.
22837
22838
22839 .section "Private options for smtp" "SECID146"
22840 .cindex "options" "&(smtp)& transport"
22841 The private options of the &(smtp)& transport are as follows:
22842
22843
22844 .option address_retry_include_sender smtp boolean true
22845 .cindex "4&'xx'& responses" "retrying after"
22846 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22847 is the combination of sender and recipient that is delayed in subsequent queue
22848 runs until the retry time is reached. You can delay the recipient without
22849 reference to the sender (which is what earlier versions of Exim did), by
22850 setting &%address_retry_include_sender%& false. However, this can lead to
22851 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22852
22853 .option allow_localhost smtp boolean false
22854 .cindex "local host" "sending to"
22855 .cindex "fallback" "hosts specified on transport"
22856 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22857 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22858 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22859 the delivery anyway. This should be used only in special cases when the
22860 configuration ensures that no looping will result (for example, a differently
22861 configured Exim is listening on the port to which the message is sent).
22862
22863
22864 .option authenticated_sender smtp string&!! unset
22865 .cindex "Cyrus"
22866 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22867 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22868 overriding any existing authenticated sender value. If the string expansion is
22869 forced to fail, the option is ignored. Other expansion failures cause delivery
22870 to be deferred. If the result of expansion is an empty string, that is also
22871 ignored.
22872
22873 The expansion happens after the outgoing connection has been made and TLS
22874 started, if required. This means that the &$host$&, &$host_address$&,
22875 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22876 particular connection.
22877
22878 If the SMTP session is not authenticated, the expansion of
22879 &%authenticated_sender%& still happens (and can cause the delivery to be
22880 deferred if it fails), but no AUTH= item is added to MAIL commands
22881 unless &%authenticated_sender_force%& is true.
22882
22883 This option allows you to use the &(smtp)& transport in LMTP mode to
22884 deliver mail to Cyrus IMAP and provide the proper local part as the
22885 &"authenticated sender"&, via a setting such as:
22886 .code
22887 authenticated_sender = $local_part
22888 .endd
22889 This removes the need for IMAP subfolders to be assigned special ACLs to
22890 allow direct delivery to those subfolders.
22891
22892 Because of expected uses such as that just described for Cyrus (when no
22893 domain is involved), there is no checking on the syntax of the provided
22894 value.
22895
22896
22897 .option authenticated_sender_force smtp boolean false
22898 If this option is set true, the &%authenticated_sender%& option's value
22899 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22900 authenticated as a client.
22901
22902
22903 .option command_timeout smtp time 5m
22904 This sets a timeout for receiving a response to an SMTP command that has been
22905 sent out. It is also used when waiting for the initial banner line from the
22906 remote host. Its value must not be zero.
22907
22908
22909 .option connect_timeout smtp time 5m
22910 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22911 to a remote host. A setting of zero allows the system timeout (typically
22912 several minutes) to act. To have any effect, the value of this option must be
22913 less than the system timeout. However, it has been observed that on some
22914 systems there is no system timeout, which is why the default value for this
22915 option is 5 minutes, a value recommended by RFC 1123.
22916
22917
22918 .option connection_max_messages smtp integer 500
22919 .cindex "SMTP" "passed connection"
22920 .cindex "SMTP" "multiple deliveries"
22921 .cindex "multiple SMTP deliveries"
22922 This controls the maximum number of separate message deliveries that are sent
22923 over a single TCP/IP connection. If the value is zero, there is no limit.
22924 For testing purposes, this value can be overridden by the &%-oB%& command line
22925 option.
22926
22927
22928 .option data_timeout smtp time 5m
22929 This sets a timeout for the transmission of each block in the data portion of
22930 the message. As a result, the overall timeout for a message depends on the size
22931 of the message. Its value must not be zero. See also &%final_timeout%&.
22932
22933
22934 .option delay_after_cutoff smtp boolean true
22935 This option controls what happens when all remote IP addresses for a given
22936 domain have been inaccessible for so long that they have passed their retry
22937 cutoff times.
22938
22939 In the default state, if the next retry time has not been reached for any of
22940 them, the address is bounced without trying any deliveries. In other words,
22941 Exim delays retrying an IP address after the final cutoff time until a new
22942 retry time is reached, and can therefore bounce an address without ever trying
22943 a delivery, when machines have been down for a long time. Some people are
22944 unhappy at this prospect, so...
22945
22946 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22947 addresses are past their final cutoff time, Exim tries to deliver to those
22948 IP addresses that have not been tried since the message arrived. If there are
22949 none, of if they all fail, the address is bounced. In other words, it does not
22950 delay when a new message arrives, but immediately tries those expired IP
22951 addresses that haven't been tried since the message arrived. If there is a
22952 continuous stream of messages for the dead hosts, unsetting
22953 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22954 to them.
22955
22956
22957 .option dns_qualify_single smtp boolean true
22958 If the &%hosts%& or &%fallback_hosts%& option is being used,
22959 and the &%gethostbyname%& option is false,
22960 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22961 in chapter &<<CHAPdnslookup>>& for more details.
22962
22963
22964 .option dns_search_parents smtp boolean false
22965 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22966 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22967 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22968 details.
22969
22970
22971 .option dnssec_request_domains smtp "domain list&!!" unset
22972 .cindex "MX record" "security"
22973 .cindex "DNSSEC" "MX lookup"
22974 .cindex "security" "MX lookup"
22975 .cindex "DNS" "DNSSEC"
22976 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22977 the dnssec request bit set.
22978 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22979
22980
22981
22982 .option dnssec_require_domains smtp "domain list&!!" unset
22983 .cindex "MX record" "security"
22984 .cindex "DNSSEC" "MX lookup"
22985 .cindex "security" "MX lookup"
22986 .cindex "DNS" "DNSSEC"
22987 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22988 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22989 (AD bit) set wil be ignored and logged as a host-lookup failure.
22990 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22991
22992
22993
22994 .option dscp smtp string&!! unset
22995 .cindex "DCSP" "outbound"
22996 This option causes the DSCP value associated with a socket to be set to one
22997 of a number of fixed strings or to numeric value.
22998 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22999 Common values include &`throughput`&, &`mincost`&, and on newer systems
23000 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23001
23002 The outbound packets from Exim will be marked with this value in the header
23003 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23004 that these values will have any effect, not be stripped by networking
23005 equipment, or do much of anything without cooperation with your Network
23006 Engineer and those of all network operators between the source and destination.
23007
23008
23009 .option fallback_hosts smtp "string list" unset
23010 .cindex "fallback" "hosts specified on transport"
23011 String expansion is not applied to this option. The argument must be a
23012 colon-separated list of host names or IP addresses, optionally also including
23013 port numbers, though the separator can be changed, as described in section
23014 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23015 item in a &%route_list%& setting for the &(manualroute)& router, as described
23016 in section &<<SECTformatonehostitem>>&.
23017
23018 Fallback hosts can also be specified on routers, which associate them with the
23019 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23020 &%fallback_hosts%& specified on the transport is used only if the address does
23021 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23022 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23023 However, &%hosts_randomize%& does apply to fallback host lists.
23024
23025 If Exim is unable to deliver to any of the hosts for a particular address, and
23026 the errors are not permanent rejections, the address is put on a separate
23027 transport queue with its host list replaced by the fallback hosts, unless the
23028 address was routed via MX records and the current host was in the original MX
23029 list. In that situation, the fallback host list is not used.
23030
23031 Once normal deliveries are complete, the fallback queue is delivered by
23032 re-running the same transports with the new host lists. If several failing
23033 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23034 copy of the message is sent.
23035
23036 The resolution of the host names on the fallback list is controlled by the
23037 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23038 both to cases when the host list comes with the address and when it is taken
23039 from &%hosts%&. This option provides a &"use a smart host only if delivery
23040 fails"& facility.
23041
23042
23043 .option final_timeout smtp time 10m
23044 This is the timeout that applies while waiting for the response to the final
23045 line containing just &"."& that terminates a message. Its value must not be
23046 zero.
23047
23048 .option gethostbyname smtp boolean false
23049 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23050 being used, names are looked up using &[gethostbyname()]&
23051 (or &[getipnodebyname()]& when available)
23052 instead of using the DNS. Of course, that function may in fact use the DNS, but
23053 it may also consult other sources of information such as &_/etc/hosts_&.
23054
23055 .option gnutls_compat_mode smtp boolean unset
23056 This option controls whether GnuTLS is used in compatibility mode in an Exim
23057 server. This reduces security slightly, but improves interworking with older
23058 implementations of TLS.
23059
23060 .option helo_data smtp string&!! "see below"
23061 .cindex "HELO" "argument, setting"
23062 .cindex "EHLO" "argument, setting"
23063 .cindex "LHLO argument setting"
23064 The value of this option is expanded after a connection to a another host has
23065 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23066 command that starts the outgoing SMTP or LMTP session. The default value of the
23067 option is:
23068 .code
23069 $primary_hostname
23070 .endd
23071 During the expansion, the variables &$host$& and &$host_address$& are set to
23072 the identity of the remote host, and the variables &$sending_ip_address$& and
23073 &$sending_port$& are set to the local IP address and port number that are being
23074 used. These variables can be used to generate different values for different
23075 servers or different local IP addresses. For example, if you want the string
23076 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23077 interface address, you could use this:
23078 .code
23079 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23080   {$primary_hostname}}
23081 .endd
23082 The use of &%helo_data%& applies both to sending messages and when doing
23083 callouts.
23084
23085 .option hosts smtp "string list&!!" unset
23086 Hosts are associated with an address by a router such as &(dnslookup)&, which
23087 finds the hosts by looking up the address domain in the DNS, or by
23088 &(manualroute)&, which has lists of hosts in its configuration. However,
23089 email addresses can be passed to the &(smtp)& transport by any router, and not
23090 all of them can provide an associated list of hosts.
23091
23092 The &%hosts%& option specifies a list of hosts to be used if the address being
23093 processed does not have any hosts associated with it. The hosts specified by
23094 &%hosts%& are also used, whether or not the address has its own hosts, if
23095 &%hosts_override%& is set.
23096
23097 The string is first expanded, before being interpreted as a colon-separated
23098 list of host names or IP addresses, possibly including port numbers. The
23099 separator may be changed to something other than colon, as described in section
23100 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23101 item in a &%route_list%& setting for the &(manualroute)& router, as described
23102 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23103 of the &(manualroute)& router is not available here.
23104
23105 If the expansion fails, delivery is deferred. Unless the failure was caused by
23106 the inability to complete a lookup, the error is logged to the panic log as
23107 well as the main log. Host names are looked up either by searching directly for
23108 address records in the DNS or by calling &[gethostbyname()]& (or
23109 &[getipnodebyname()]& when available), depending on the setting of the
23110 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23111 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23112 address are used.
23113
23114 During delivery, the hosts are tried in order, subject to their retry status,
23115 unless &%hosts_randomize%& is set.
23116
23117
23118 .option hosts_avoid_esmtp smtp "host list&!!" unset
23119 .cindex "ESMTP, avoiding use of"
23120 .cindex "HELO" "forcing use of"
23121 .cindex "EHLO" "avoiding use of"
23122 .cindex "PIPELINING" "avoiding the use of"
23123 This option is for use with broken hosts that announce ESMTP facilities (for
23124 example, PIPELINING) and then fail to implement them properly. When a host
23125 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23126 start of the SMTP session. This means that it cannot use any of the ESMTP
23127 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23128
23129
23130 .option hosts_avoid_pipelining smtp "host list&!!" unset
23131 .cindex "PIPELINING" "avoiding the use of"
23132 Exim will not use the SMTP PIPELINING extension when delivering to any host
23133 that matches this list, even if the server host advertises PIPELINING support.
23134
23135
23136 .option hosts_avoid_tls smtp "host list&!!" unset
23137 .cindex "TLS" "avoiding for certain hosts"
23138 Exim will not try to start a TLS session when delivering to any host that
23139 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23140
23141 .option hosts_verify_avoid_tls smtp "host list&!!" *
23142 .cindex "TLS" "avoiding for certain hosts"
23143 Exim will not try to start a TLS session for a verify callout,
23144 or when delivering in cutthrough mode,
23145 to any host that matches this list.
23146 Note that the default is to not use TLS.
23147
23148
23149 .option hosts_max_try smtp integer 5
23150 .cindex "host" "maximum number to try"
23151 .cindex "limit" "number of hosts tried"
23152 .cindex "limit" "number of MX tried"
23153 .cindex "MX record" "maximum tried"
23154 This option limits the number of IP addresses that are tried for any one
23155 delivery in cases where there are temporary delivery errors. Section
23156 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23157
23158
23159 .option hosts_max_try_hardlimit smtp integer 50
23160 This is an additional check on the maximum number of IP addresses that Exim
23161 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23162 why it exists.
23163
23164
23165
23166 .option hosts_nopass_tls smtp "host list&!!" unset
23167 .cindex "TLS" "passing connection"
23168 .cindex "multiple SMTP deliveries"
23169 .cindex "TLS" "multiple message deliveries"
23170 For any host that matches this list, a connection on which a TLS session has
23171 been started will not be passed to a new delivery process for sending another
23172 message on the same connection. See section &<<SECTmulmessam>>& for an
23173 explanation of when this might be needed.
23174
23175
23176 .option hosts_override smtp boolean false
23177 If this option is set and the &%hosts%& option is also set, any hosts that are
23178 attached to the address are ignored, and instead the hosts specified by the
23179 &%hosts%& option are always used. This option does not apply to
23180 &%fallback_hosts%&.
23181
23182
23183 .option hosts_randomize smtp boolean false
23184 .cindex "randomized host list"
23185 .cindex "host" "list of; randomized"
23186 .cindex "fallback" "randomized hosts"
23187 If this option is set, and either the list of hosts is taken from the
23188 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23189 were not obtained from MX records (this includes fallback hosts from the
23190 router), and were not randomized by the router, the order of trying the hosts
23191 is randomized each time the transport runs. Randomizing the order of a host
23192 list can be used to do crude load sharing.
23193
23194 When &%hosts_randomize%& is true, a host list may be split into groups whose
23195 order is separately randomized. This makes it possible to set up MX-like
23196 behaviour. The boundaries between groups are indicated by an item that is just
23197 &`+`& in the host list. For example:
23198 .code
23199 hosts = host1:host2:host3:+:host4:host5
23200 .endd
23201 The order of the first three hosts and the order of the last two hosts is
23202 randomized for each use, but the first three always end up before the last two.
23203 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23204
23205 .option hosts_require_auth smtp "host list&!!" unset
23206 .cindex "authentication" "required by client"
23207 This option provides a list of servers for which authentication must succeed
23208 before Exim will try to transfer a message. If authentication fails for
23209 servers which are not in this list, Exim tries to send unauthenticated. If
23210 authentication fails for one of these servers, delivery is deferred. This
23211 temporary error is detectable in the retry rules, so it can be turned into a
23212 hard failure if required. See also &%hosts_try_auth%&, and chapter
23213 &<<CHAPSMTPAUTH>>& for details of authentication.
23214
23215
23216 .option hosts_request_ocsp smtp "host list&!!" *
23217 .cindex "TLS" "requiring for certain servers"
23218 Exim will request a Certificate Status on a
23219 TLS session for any host that matches this list.
23220 &%tls_verify_certificates%& should also be set for the transport.
23221
23222 .option hosts_require_ocsp smtp "host list&!!" unset
23223 .cindex "TLS" "requiring for certain servers"
23224 Exim will request, and check for a valid Certificate Status being given, on a
23225 TLS session for any host that matches this list.
23226 &%tls_verify_certificates%& should also be set for the transport.
23227
23228 .option hosts_require_tls smtp "host list&!!" unset
23229 .cindex "TLS" "requiring for certain servers"
23230 Exim will insist on using a TLS session when delivering to any host that
23231 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23232 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23233 incoming messages, use an appropriate ACL.
23234
23235 .option hosts_try_auth smtp "host list&!!" unset
23236 .cindex "authentication" "optional in client"
23237 This option provides a list of servers to which, provided they announce
23238 authentication support, Exim will attempt to authenticate as a client when it
23239 connects. If authentication fails, Exim will try to transfer the message
23240 unauthenticated. See also &%hosts_require_auth%&, and chapter
23241 &<<CHAPSMTPAUTH>>& for details of authentication.
23242
23243 .option hosts_try_prdr smtp "host list&!!" *
23244 .cindex "PRDR" "enabling, optional in client"
23245 This option provides a list of servers to which, provided they announce
23246 PRDR support, Exim will attempt to negotiate PRDR
23247 for multi-recipient messages.
23248 The option can usually be left as default.
23249
23250 .option interface smtp "string list&!!" unset
23251 .cindex "bind IP address"
23252 .cindex "IP address" "binding"
23253 .vindex "&$host$&"
23254 .vindex "&$host_address$&"
23255 This option specifies which interface to bind to when making an outgoing SMTP
23256 call. The value is an IP address, not an interface name such as
23257 &`eth0`&. Do not confuse this with the interface address that was used when a
23258 message was received, which is in &$received_ip_address$&, formerly known as
23259 &$interface_address$&. The name was changed to minimize confusion with the
23260 outgoing interface address. There is no variable that contains an outgoing
23261 interface address because, unless it is set by this option, its value is
23262 unknown.
23263
23264 During the expansion of the &%interface%& option the variables &$host$& and
23265 &$host_address$& refer to the host to which a connection is about to be made
23266 during the expansion of the string. Forced expansion failure, or an empty
23267 string result causes the option to be ignored. Otherwise, after expansion, the
23268 string must be a list of IP addresses, colon-separated by default, but the
23269 separator can be changed in the usual way. For example:
23270 .code
23271 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23272 .endd
23273 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23274 connection. If none of them are the correct type, the option is ignored. If
23275 &%interface%& is not set, or is ignored, the system's IP functions choose which
23276 interface to use if the host has more than one.
23277
23278
23279 .option keepalive smtp boolean true
23280 .cindex "keepalive" "on outgoing connection"
23281 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23282 connections. When set, it causes the kernel to probe idle connections
23283 periodically, by sending packets with &"old"& sequence numbers. The other end
23284 of the connection should send a acknowledgment if the connection is still okay
23285 or a reset if the connection has been aborted. The reason for doing this is
23286 that it has the beneficial effect of freeing up certain types of connection
23287 that can get stuck when the remote host is disconnected without tidying up the
23288 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23289 unreachable hosts.
23290
23291
23292 .option lmtp_ignore_quota smtp boolean false
23293 .cindex "LMTP" "ignoring quota errors"
23294 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23295 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23296 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23297
23298 .option max_rcpt smtp integer 100
23299 .cindex "RCPT" "maximum number of outgoing"
23300 This option limits the number of RCPT commands that are sent in a single
23301 SMTP message transaction. Each set of addresses is treated independently, and
23302 so can cause parallel connections to the same host if &%remote_max_parallel%&
23303 permits this.
23304
23305
23306 .option multi_domain smtp boolean&!! true
23307 .vindex "&$domain$&"
23308 When this option is set, the &(smtp)& transport can handle a number of
23309 addresses containing a mixture of different domains provided they all resolve
23310 to the same list of hosts. Turning the option off restricts the transport to
23311 handling only one domain at a time. This is useful if you want to use
23312 &$domain$& in an expansion for the transport, because it is set only when there
23313 is a single domain involved in a remote delivery.
23314
23315 It is expanded per-address and can depend on any of
23316 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23317 &$host$&, &$host_address$& and &$host_port$&.
23318
23319 .option port smtp string&!! "see below"
23320 .cindex "port" "sending TCP/IP"
23321 .cindex "TCP/IP" "setting outgoing port"
23322 This option specifies the TCP/IP port on the server to which Exim connects.
23323 &*Note:*& Do not confuse this with the port that was used when a message was
23324 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23325 The name was changed to minimize confusion with the outgoing port. There is no
23326 variable that contains an outgoing port.
23327
23328 If the value of this option begins with a digit it is taken as a port number;
23329 otherwise it is looked up using &[getservbyname()]&. The default value is
23330 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23331 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23332 is deferred.
23333
23334
23335
23336 .option protocol smtp string smtp
23337 .cindex "LMTP" "over TCP/IP"
23338 .cindex "ssmtp protocol" "outbound"
23339 .cindex "TLS" "SSL-on-connect outbound"
23340 .vindex "&$port$&"
23341 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23342 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23343 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23344 deliveries into closed message stores. Exim also has support for running LMTP
23345 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23346
23347 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23348 changes to &"smtps"&, and the transport initiates TLS immediately after
23349 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23350 The Internet standards bodies strongly discourage use of this mode.
23351
23352
23353 .option retry_include_ip_address smtp boolean&!! true
23354 Exim normally includes both the host name and the IP address in the key it
23355 constructs for indexing retry data after a temporary delivery failure. This
23356 means that when one of several IP addresses for a host is failing, it gets
23357 tried periodically (controlled by the retry rules), but use of the other IP
23358 addresses is not affected.
23359
23360 However, in some dialup environments hosts are assigned a different IP address
23361 each time they connect. In this situation the use of the IP address as part of
23362 the retry key leads to undesirable behaviour. Setting this option false causes
23363 Exim to use only the host name.
23364 Since it is expanded it can be made to depend on the host or domain.
23365
23366
23367 .option serialize_hosts smtp "host list&!!" unset
23368 .cindex "serializing connections"
23369 .cindex "host" "serializing connections"
23370 Because Exim operates in a distributed manner, if several messages for the same
23371 host arrive at around the same time, more than one simultaneous connection to
23372 the remote host can occur. This is not usually a problem except when there is a
23373 slow link between the hosts. In that situation it may be helpful to restrict
23374 Exim to one connection at a time. This can be done by setting
23375 &%serialize_hosts%& to match the relevant hosts.
23376
23377 .cindex "hints database" "serializing deliveries to a host"
23378 Exim implements serialization by means of a hints database in which a record is
23379 written whenever a process connects to one of the restricted hosts. The record
23380 is deleted when the connection is completed. Obviously there is scope for
23381 records to get left lying around if there is a system or program crash. To
23382 guard against this, Exim ignores any records that are more than six hours old.
23383
23384 If you set up this kind of serialization, you should also arrange to delete the
23385 relevant hints database whenever your system reboots. The names of the files
23386 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23387 may be one or two files, depending on the type of DBM in use. The same files
23388 are used for ETRN serialization.
23389
23390
23391 .option size_addition smtp integer 1024
23392 .cindex "SMTP" "SIZE"
23393 .cindex "message" "size issue for transport filter"
23394 .cindex "size" "of message"
23395 .cindex "transport" "filter"
23396 .cindex "filter" "transport filter"
23397 If a remote SMTP server indicates that it supports the SIZE option of the
23398 MAIL command, Exim uses this to pass over the message size at the start of
23399 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23400 sends, to allow for headers and other text that may be added during delivery by
23401 configuration options or in a transport filter. It may be necessary to increase
23402 this if a lot of text is added to messages.
23403
23404 Alternatively, if the value of &%size_addition%& is set negative, it disables
23405 the use of the SIZE option altogether.
23406
23407
23408 .option tls_certificate smtp string&!! unset
23409 .cindex "TLS" "client certificate, location of"
23410 .cindex "certificate" "client, location of"
23411 .vindex "&$host$&"
23412 .vindex "&$host_address$&"
23413 The value of this option must be the absolute path to a file which contains the
23414 client's certificate, for possible use when sending a message over an encrypted
23415 connection. The values of &$host$& and &$host_address$& are set to the name and
23416 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23417 details of TLS.
23418
23419 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23420 certificate when sending messages as a client. The global option of the same
23421 name specifies the certificate for Exim as a server; it is not automatically
23422 assumed that the same certificate should be used when Exim is operating as a
23423 client.
23424
23425
23426 .option tls_crl smtp string&!! unset
23427 .cindex "TLS" "client certificate revocation list"
23428 .cindex "certificate" "revocation list for client"
23429 This option specifies a certificate revocation list. The expanded value must
23430 be the name of a file that contains a CRL in PEM format.
23431
23432
23433 .option tls_dh_min_bits smtp integer 1024
23434 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23435 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23436 key agreement is negotiated, the server will provide a large prime number
23437 for use.  This option establishes the minimum acceptable size of that number.
23438 If the parameter offered by the server is too small, then the TLS handshake
23439 will fail.
23440
23441 Only supported when using GnuTLS.
23442
23443
23444 .option tls_privatekey smtp string&!! unset
23445 .cindex "TLS" "client private key, location of"
23446 .vindex "&$host$&"
23447 .vindex "&$host_address$&"
23448 The value of this option must be the absolute path to a file which contains the
23449 client's private key. This is used when sending a message over an encrypted
23450 connection using a client certificate. The values of &$host$& and
23451 &$host_address$& are set to the name and address of the server during the
23452 expansion. If this option is unset, or the expansion is forced to fail, or the
23453 result is an empty string, the private key is assumed to be in the same file as
23454 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23455
23456
23457 .option tls_require_ciphers smtp string&!! unset
23458 .cindex "TLS" "requiring specific ciphers"
23459 .cindex "cipher" "requiring specific"
23460 .vindex "&$host$&"
23461 .vindex "&$host_address$&"
23462 The value of this option must be a list of permitted cipher suites, for use
23463 when setting up an outgoing encrypted connection. (There is a global option of
23464 the same name for controlling incoming connections.) The values of &$host$& and
23465 &$host_address$& are set to the name and address of the server during the
23466 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23467 is used in different ways by OpenSSL and GnuTLS (see sections
23468 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23469 ciphers is a preference order.
23470
23471
23472
23473 .option tls_sni smtp string&!! unset
23474 .cindex "TLS" "Server Name Indication"
23475 .vindex "&$tls_sni$&"
23476 If this option is set then it sets the $tls_out_sni variable and causes any
23477 TLS session to pass this value as the Server Name Indication extension to
23478 the remote side, which can be used by the remote side to select an appropriate
23479 certificate and private key for the session.
23480
23481 See &<<SECTtlssni>>& for more information.
23482
23483 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23484 TLS extensions.
23485
23486
23487
23488
23489 .option tls_tempfail_tryclear smtp boolean true
23490 .cindex "4&'xx'& responses" "to STARTTLS"
23491 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23492 setting up a TLS session, this option determines whether or not Exim should try
23493 to deliver the message unencrypted. If it is set false, delivery to the
23494 current host is deferred; if there are other hosts, they are tried. If this
23495 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23496 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23497 TLS negotiation fails, Exim closes the current connection (because it is in an
23498 unknown state), opens a new one to the same host, and then tries the delivery
23499 in clear.
23500
23501
23502 .option tls_try_verify_hosts smtp "host list&!!" *
23503 .cindex "TLS" "server certificate verification"
23504 .cindex "certificate" "verification of server"
23505 This option gives a list of hosts for which, on encrypted connections,
23506 certificate verification will be tried but need not succeed.
23507 The &%tls_verify_certificates%& option must also be set.
23508 Note that unless the host is in this list
23509 TLS connections will be denied to hosts using self-signed certificates
23510 when &%tls_verify_certificates%& is matched.
23511 The &$tls_out_certificate_verified$& variable is set when
23512 certificate verification succeeds.
23513
23514
23515 .option tls_verify_cert_hostnames smtp "host list&!!" *
23516 .cindex "TLS" "server certificate hostname verification"
23517 .cindex "certificate" "verification of server"
23518 This option give a list of hosts for which,
23519 while verifying the server certificate,
23520 checks will be included on the host name
23521 (note that this will generally be the result of a DNS MX lookup)
23522 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23523 limited to being the initial component of a 3-or-more component FQDN.
23524
23525 There is no equivalent checking on client certificates.
23526
23527
23528 .option tls_verify_certificates smtp string&!! system
23529 .cindex "TLS" "server certificate verification"
23530 .cindex "certificate" "verification of server"
23531 .vindex "&$host$&"
23532 .vindex "&$host_address$&"
23533 The value of this option must be either the
23534 word "system"
23535 or the absolute path to
23536 a file or directory containing permitted certificates for servers,
23537 for use when setting up an encrypted connection.
23538
23539 The "system" value for the option will use a location compiled into the SSL library.
23540 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23541 is taken as empty and an explicit location
23542 must be specified.
23543
23544 The use of a directory for the option value is not avilable for GnuTLS versions
23545 preceding 3.3.6 and a single file must be used.
23546
23547 With OpenSSL the certificates specified
23548 explicitly
23549 either by file or directory
23550 are added to those given by the system default location.
23551
23552 The values of &$host$& and
23553 &$host_address$& are set to the name and address of the server during the
23554 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23555
23556 For back-compatability,
23557 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23558 (a single-colon empty list counts as being set)
23559 and certificate verification fails the TLS connection is closed.
23560
23561
23562 .option tls_verify_hosts smtp "host list&!!" unset
23563 .cindex "TLS" "server certificate verification"
23564 .cindex "certificate" "verification of server"
23565 This option gives a list of hosts for which. on encrypted connections,
23566 certificate verification must succeed.
23567 The &%tls_verify_certificates%& option must also be set.
23568 If both this option and &%tls_try_verify_hosts%& are unset
23569 operation is as if this option selected all hosts.
23570
23571
23572
23573
23574 .section "How the limits for the number of hosts to try are used" &&&
23575          "SECTvalhosmax"
23576 .cindex "host" "maximum number to try"
23577 .cindex "limit" "hosts; maximum number tried"
23578 There are two options that are concerned with the number of hosts that are
23579 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23580 &%hosts_max_try_hardlimit%&.
23581
23582
23583 The &%hosts_max_try%& option limits the number of hosts that are tried
23584 for a single delivery. However, despite the term &"host"& in its name, the
23585 option actually applies to each IP address independently. In other words, a
23586 multihomed host is treated as several independent hosts, just as it is for
23587 retrying.
23588
23589 Many of the larger ISPs have multiple MX records which often point to
23590 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23591 created as a result of routing one of these domains.
23592
23593 Trying every single IP address on such a long list does not seem sensible; if
23594 several at the top of the list fail, it is reasonable to assume there is some
23595 problem that is likely to affect all of them. Roughly speaking, the value of
23596 &%hosts_max_try%& is the maximum number that are tried before deferring the
23597 delivery. However, the logic cannot be quite that simple.
23598
23599 Firstly, IP addresses that are skipped because their retry times have not
23600 arrived do not count, and in addition, addresses that are past their retry
23601 limits are also not counted, even when they are tried. This means that when
23602 some IP addresses are past their retry limits, more than the value of
23603 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23604 that all IP addresses are considered before timing out an email address (but
23605 see below for an exception).
23606
23607 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23608 list to see if there is a subsequent host with a different (higher valued) MX.
23609 If there is, that host is considered next, and the current IP address is used
23610 but not counted. This behaviour helps in the case of a domain with a retry rule
23611 that hardly ever delays any hosts, as is now explained:
23612
23613 Consider the case of a long list of hosts with one MX value, and a few with a
23614 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23615 hosts at the top of the list are tried at first. With the default retry rule,
23616 which specifies increasing retry times, the higher MX hosts are eventually
23617 tried when those at the top of the list are skipped because they have not
23618 reached their retry times.
23619
23620 However, it is common practice to put a fixed short retry time on domains for
23621 large ISPs, on the grounds that their servers are rarely down for very long.
23622 Unfortunately, these are exactly the domains that tend to resolve to long lists
23623 of hosts. The short retry time means that the lowest MX hosts are tried every
23624 time. The attempts may be in a different order because of random sorting, but
23625 without the special MX check, the higher MX hosts would never be tried until
23626 all the lower MX hosts had timed out (which might be several days), because
23627 there are always some lower MX hosts that have reached their retry times. With
23628 the special check, Exim considers at least one IP address from each MX value at
23629 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23630 reached.
23631
23632 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23633 particular, Exim normally eventually tries all the IP addresses before timing
23634 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23635 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23636 been set up with hundreds of IP addresses for some domains. It can
23637 take a very long time indeed for an address to time out in these cases.
23638
23639 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23640 Exim never tries more than this number of IP addresses; if it hits this limit
23641 and they are all timed out, the email address is bounced, even though not all
23642 possible IP addresses have been tried.
23643 .ecindex IIDsmttra1
23644 .ecindex IIDsmttra2
23645
23646
23647
23648
23649
23650 . ////////////////////////////////////////////////////////////////////////////
23651 . ////////////////////////////////////////////////////////////////////////////
23652
23653 .chapter "Address rewriting" "CHAPrewrite"
23654 .scindex IIDaddrew "rewriting" "addresses"
23655 There are some circumstances in which Exim automatically rewrites domains in
23656 addresses. The two most common are when an address is given without a domain
23657 (referred to as an &"unqualified address"&) or when an address contains an
23658 abbreviated domain that is expanded by DNS lookup.
23659
23660 Unqualified envelope addresses are accepted only for locally submitted
23661 messages, or for messages that are received from hosts matching
23662 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23663 appropriate. Unqualified addresses in header lines are qualified if they are in
23664 locally submitted messages, or messages from hosts that are permitted to send
23665 unqualified envelope addresses. Otherwise, unqualified addresses in header
23666 lines are neither qualified nor rewritten.
23667
23668 One situation in which Exim does &'not'& automatically rewrite a domain is
23669 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23670 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23671 do this. The new RFCs do not contain this suggestion.
23672
23673
23674 .section "Explicitly configured address rewriting" "SECID147"
23675 This chapter describes the rewriting rules that can be used in the
23676 main rewrite section of the configuration file, and also in the generic
23677 &%headers_rewrite%& option that can be set on any transport.
23678
23679 Some people believe that configured address rewriting is a Mortal Sin.
23680 Others believe that life is not possible without it. Exim provides the
23681 facility; you do not have to use it.
23682
23683 The main rewriting rules that appear in the &"rewrite"& section of the
23684 configuration file are applied to addresses in incoming messages, both envelope
23685 addresses and addresses in header lines. Each rule specifies the types of
23686 address to which it applies.
23687
23688 Whether or not addresses in header lines are rewritten depends on the origin of
23689 the headers and the type of rewriting. Global rewriting, that is, rewriting
23690 rules from the rewrite section of the configuration file, is applied only to
23691 those headers that were received with the message. Header lines that are added
23692 by ACLs or by a system filter or by individual routers or transports (which
23693 are specific to individual recipient addresses) are not rewritten by the global
23694 rules.
23695
23696 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23697 applies all headers except those added by routers and transports. That is, as
23698 well as the headers that were received with the message, it also applies to
23699 headers that were added by an ACL or a system filter.
23700
23701
23702 In general, rewriting addresses from your own system or domain has some
23703 legitimacy. Rewriting other addresses should be done only with great care and
23704 in special circumstances. The author of Exim believes that rewriting should be
23705 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23706 Although it can sometimes be used as a routing tool, this is very strongly
23707 discouraged.
23708
23709 There are two commonly encountered circumstances where rewriting is used, as
23710 illustrated by these examples:
23711
23712 .ilist
23713 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23714 exchange mail with each other behind a firewall, but there is only a single
23715 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23716 &'hitch.fict.example'& when sending mail off-site.
23717 .next
23718 A host rewrites the local parts of its own users so that, for example,
23719 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23720 .endlist
23721
23722
23723
23724 .section "When does rewriting happen?" "SECID148"
23725 .cindex "rewriting" "timing of"
23726 .cindex "&ACL;" "rewriting addresses in"
23727 Configured address rewriting can take place at several different stages of a
23728 message's processing.
23729
23730 .vindex "&$sender_address$&"
23731 At the start of an ACL for MAIL, the sender address may have been rewritten
23732 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23733 ordinary rewrite rules have yet been applied. If, however, the sender address
23734 is verified in the ACL, it is rewritten before verification, and remains
23735 rewritten thereafter. The subsequent value of &$sender_address$& is the
23736 rewritten address. This also applies if sender verification happens in a
23737 RCPT ACL. Otherwise, when the sender address is not verified, it is
23738 rewritten as soon as a message's header lines have been received.
23739
23740 .vindex "&$domain$&"
23741 .vindex "&$local_part$&"
23742 Similarly, at the start of an ACL for RCPT, the current recipient's address
23743 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23744 rewrite rules have yet been applied to it. However, the behaviour is different
23745 from the sender address when a recipient is verified. The address is rewritten
23746 for the verification, but the rewriting is not remembered at this stage. The
23747 value of &$local_part$& and &$domain$& after verification are always the same
23748 as they were before (that is, they contain the unrewritten &-- except for
23749 SMTP-time rewriting &-- address).
23750
23751 As soon as a message's header lines have been received, all the envelope
23752 recipient addresses are permanently rewritten, and rewriting is also applied to
23753 the addresses in the header lines (if configured). This happens before adding
23754 any header lines that were specified in MAIL or RCPT ACLs, and
23755 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23756 before the DATA ACL and &[local_scan()]& functions are run.
23757
23758 When an address is being routed, either for delivery or for verification,
23759 rewriting is applied immediately to child addresses that are generated by
23760 redirection, unless &%no_rewrite%& is set on the router.
23761
23762 .cindex "envelope sender" "rewriting at transport time"
23763 .cindex "rewriting" "at transport time"
23764 .cindex "header lines" "rewriting at transport time"
23765 At transport time, additional rewriting of addresses in header lines can be
23766 specified by setting the generic &%headers_rewrite%& option on a transport.
23767 This option contains rules that are identical in form to those in the rewrite
23768 section of the configuration file. They are applied to the original message
23769 header lines and any that were added by ACLs or a system filter. They are not
23770 applied to header lines that are added by routers or the transport.
23771
23772 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23773 transport option. However, it is not possible to rewrite envelope recipients at
23774 transport time.
23775
23776
23777
23778
23779 .section "Testing the rewriting rules that apply on input" "SECID149"
23780 .cindex "rewriting" "testing"
23781 .cindex "testing" "rewriting"
23782 Exim's input rewriting configuration appears in a part of the run time
23783 configuration file headed by &"begin rewrite"&. It can be tested by the
23784 &%-brw%& command line option. This takes an address (which can be a full RFC
23785 2822 address) as its argument. The output is a list of how the address would be
23786 transformed by the rewriting rules for each of the different places it might
23787 appear in an incoming message, that is, for each different header and for the
23788 envelope sender and recipient fields. For example,
23789 .code
23790 exim -brw ph10@exim.workshop.example
23791 .endd
23792 might produce the output
23793 .code
23794 sender: Philip.Hazel@exim.workshop.example
23795 from: Philip.Hazel@exim.workshop.example
23796 to: ph10@exim.workshop.example
23797 cc: ph10@exim.workshop.example
23798 bcc: ph10@exim.workshop.example
23799 reply-to: Philip.Hazel@exim.workshop.example
23800 env-from: Philip.Hazel@exim.workshop.example
23801 env-to: ph10@exim.workshop.example
23802 .endd
23803 which shows that rewriting has been set up for that address when used in any of
23804 the source fields, but not when it appears as a recipient address. At the
23805 present time, there is no equivalent way of testing rewriting rules that are
23806 set for a particular transport.
23807
23808
23809 .section "Rewriting rules" "SECID150"
23810 .cindex "rewriting" "rules"
23811 The rewrite section of the configuration file consists of lines of rewriting
23812 rules in the form
23813 .display
23814 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23815 .endd
23816 Rewriting rules that are specified for the &%headers_rewrite%& generic
23817 transport option are given as a colon-separated list. Each item in the list
23818 takes the same form as a line in the main rewriting configuration (except that
23819 any colons must be doubled, of course).
23820
23821 The formats of source patterns and replacement strings are described below.
23822 Each is terminated by white space, unless enclosed in double quotes, in which
23823 case normal quoting conventions apply inside the quotes. The flags are single
23824 characters which may appear in any order. Spaces and tabs between them are
23825 ignored.
23826
23827 For each address that could potentially be rewritten, the rules are scanned in
23828 order, and replacements for the address from earlier rules can themselves be
23829 replaced by later rules (but see the &"q"& and &"R"& flags).
23830
23831 The order in which addresses are rewritten is undefined, may change between
23832 releases, and must not be relied on, with one exception: when a message is
23833 received, the envelope sender is always rewritten first, before any header
23834 lines are rewritten. For example, the replacement string for a rewrite of an
23835 address in &'To:'& must not assume that the message's address in &'From:'& has
23836 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23837 that the envelope sender has already been rewritten.
23838
23839 .vindex "&$domain$&"
23840 .vindex "&$local_part$&"
23841 The variables &$local_part$& and &$domain$& can be used in the replacement
23842 string to refer to the address that is being rewritten. Note that lookup-driven
23843 rewriting can be done by a rule of the form
23844 .code
23845 *@*   ${lookup ...
23846 .endd
23847 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23848 refer to the address that is being rewritten.
23849
23850
23851 .section "Rewriting patterns" "SECID151"
23852 .cindex "rewriting" "patterns"
23853 .cindex "address list" "in a rewriting pattern"
23854 The source pattern in a rewriting rule is any item which may appear in an
23855 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23856 single-item address list, which means that it is expanded before being tested
23857 against the address. As always, if you use a regular expression as a pattern,
23858 you must take care to escape dollar and backslash characters, or use the &`\N`&
23859 facility to suppress string expansion within the regular expression.
23860
23861 Domains in patterns should be given in lower case. Local parts in patterns are
23862 case-sensitive. If you want to do case-insensitive matching of local parts, you
23863 can use a regular expression that starts with &`^(?i)`&.
23864
23865 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23866 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23867 depending on the type of match which occurred. These can be used in the
23868 replacement string to insert portions of the incoming address. &$0$& always
23869 refers to the complete incoming address. When a regular expression is used, the
23870 numerical variables are set from its capturing subexpressions. For other types
23871 of pattern they are set as follows:
23872
23873 .ilist
23874 If a local part or domain starts with an asterisk, the numerical variables
23875 refer to the character strings matched by asterisks, with &$1$& associated with
23876 the first asterisk, and &$2$& with the second, if present. For example, if the
23877 pattern
23878 .code
23879 *queen@*.fict.example
23880 .endd
23881 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23882 .code
23883 $0 = hearts-queen@wonderland.fict.example
23884 $1 = hearts-
23885 $2 = wonderland
23886 .endd
23887 Note that if the local part does not start with an asterisk, but the domain
23888 does, it is &$1$& that contains the wild part of the domain.
23889
23890 .next
23891 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23892 of the domain are placed in the next available numerical variables. Suppose,
23893 for example, that the address &'foo@bar.baz.example'& is processed by a
23894 rewriting rule of the form
23895 .display
23896 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23897 .endd
23898 and the key in the file that matches the domain is &`*.baz.example`&. Then
23899 .code
23900 $1 = foo
23901 $2 = bar
23902 $3 = baz.example
23903 .endd
23904 If the address &'foo@baz.example'& is looked up, this matches the same
23905 wildcard file entry, and in this case &$2$& is set to the empty string, but
23906 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23907 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23908 whole domain. For non-partial domain lookups, no numerical variables are set.
23909 .endlist
23910
23911
23912 .section "Rewriting replacements" "SECID152"
23913 .cindex "rewriting" "replacements"
23914 If the replacement string for a rule is a single asterisk, addresses that
23915 match the pattern and the flags are &'not'& rewritten, and no subsequent
23916 rewriting rules are scanned. For example,
23917 .code
23918 hatta@lookingglass.fict.example  *  f
23919 .endd
23920 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23921 &'From:'& headers.
23922
23923 .vindex "&$domain$&"
23924 .vindex "&$local_part$&"
23925 If the replacement string is not a single asterisk, it is expanded, and must
23926 yield a fully qualified address. Within the expansion, the variables
23927 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23928 Any letters they contain retain their original case &-- they are not lower
23929 cased. The numerical variables are set up according to the type of pattern that
23930 matched the address, as described above. If the expansion is forced to fail by
23931 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23932 current rule is abandoned, but subsequent rules may take effect. Any other
23933 expansion failure causes the entire rewriting operation to be abandoned, and an
23934 entry written to the panic log.
23935
23936
23937
23938 .section "Rewriting flags" "SECID153"
23939 There are three different kinds of flag that may appear on rewriting rules:
23940
23941 .ilist
23942 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23943 c, f, h, r, s, t.
23944 .next
23945 A flag that specifies rewriting at SMTP time: S.
23946 .next
23947 Flags that control the rewriting process: Q, q, R, w.
23948 .endlist
23949
23950 For rules that are part of the &%headers_rewrite%& generic transport option,
23951 E, F, T, and S are not permitted.
23952
23953
23954
23955 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23956          "SECID154"
23957 .cindex "rewriting" "flags"
23958 If none of the following flag letters, nor the &"S"& flag (see section
23959 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23960 and to both the sender and recipient fields of the envelope, whereas a
23961 transport-time rewriting rule just applies to all headers. Otherwise, the
23962 rewriting rule is skipped unless the relevant addresses are being processed.
23963 .display
23964 &`E`&       rewrite all envelope fields
23965 &`F`&       rewrite the envelope From field
23966 &`T`&       rewrite the envelope To field
23967 &`b`&       rewrite the &'Bcc:'& header
23968 &`c`&       rewrite the &'Cc:'& header
23969 &`f`&       rewrite the &'From:'& header
23970 &`h`&       rewrite all headers
23971 &`r`&       rewrite the &'Reply-To:'& header
23972 &`s`&       rewrite the &'Sender:'& header
23973 &`t`&       rewrite the &'To:'& header
23974 .endd
23975 "All headers" means all of the headers listed above that can be selected
23976 individually, plus their &'Resent-'& versions. It does not include
23977 other headers such as &'Subject:'& etc.
23978
23979 You should be particularly careful about rewriting &'Sender:'& headers, and
23980 restrict this to special known cases in your own domains.
23981
23982
23983 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23984 .cindex "SMTP" "rewriting malformed addresses"
23985 .cindex "RCPT" "rewriting argument of"
23986 .cindex "MAIL" "rewriting argument of"
23987 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23988 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23989 before any other processing; even before syntax checking. The pattern is
23990 required to be a regular expression, and it is matched against the whole of the
23991 data for the command, including any surrounding angle brackets.
23992
23993 .vindex "&$domain$&"
23994 .vindex "&$local_part$&"
23995 This form of rewrite rule allows for the handling of addresses that are not
23996 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23997 input). Because the input is not required to be a syntactically valid address,
23998 the variables &$local_part$& and &$domain$& are not available during the
23999 expansion of the replacement string. The result of rewriting replaces the
24000 original address in the MAIL or RCPT command.
24001
24002
24003 .section "Flags controlling the rewriting process" "SECID155"
24004 There are four flags which control the way the rewriting process works. These
24005 take effect only when a rule is invoked, that is, when the address is of the
24006 correct type (matches the flags) and matches the pattern:
24007
24008 .ilist
24009 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24010 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24011 absence of &"Q"& the rewritten address must always include a domain.
24012 .next
24013 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24014 even if no rewriting actually takes place because of a &"fail"& in the
24015 expansion. The &"q"& flag is not effective if the address is of the wrong type
24016 (does not match the flags) or does not match the pattern.
24017 .next
24018 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24019 address, up to ten times. It can be combined with the &"q"& flag, to stop
24020 rewriting once it fails to match (after at least one successful rewrite).
24021 .next
24022 .cindex "rewriting" "whole addresses"
24023 When an address in a header is rewritten, the rewriting normally applies only
24024 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24025 left unchanged. For example, rewriting might change
24026 .code
24027 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24028 .endd
24029 into
24030 .code
24031 From: Ford Prefect <prefectf@hitch.fict.example>
24032 .endd
24033 .cindex "RFC 2047"
24034 Sometimes there is a need to replace the whole address item, and this can be
24035 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24036 causes an address in a header line to be rewritten, the entire address is
24037 replaced, not just the working part. The replacement must be a complete RFC
24038 2822 address, including the angle brackets if necessary. If text outside angle
24039 brackets contains a character whose value is greater than 126 or less than 32
24040 (except for tab), the text is encoded according to RFC 2047. The character set
24041 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24042
24043 When the &"w"& flag is set on a rule that causes an envelope address to be
24044 rewritten, all but the working part of the replacement address is discarded.
24045 .endlist
24046
24047
24048 .section "Rewriting examples" "SECID156"
24049 Here is an example of the two common rewriting paradigms:
24050 .code
24051 *@*.hitch.fict.example  $1@hitch.fict.example
24052 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24053                      {$value}fail}@hitch.fict.example bctfrF
24054 .endd
24055 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24056 the string expansion to fail if the lookup does not succeed. In this context it
24057 has the effect of leaving the original address unchanged, but Exim goes on to
24058 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24059 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24060 explicitly, which would cause the rewritten address to be the same as before,
24061 at the cost of a small bit of processing. Not supplying either of these is an
24062 error, since the rewritten address would then contain no local part.
24063
24064 The first example above replaces the domain with a superior, more general
24065 domain. This may not be desirable for certain local parts. If the rule
24066 .code
24067 root@*.hitch.fict.example  *
24068 .endd
24069 were inserted before the first rule, rewriting would be suppressed for the
24070 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24071
24072 Rewriting can be made conditional on a number of tests, by making use of
24073 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24074 messages that originate outside the local host:
24075 .code
24076 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24077                          {$1@hitch.fict.example}fail}"
24078 .endd
24079 The replacement string is quoted in this example because it contains white
24080 space.
24081
24082 .cindex "rewriting" "bang paths"
24083 .cindex "bang paths" "rewriting"
24084 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24085 an address it treats it as an unqualified local part which it qualifies with
24086 the local qualification domain (if the source of the message is local or if the
24087 remote host is permitted to send unqualified addresses). Rewriting can
24088 sometimes be used to handle simple bang paths with a fixed number of
24089 components. For example, the rule
24090 .code
24091 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24092 .endd
24093 rewrites a two-component bang path &'host.name!user'& as the domain address
24094 &'user@host.name'&. However, there is a security implication in using this as
24095 a global rewriting rule for envelope addresses. It can provide a backdoor
24096 method for using your system as a relay, because the incoming addresses appear
24097 to be local. If the bang path addresses are received via SMTP, it is safer to
24098 use the &"S"& flag to rewrite them as they are received, so that relay checking
24099 can be done on the rewritten addresses.
24100 .ecindex IIDaddrew
24101
24102
24103
24104
24105
24106 . ////////////////////////////////////////////////////////////////////////////
24107 . ////////////////////////////////////////////////////////////////////////////
24108
24109 .chapter "Retry configuration" "CHAPretry"
24110 .scindex IIDretconf1 "retry" "configuration, description of"
24111 .scindex IIDregconf2 "configuration file" "retry section"
24112 The &"retry"& section of the runtime configuration file contains a list of
24113 retry rules that control how often Exim tries to deliver messages that cannot
24114 be delivered at the first attempt. If there are no retry rules (the section is
24115 empty or not present), there are no retries. In this situation, temporary
24116 errors are treated as permanent. The default configuration contains a single,
24117 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24118 line option can be used to test which retry rule will be used for a given
24119 address, domain and error.
24120
24121 The most common cause of retries is temporary failure to deliver to a remote
24122 host because the host is down, or inaccessible because of a network problem.
24123 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24124 address) basis, not on a per-message basis. Thus, if one message has recently
24125 been delayed, delivery of a new message to the same host is not immediately
24126 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24127 log selector is set, the message
24128 .cindex "retry" "time not reached"
24129 &"retry time not reached"& is written to the main log whenever a delivery is
24130 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24131 the handling of errors during remote deliveries.
24132
24133 Retry processing applies to routing as well as to delivering, except as covered
24134 in the next paragraph. The retry rules do not distinguish between these
24135 actions. It is not possible, for example, to specify different behaviour for
24136 failures to route the domain &'snark.fict.example'& and failures to deliver to
24137 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24138 added complication, so did not implement it. However, although they share the
24139 same retry rule, the actual retry times for routing and transporting a given
24140 domain are maintained independently.
24141
24142 When a delivery is not part of a queue run (typically an immediate delivery on
24143 receipt of a message), the routers are always run, and local deliveries are
24144 always attempted, even if retry times are set for them. This makes for better
24145 behaviour if one particular message is causing problems (for example, causing
24146 quota overflow, or provoking an error in a filter file). If such a delivery
24147 suffers a temporary failure, the retry data is updated as normal, and
24148 subsequent delivery attempts from queue runs occur only when the retry time for
24149 the local address is reached.
24150
24151 .section "Changing retry rules" "SECID157"
24152 If you change the retry rules in your configuration, you should consider
24153 whether or not to delete the retry data that is stored in Exim's spool area in
24154 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24155 always safe; that is why they are called &"hints"&.
24156
24157 The hints retry data contains suggested retry times based on the previous
24158 rules. In the case of a long-running problem with a remote host, it might
24159 record the fact that the host has timed out. If your new rules increase the
24160 timeout time for such a host, you should definitely remove the old retry data
24161 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24162 messages that it should now be retaining.
24163
24164
24165
24166 .section "Format of retry rules" "SECID158"
24167 .cindex "retry" "rules"
24168 Each retry rule occupies one line and consists of three or four parts,
24169 separated by white space: a pattern, an error name, an optional list of sender
24170 addresses, and a list of retry parameters. The pattern and sender lists must be
24171 enclosed in double quotes if they contain white space. The rules are searched
24172 in order until one is found where the pattern, error name, and sender list (if
24173 present) match the failing host or address, the error that occurred, and the
24174 message's sender, respectively.
24175
24176
24177 The pattern is any single item that may appear in an address list (see section
24178 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24179 which means that it is expanded before being tested against the address that
24180 has been delayed. A negated address list item is permitted. Address
24181 list processing treats a plain domain name as if it were preceded by &"*@"&,
24182 which makes it possible for many retry rules to start with just a domain. For
24183 example,
24184 .code
24185 lookingglass.fict.example        *  F,24h,30m;
24186 .endd
24187 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24188 whereas
24189 .code
24190 alice@lookingglass.fict.example  *  F,24h,30m;
24191 .endd
24192 applies only to temporary failures involving the local part &%alice%&.
24193 In practice, almost all rules start with a domain name pattern without a local
24194 part.
24195
24196 .cindex "regular expressions" "in retry rules"
24197 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24198 must match a complete address, not just a domain, because that is how regular
24199 expressions work in address lists.
24200 .display
24201 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24202 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24203 .endd
24204
24205
24206 .section "Choosing which retry rule to use for address errors" "SECID159"
24207 When Exim is looking for a retry rule after a routing attempt has failed (for
24208 example, after a DNS timeout), each line in the retry configuration is tested
24209 against the complete address only if &%retry_use_local_part%& is set for the
24210 router. Otherwise, only the domain is used, except when matching against a
24211 regular expression, when the local part of the address is replaced with &"*"&.
24212 A domain on its own can match a domain pattern, or a pattern that starts with
24213 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24214 &%check_local_user%& is true, and false for other routers.
24215
24216 Similarly, when Exim is looking for a retry rule after a local delivery has
24217 failed (for example, after a mailbox full error), each line in the retry
24218 configuration is tested against the complete address only if
24219 &%retry_use_local_part%& is set for the transport (it defaults true for all
24220 local transports).
24221
24222 .cindex "4&'xx'& responses" "retry rules for"
24223 However, when Exim is looking for a retry rule after a remote delivery attempt
24224 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24225 whole address is always used as the key when searching the retry rules. The
24226 rule that is found is used to create a retry time for the combination of the
24227 failing address and the message's sender. It is the combination of sender and
24228 recipient that is delayed in subsequent queue runs until its retry time is
24229 reached. You can delay the recipient without regard to the sender by setting
24230 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24231 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24232 commands.
24233
24234
24235
24236 .section "Choosing which retry rule to use for host and message errors" &&&
24237          "SECID160"
24238 For a temporary error that is not related to an individual address (for
24239 example, a connection timeout), each line in the retry configuration is checked
24240 twice. First, the name of the remote host is used as a domain name (preceded by
24241 &"*@"& when matching a regular expression). If this does not match the line,
24242 the domain from the email address is tried in a similar fashion. For example,
24243 suppose the MX records for &'a.b.c.example'& are
24244 .code
24245 a.b.c.example  MX  5  x.y.z.example
24246                MX  6  p.q.r.example
24247                MX  7  m.n.o.example
24248 .endd
24249 and the retry rules are
24250 .code
24251 p.q.r.example    *      F,24h,30m;
24252 a.b.c.example    *      F,4d,45m;
24253 .endd
24254 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24255 first rule matches neither the host nor the domain, so Exim looks at the second
24256 rule. This does not match the host, but it does match the domain, so it is used
24257 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24258 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24259 first retry rule is used, because it matches the host.
24260
24261 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24262 first rule to determine retry times, but for all the other hosts for the domain
24263 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24264 routing to &'a.b.c.example'& suffers a temporary failure.
24265
24266 &*Note*&: The host name is used when matching the patterns, not its IP address.
24267 However, if a message is routed directly to an IP address without the use of a
24268 host name, for example, if a &(manualroute)& router contains a setting such as:
24269 .code
24270 route_list = *.a.example  192.168.34.23
24271 .endd
24272 then the &"host name"& that is used when searching for a retry rule is the
24273 textual form of the IP address.
24274
24275 .section "Retry rules for specific errors" "SECID161"
24276 .cindex "retry" "specific errors; specifying"
24277 The second field in a retry rule is the name of a particular error, or an
24278 asterisk, which matches any error. The errors that can be tested for are:
24279
24280 .vlist
24281 .vitem &%auth_failed%&
24282 Authentication failed when trying to send to a host in the
24283 &%hosts_require_auth%& list in an &(smtp)& transport.
24284
24285 .vitem &%data_4xx%&
24286 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24287 after the command, or after sending the message's data.
24288
24289 .vitem &%mail_4xx%&
24290 A 4&'xx'& error was received for an outgoing MAIL command.
24291
24292 .vitem &%rcpt_4xx%&
24293 A 4&'xx'& error was received for an outgoing RCPT command.
24294 .endlist
24295
24296 For the three 4&'xx'& errors, either the first or both of the x's can be given
24297 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24298 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24299 and have retries every ten minutes with a one-hour timeout, you could set up a
24300 retry rule of this form:
24301 .code
24302 the.domain.name  rcpt_452   F,1h,10m
24303 .endd
24304 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24305 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24306
24307 .vlist
24308 .vitem &%lost_connection%&
24309 A server unexpectedly closed the SMTP connection. There may, of course,
24310 legitimate reasons for this (host died, network died), but if it repeats a lot
24311 for the same host, it indicates something odd.
24312
24313 .vitem &%refused_MX%&
24314 A connection to a host obtained from an MX record was refused.
24315
24316 .vitem &%refused_A%&
24317 A connection to a host not obtained from an MX record was refused.
24318
24319 .vitem &%refused%&
24320 A connection was refused.
24321
24322 .vitem &%timeout_connect_MX%&
24323 A connection attempt to a host obtained from an MX record timed out.
24324
24325 .vitem &%timeout_connect_A%&
24326 A connection attempt to a host not obtained from an MX record timed out.
24327
24328 .vitem &%timeout_connect%&
24329 A connection attempt timed out.
24330
24331 .vitem &%timeout_MX%&
24332 There was a timeout while connecting or during an SMTP session with a host
24333 obtained from an MX record.
24334
24335 .vitem &%timeout_A%&
24336 There was a timeout while connecting or during an SMTP session with a host not
24337 obtained from an MX record.
24338
24339 .vitem &%timeout%&
24340 There was a timeout while connecting or during an SMTP session.
24341
24342 .vitem &%tls_required%&
24343 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24344 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24345 to STARTTLS, or there was a problem setting up the TLS connection.
24346
24347 .vitem &%quota%&
24348 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24349 transport.
24350
24351 .vitem &%quota_%&<&'time'&>
24352 .cindex "quota" "error testing in retry rule"
24353 .cindex "retry" "quota error testing"
24354 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24355 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24356 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24357 for four days.
24358 .endlist
24359
24360 .cindex "mailbox" "time of last read"
24361 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24362 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24363 it should be based on the last time that the user accessed the mailbox.
24364 However, it is not always possible to determine this. Exim uses the following
24365 heuristic rules:
24366
24367 .ilist
24368 If the mailbox is a single file, the time of last access (the &"atime"&) is
24369 used. As no new messages are being delivered (because the mailbox is over
24370 quota), Exim does not access the file, so this is the time of last user access.
24371 .next
24372 .cindex "maildir format" "time of last read"
24373 For a maildir delivery, the time of last modification of the &_new_&
24374 subdirectory is used. As the mailbox is over quota, no new files are created in
24375 the &_new_& subdirectory, because no new messages are being delivered. Any
24376 change to the &_new_& subdirectory is therefore assumed to be the result of an
24377 MUA moving a new message to the &_cur_& directory when it is first read. The
24378 time that is used is therefore the last time that the user read a new message.
24379 .next
24380 For other kinds of multi-file mailbox, the time of last access cannot be
24381 obtained, so a retry rule that uses this type of error field is never matched.
24382 .endlist
24383
24384 The quota errors apply both to system-enforced quotas and to Exim's own quota
24385 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24386 when a local delivery is deferred because a partition is full (the ENOSPC
24387 error).
24388
24389
24390
24391 .section "Retry rules for specified senders" "SECID162"
24392 .cindex "retry" "rules; sender-specific"
24393 You can specify retry rules that apply only when the failing message has a
24394 specific sender. In particular, this can be used to define retry rules that
24395 apply only to bounce messages. The third item in a retry rule can be of this
24396 form:
24397 .display
24398 &`senders=`&<&'address list'&>
24399 .endd
24400 The retry timings themselves are then the fourth item. For example:
24401 .code
24402 *   rcpt_4xx   senders=:   F,1h,30m
24403 .endd
24404 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24405 host. If the address list contains white space, it must be enclosed in quotes.
24406 For example:
24407 .code
24408 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24409 .endd
24410 &*Warning*&: This facility can be unhelpful if it is used for host errors
24411 (which do not depend on the recipient). The reason is that the sender is used
24412 only to match the retry rule. Once the rule has been found for a host error,
24413 its contents are used to set a retry time for the host, and this will apply to
24414 all messages, not just those with specific senders.
24415
24416 When testing retry rules using &%-brt%&, you can supply a sender using the
24417 &%-f%& command line option, like this:
24418 .code
24419 exim -f "" -brt user@dom.ain
24420 .endd
24421 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24422 list is never matched.
24423
24424
24425
24426
24427
24428 .section "Retry parameters" "SECID163"
24429 .cindex "retry" "parameters in rules"
24430 The third (or fourth, if a senders list is present) field in a retry rule is a
24431 sequence of retry parameter sets, separated by semicolons. Each set consists of
24432 .display
24433 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24434 .endd
24435 The letter identifies the algorithm for computing a new retry time; the cutoff
24436 time is the time beyond which this algorithm no longer applies, and the
24437 arguments vary the algorithm's action. The cutoff time is measured from the
24438 time that the first failure for the domain (combined with the local part if
24439 relevant) was detected, not from the time the message was received.
24440
24441 .cindex "retry" "algorithms"
24442 .cindex "retry" "fixed intervals"
24443 .cindex "retry" "increasing intervals"
24444 .cindex "retry" "random intervals"
24445 The available algorithms are:
24446
24447 .ilist
24448 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24449 the interval.
24450 .next
24451 &'G'&: retry at geometrically increasing intervals. The first argument
24452 specifies a starting value for the interval, and the second a multiplier, which
24453 is used to increase the size of the interval at each retry.
24454 .next
24455 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24456 retry, the previous interval is multiplied by the factor in order to get a
24457 maximum for the next interval. The minimum interval is the first argument of
24458 the parameter, and an actual interval is chosen randomly between them. Such a
24459 rule has been found to be helpful in cluster configurations when all the
24460 members of the cluster restart at once, and may therefore synchronize their
24461 queue processing times.
24462 .endlist
24463
24464 When computing the next retry time, the algorithm definitions are scanned in
24465 order until one whose cutoff time has not yet passed is reached. This is then
24466 used to compute a new retry time that is later than the current time. In the
24467 case of fixed interval retries, this simply means adding the interval to the
24468 current time. For geometrically increasing intervals, retry intervals are
24469 computed from the rule's parameters until one that is greater than the previous
24470 interval is found. The main configuration variable
24471 .cindex "limit" "retry interval"
24472 .cindex "retry" "interval, maximum"
24473 .oindex "&%retry_interval_max%&"
24474 &%retry_interval_max%& limits the maximum interval between retries. It
24475 cannot be set greater than &`24h`&, which is its default value.
24476
24477 A single remote domain may have a number of hosts associated with it, and each
24478 host may have more than one IP address. Retry algorithms are selected on the
24479 basis of the domain name, but are applied to each IP address independently. If,
24480 for example, a host has two IP addresses and one is unusable, Exim will
24481 generate retry times for it and will not try to use it until its next retry
24482 time comes. Thus the good IP address is likely to be tried first most of the
24483 time.
24484
24485 .cindex "hints database" "use for retrying"
24486 Retry times are hints rather than promises. Exim does not make any attempt to
24487 run deliveries exactly at the computed times. Instead, a queue runner process
24488 starts delivery processes for delayed messages periodically, and these attempt
24489 new deliveries only for those addresses that have passed their next retry time.
24490 If a new message arrives for a deferred address, an immediate delivery attempt
24491 occurs only if the address has passed its retry time. In the absence of new
24492 messages, the minimum time between retries is the interval between queue runner
24493 processes. There is not much point in setting retry times of five minutes if
24494 your queue runners happen only once an hour, unless there are a significant
24495 number of incoming messages (which might be the case on a system that is
24496 sending everything to a smart host, for example).
24497
24498 The data in the retry hints database can be inspected by using the
24499 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24500 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24501 &'exinext'& utility script can be used to find out what the next retry times
24502 are for the hosts associated with a particular mail domain, and also for local
24503 deliveries that have been deferred.
24504
24505
24506 .section "Retry rule examples" "SECID164"
24507 Here are some example retry rules:
24508 .code
24509 alice@wonderland.fict.example quota_5d  F,7d,3h
24510 wonderland.fict.example       quota_5d
24511 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24512 lookingglass.fict.example     *         F,24h,30m;
24513 *                 refused_A   F,2h,20m;
24514 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24515 .endd
24516 The first rule sets up special handling for mail to
24517 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24518 mailbox has not been read for at least 5 days. Retries continue every three
24519 hours for 7 days. The second rule handles over-quota errors for all other local
24520 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24521 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24522 fail are bounced immediately if the mailbox has not been read for at least 5
24523 days.
24524
24525 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24526 happen every 15 minutes for an hour, then with geometrically increasing
24527 intervals until two days have passed since a delivery first failed. After the
24528 first hour there is a delay of one hour, then two hours, then four hours, and
24529 so on (this is a rather extreme example).
24530
24531 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24532 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24533 all other domains, with special action for connection refusal from hosts that
24534 were not obtained from an MX record.
24535
24536 The final rule in a retry configuration should always have asterisks in the
24537 first two fields so as to provide a general catch-all for any addresses that do
24538 not have their own special handling. This example tries every 15 minutes for 2
24539 hours, then with intervals starting at one hour and increasing by a factor of
24540 1.5 up to 16 hours, then every 8 hours up to 5 days.
24541
24542
24543
24544 .section "Timeout of retry data" "SECID165"
24545 .cindex "timeout" "of retry data"
24546 .oindex "&%retry_data_expire%&"
24547 .cindex "hints database" "data expiry"
24548 .cindex "retry" "timeout of data"
24549 Exim timestamps the data that it writes to its retry hints database. When it
24550 consults the data during a delivery it ignores any that is older than the value
24551 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24552 been tried for 7 days, Exim will try to deliver to it immediately a message
24553 arrives, and if that fails, it will calculate a retry time as if it were
24554 failing for the first time.
24555
24556 This improves the behaviour for messages routed to rarely-used hosts such as MX
24557 backups. If such a host was down at one time, and happens to be down again when
24558 Exim tries a month later, using the old retry data would imply that it had been
24559 down all the time, which is not a justified assumption.
24560
24561 If a host really is permanently dead, this behaviour causes a burst of retries
24562 every now and again, but only if messages routed to it are rare. If there is a
24563 message at least once every 7 days the retry data never expires.
24564
24565
24566
24567
24568 .section "Long-term failures" "SECID166"
24569 .cindex "delivery failure, long-term"
24570 .cindex "retry" "after long-term failure"
24571 Special processing happens when an email address has been failing for so long
24572 that the cutoff time for the last algorithm is reached. For example, using the
24573 default retry rule:
24574 .code
24575 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24576 .endd
24577 the cutoff time is four days. Reaching the retry cutoff is independent of how
24578 long any specific message has been failing; it is the length of continuous
24579 failure for the recipient address that counts.
24580
24581 When the cutoff time is reached for a local delivery, or for all the IP
24582 addresses associated with a remote delivery, a subsequent delivery failure
24583 causes Exim to give up on the address, and a bounce message is generated.
24584 In order to cater for new messages that use the failing address, a next retry
24585 time is still computed from the final algorithm, and is used as follows:
24586
24587 For local deliveries, one delivery attempt is always made for any subsequent
24588 messages. If this delivery fails, the address fails immediately. The
24589 post-cutoff retry time is not used.
24590
24591 If the delivery is remote, there are two possibilities, controlled by the
24592 .oindex "&%delay_after_cutoff%&"
24593 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24594 default. Until the post-cutoff retry time for one of the IP addresses is
24595 reached, the failing email address is bounced immediately, without a delivery
24596 attempt taking place. After that time, one new delivery attempt is made to
24597 those IP addresses that are past their retry times, and if that still fails,
24598 the address is bounced and new retry times are computed.
24599
24600 In other words, when all the hosts for a given email address have been failing
24601 for a long time, Exim bounces rather then defers until one of the hosts' retry
24602 times is reached. Then it tries once, and bounces if that attempt fails. This
24603 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24604 to a broken destination, but if the host does recover, Exim will eventually
24605 notice.
24606
24607 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24608 addresses are past their final cutoff time, Exim tries to deliver to those IP
24609 addresses that have not been tried since the message arrived. If there are
24610 no suitable IP addresses, or if they all fail, the address is bounced. In other
24611 words, it does not delay when a new message arrives, but tries the expired
24612 addresses immediately, unless they have been tried since the message arrived.
24613 If there is a continuous stream of messages for the failing domains, setting
24614 &%delay_after_cutoff%& false means that there will be many more attempts to
24615 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24616 true.
24617
24618 .section "Deliveries that work intermittently" "SECID167"
24619 .cindex "retry" "intermittently working deliveries"
24620 Some additional logic is needed to cope with cases where a host is
24621 intermittently available, or when a message has some attribute that prevents
24622 its delivery when others to the same address get through. In this situation,
24623 because some messages are successfully delivered, the &"retry clock"& for the
24624 host or address keeps getting reset by the successful deliveries, and so
24625 failing messages remain on the queue for ever because the cutoff time is never
24626 reached.
24627
24628 Two exceptional actions are applied to prevent this happening. The first
24629 applies to errors that are related to a message rather than a remote host.
24630 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24631 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24632 commands, and quota failures. For this type of error, if a message's arrival
24633 time is earlier than the &"first failed"& time for the error, the earlier time
24634 is used when scanning the retry rules to decide when to try next and when to
24635 time out the address.
24636
24637 The exceptional second action applies in all cases. If a message has been on
24638 the queue for longer than the cutoff time of any applicable retry rule for a
24639 given address, a delivery is attempted for that address, even if it is not yet
24640 time, and if this delivery fails, the address is timed out. A new retry time is
24641 not computed in this case, so that other messages for the same address are
24642 considered immediately.
24643 .ecindex IIDretconf1
24644 .ecindex IIDregconf2
24645
24646
24647
24648
24649
24650
24651 . ////////////////////////////////////////////////////////////////////////////
24652 . ////////////////////////////////////////////////////////////////////////////
24653
24654 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24655 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24656 .scindex IIDauthconf2 "authentication"
24657 The &"authenticators"& section of Exim's run time configuration is concerned
24658 with SMTP authentication. This facility is an extension to the SMTP protocol,
24659 described in RFC 2554, which allows a client SMTP host to authenticate itself
24660 to a server. This is a common way for a server to recognize clients that are
24661 permitted to use it as a relay. SMTP authentication is not of relevance to the
24662 transfer of mail between servers that have no managerial connection with each
24663 other.
24664
24665 .cindex "AUTH" "description of"
24666 Very briefly, the way SMTP authentication works is as follows:
24667
24668 .ilist
24669 The server advertises a number of authentication &'mechanisms'& in response to
24670 the client's EHLO command.
24671 .next
24672 The client issues an AUTH command, naming a specific mechanism. The command
24673 may, optionally, contain some authentication data.
24674 .next
24675 The server may issue one or more &'challenges'&, to which the client must send
24676 appropriate responses. In simple authentication mechanisms, the challenges are
24677 just prompts for user names and passwords. The server does not have to issue
24678 any challenges &-- in some mechanisms the relevant data may all be transmitted
24679 with the AUTH command.
24680 .next
24681 The server either accepts or denies authentication.
24682 .next
24683 If authentication succeeds, the client may optionally make use of the AUTH
24684 option on the MAIL command to pass an authenticated sender in subsequent
24685 mail transactions. Authentication lasts for the remainder of the SMTP
24686 connection.
24687 .next
24688 If authentication fails, the client may give up, or it may try a different
24689 authentication mechanism, or it may try transferring mail over the
24690 unauthenticated connection.
24691 .endlist
24692
24693 If you are setting up a client, and want to know which authentication
24694 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24695 SMTP port) on the server, and issue an EHLO command. The response to this
24696 includes the list of supported mechanisms. For example:
24697 .display
24698 &`$ `&&*&`telnet server.example 25`&*&
24699 &`Trying 192.168.34.25...`&
24700 &`Connected to server.example.`&
24701 &`Escape character is &#x0027;^]&#x0027;.`&
24702 &`220 server.example ESMTP Exim 4.20 ...`&
24703 &*&`ehlo client.example`&*&
24704 &`250-server.example Hello client.example [10.8.4.5]`&
24705 &`250-SIZE 52428800`&
24706 &`250-PIPELINING`&
24707 &`250-AUTH PLAIN`&
24708 &`250 HELP`&
24709 .endd
24710 The second-last line of this example output shows that the server supports
24711 authentication using the PLAIN mechanism. In Exim, the different authentication
24712 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24713 routers and transports, which authenticators are included in the binary is
24714 controlled by build-time definitions. The following are currently available,
24715 included by setting
24716 .code
24717 AUTH_CRAM_MD5=yes
24718 AUTH_CYRUS_SASL=yes
24719 AUTH_DOVECOT=yes
24720 AUTH_GSASL=yes
24721 AUTH_HEIMDAL_GSSAPI=yes
24722 AUTH_PLAINTEXT=yes
24723 AUTH_SPA=yes
24724 .endd
24725 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24726 authentication mechanism (RFC 2195), and the second provides an interface to
24727 the Cyrus SASL authentication library.
24728 The third is an interface to Dovecot's authentication system, delegating the
24729 work via a socket interface.
24730 The fourth provides an interface to the GNU SASL authentication library, which
24731 provides mechanisms but typically not data sources.
24732 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24733 supporting setting a server keytab.
24734 The sixth can be configured to support
24735 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24736 not formally documented, but used by several MUAs. The seventh authenticator
24737 supports Microsoft's &'Secure Password Authentication'& mechanism.
24738
24739 The authenticators are configured using the same syntax as other drivers (see
24740 section &<<SECTfordricon>>&). If no authenticators are required, no
24741 authentication section need be present in the configuration file. Each
24742 authenticator can in principle have both server and client functions. When Exim
24743 is receiving SMTP mail, it is acting as a server; when it is sending out
24744 messages over SMTP, it is acting as a client. Authenticator configuration
24745 options are provided for use in both these circumstances.
24746
24747 To make it clear which options apply to which situation, the prefixes
24748 &%server_%& and &%client_%& are used on option names that are specific to
24749 either the server or the client function, respectively. Server and client
24750 functions are disabled if none of their options are set. If an authenticator is
24751 to be used for both server and client functions, a single definition, using
24752 both sets of options, is required. For example:
24753 .code
24754 cram:
24755   driver = cram_md5
24756   public_name = CRAM-MD5
24757   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24758   client_name = ph10
24759   client_secret = secret2
24760 .endd
24761 The &%server_%& option is used when Exim is acting as a server, and the
24762 &%client_%& options when it is acting as a client.
24763
24764 Descriptions of the individual authenticators are given in subsequent chapters.
24765 The remainder of this chapter covers the generic options for the
24766 authenticators, followed by general discussion of the way authentication works
24767 in Exim.
24768
24769 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24770 per-mechanism basis.  Please read carefully to determine which variables hold
24771 account labels such as usercodes and which hold passwords or other
24772 authenticating data.
24773
24774 Note that some mechanisms support two different identifiers for accounts: the
24775 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24776 and &'authz'& are commonly encountered.  The American spelling is standard here.
24777 Conceptually, authentication data such as passwords are tied to the identifier
24778 used to authenticate; servers may have rules to permit one user to act as a
24779 second user, so that after login the session is treated as though that second
24780 user had logged in.  That second user is the &'authorization id'&.  A robust
24781 configuration might confirm that the &'authz'& field is empty or matches the
24782 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24783 as verified data, the &'authz'& as an unverified request which the server might
24784 choose to honour.
24785
24786 A &'realm'& is a text string, typically a domain name, presented by a server
24787 to a client to help it select an account and credentials to use.  In some
24788 mechanisms, the client and server provably agree on the realm, but clients
24789 typically can not treat the realm as secure data to be blindly trusted.
24790
24791
24792
24793 .section "Generic options for authenticators" "SECID168"
24794 .cindex "authentication" "generic options"
24795 .cindex "options" "generic; for authenticators"
24796
24797 .option client_condition authenticators string&!! unset
24798 When Exim is authenticating as a client, it skips any authenticator whose
24799 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24800 used, for example, to skip plain text authenticators when the connection is not
24801 encrypted by a setting such as:
24802 .code
24803 client_condition = ${if !eq{$tls_out_cipher}{}}
24804 .endd
24805
24806
24807 .option client_set_id authenticators string&!! unset
24808 When client authentication succeeds, this condition is expanded; the
24809 result is used in the log lines for outbound messasges.
24810 Typically it will be the user name used for authentication.
24811
24812
24813 .option driver authenticators string unset
24814 This option must always be set. It specifies which of the available
24815 authenticators is to be used.
24816
24817
24818 .option public_name authenticators string unset
24819 This option specifies the name of the authentication mechanism that the driver
24820 implements, and by which it is known to the outside world. These names should
24821 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24822 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24823 defaults to the driver's instance name.
24824
24825
24826 .option server_advertise_condition authenticators string&!! unset
24827 When a server is about to advertise an authentication mechanism, the condition
24828 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24829 mechanism is not advertised.
24830 If the expansion fails, the mechanism is not advertised. If the failure was not
24831 forced, and was not caused by a lookup defer, the incident is logged.
24832 See section &<<SECTauthexiser>>& below for further discussion.
24833
24834
24835 .option server_condition authenticators string&!! unset
24836 This option must be set for a &%plaintext%& server authenticator, where it
24837 is used directly to control authentication. See section &<<SECTplainserver>>&
24838 for details.
24839
24840 For the &(gsasl)& authenticator, this option is required for various
24841 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24842
24843 For the other authenticators, &%server_condition%& can be used as an additional
24844 authentication or authorization mechanism that is applied after the other
24845 authenticator conditions succeed. If it is set, it is expanded when the
24846 authenticator would otherwise return a success code. If the expansion is forced
24847 to fail, authentication fails. Any other expansion failure causes a temporary
24848 error code to be returned. If the result of a successful expansion is an empty
24849 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24850 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24851 other result, a temporary error code is returned, with the expanded string as
24852 the error text.
24853
24854
24855 .option server_debug_print authenticators string&!! unset
24856 If this option is set and authentication debugging is enabled (see the &%-d%&
24857 command line option), the string is expanded and included in the debugging
24858 output when the authenticator is run as a server. This can help with checking
24859 out the values of variables.
24860 If expansion of the string fails, the error message is written to the debugging
24861 output, and Exim carries on processing.
24862
24863
24864 .option server_set_id authenticators string&!! unset
24865 .vindex "&$authenticated_id$&"
24866 When an Exim server successfully authenticates a client, this string is
24867 expanded using data from the authentication, and preserved for any incoming
24868 messages in the variable &$authenticated_id$&. It is also included in the log
24869 lines for incoming messages. For example, a user/password authenticator
24870 configuration might preserve the user name that was used to authenticate, and
24871 refer to it subsequently during delivery of the message.
24872 If expansion fails, the option is ignored.
24873
24874
24875 .option server_mail_auth_condition authenticators string&!! unset
24876 This option allows a server to discard authenticated sender addresses supplied
24877 as part of MAIL commands in SMTP connections that are authenticated by the
24878 driver on which &%server_mail_auth_condition%& is set. The option is not used
24879 as part of the authentication process; instead its (unexpanded) value is
24880 remembered for later use.
24881 How it is used is described in the following section.
24882
24883
24884
24885
24886
24887 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24888 .cindex "authentication" "sender; authenticated"
24889 .cindex "AUTH" "on MAIL command"
24890 When a client supplied an AUTH= item on a MAIL command, Exim applies
24891 the following checks before accepting it as the authenticated sender of the
24892 message:
24893
24894 .ilist
24895 If the connection is not using extended SMTP (that is, HELO was used rather
24896 than EHLO), the use of AUTH= is a syntax error.
24897 .next
24898 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24899 .next
24900 .vindex "&$authenticated_sender$&"
24901 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24902 running, the value of &$authenticated_sender$& is set to the value obtained
24903 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24904 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24905 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24906 given for the MAIL command.
24907 .next
24908 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24909 is accepted and placed in &$authenticated_sender$& only if the client has
24910 authenticated.
24911 .next
24912 If the AUTH= value was accepted by either of the two previous rules, and
24913 the client has authenticated, and the authenticator has a setting for the
24914 &%server_mail_auth_condition%&, the condition is checked at this point. The
24915 valued that was saved from the authenticator is expanded. If the expansion
24916 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24917 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24918 the value of &$authenticated_sender$& is retained and passed on with the
24919 message.
24920 .endlist
24921
24922
24923 When &$authenticated_sender$& is set for a message, it is passed on to other
24924 hosts to which Exim authenticates as a client. Do not confuse this value with
24925 &$authenticated_id$&, which is a string obtained from the authentication
24926 process, and which is not usually a complete email address.
24927
24928 .vindex "&$sender_address$&"
24929 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24930 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24931 therefore make use of &$authenticated_sender$&. The converse is not true: the
24932 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24933 ACL is run.
24934
24935
24936
24937 .section "Authentication on an Exim server" "SECTauthexiser"
24938 .cindex "authentication" "on an Exim server"
24939 When Exim receives an EHLO command, it advertises the public names of those
24940 authenticators that are configured as servers, subject to the following
24941 conditions:
24942
24943 .ilist
24944 The client host must match &%auth_advertise_hosts%& (default *).
24945 .next
24946 It the &%server_advertise_condition%& option is set, its expansion must not
24947 yield the empty string, &"0"&, &"no"&, or &"false"&.
24948 .endlist
24949
24950 The order in which the authenticators are defined controls the order in which
24951 the mechanisms are advertised.
24952
24953 Some mail clients (for example, some versions of Netscape) require the user to
24954 provide a name and password for authentication whenever AUTH is advertised,
24955 even though authentication may not in fact be needed (for example, Exim may be
24956 set up to allow unconditional relaying from the client by an IP address check).
24957 You can make such clients more friendly by not advertising AUTH to them.
24958 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24959 that runs for RCPT) to relay without authentication, you should set
24960 .code
24961 auth_advertise_hosts = ! 10.9.8.0/24
24962 .endd
24963 so that no authentication mechanisms are advertised to them.
24964
24965 The &%server_advertise_condition%& controls the advertisement of individual
24966 authentication mechanisms. For example, it can be used to restrict the
24967 advertisement of a particular mechanism to encrypted connections, by a setting
24968 such as:
24969 .code
24970 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24971 .endd
24972 .vindex "&$tls_in_cipher$&"
24973 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24974 yields &"yes"&, which allows the advertisement to happen.
24975
24976 When an Exim server receives an AUTH command from a client, it rejects it
24977 immediately if AUTH was not advertised in response to an earlier EHLO
24978 command. This is the case if
24979
24980 .ilist
24981 The client host does not match &%auth_advertise_hosts%&; or
24982 .next
24983 No authenticators are configured with server options; or
24984 .next
24985 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24986 server authenticators.
24987 .endlist
24988
24989
24990 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24991 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24992 AUTH is accepted from any client host.
24993
24994 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24995 server authentication mechanism that was advertised in response to EHLO and
24996 that matches the one named in the AUTH command. If it finds one, it runs
24997 the appropriate authentication protocol, and authentication either succeeds or
24998 fails. If there is no matching advertised mechanism, the AUTH command is
24999 rejected with a 504 error.
25000
25001 .vindex "&$received_protocol$&"
25002 .vindex "&$sender_host_authenticated$&"
25003 When a message is received from an authenticated host, the value of
25004 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25005 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25006 public name) of the authenticator driver that successfully authenticated the
25007 client from which the message was received. This variable is empty if there was
25008 no successful authentication.
25009
25010
25011
25012
25013 .section "Testing server authentication" "SECID169"
25014 .cindex "authentication" "testing a server"
25015 .cindex "AUTH" "testing a server"
25016 .cindex "base64 encoding" "creating authentication test data"
25017 Exim's &%-bh%& option can be useful for testing server authentication
25018 configurations. The data for the AUTH command has to be sent using base64
25019 encoding. A quick way to produce such data for testing is the following Perl
25020 script:
25021 .code
25022 use MIME::Base64;
25023 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25024 .endd
25025 .cindex "binary zero" "in authentication data"
25026 This interprets its argument as a Perl string, and then encodes it. The
25027 interpretation as a Perl string allows binary zeros, which are required for
25028 some kinds of authentication, to be included in the data. For example, a
25029 command line to run this script on such data might be
25030 .code
25031 encode '\0user\0password'
25032 .endd
25033 Note the use of single quotes to prevent the shell interpreting the
25034 backslashes, so that they can be interpreted by Perl to specify characters
25035 whose code value is zero.
25036
25037 &*Warning 1*&: If either of the user or password strings starts with an octal
25038 digit, you must use three zeros instead of one after the leading backslash. If
25039 you do not, the octal digit that starts your string will be incorrectly
25040 interpreted as part of the code for the first character.
25041
25042 &*Warning 2*&: If there are characters in the strings that Perl interprets
25043 specially, you must use a Perl escape to prevent them being misinterpreted. For
25044 example, a command such as
25045 .code
25046 encode '\0user@domain.com\0pas$$word'
25047 .endd
25048 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25049
25050 If you have the &%mimencode%& command installed, another way to do produce
25051 base64-encoded strings is to run the command
25052 .code
25053 echo -e -n `\0user\0password' | mimencode
25054 .endd
25055 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25056 in the argument, and the &%-n%& option specifies no newline at the end of its
25057 output. However, not all versions of &%echo%& recognize these options, so you
25058 should check your version before relying on this suggestion.
25059
25060
25061
25062 .section "Authentication by an Exim client" "SECID170"
25063 .cindex "authentication" "on an Exim client"
25064 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25065 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25066 announces support for authentication, and the host matches an entry in either
25067 of these options, Exim (as a client) tries to authenticate as follows:
25068
25069 .ilist
25070 For each authenticator that is configured as a client, in the order in which
25071 they are defined in the configuration, it searches the authentication
25072 mechanisms announced by the server for one whose name matches the public name
25073 of the authenticator.
25074 .next
25075 .vindex "&$host$&"
25076 .vindex "&$host_address$&"
25077 When it finds one that matches, it runs the authenticator's client code. The
25078 variables &$host$& and &$host_address$& are available for any string expansions
25079 that the client might do. They are set to the server's name and IP address. If
25080 any expansion is forced to fail, the authentication attempt is abandoned, and
25081 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25082 delivery to be deferred.
25083 .next
25084 If the result of the authentication attempt is a temporary error or a timeout,
25085 Exim abandons trying to send the message to the host for the moment. It will
25086 try again later. If there are any backup hosts available, they are tried in the
25087 usual way.
25088 .next
25089 If the response to authentication is a permanent error (5&'xx'& code), Exim
25090 carries on searching the list of authenticators and tries another one if
25091 possible. If all authentication attempts give permanent errors, or if there are
25092 no attempts because no mechanisms match (or option expansions force failure),
25093 what happens depends on whether the host matches &%hosts_require_auth%& or
25094 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25095 delivery is deferred. The error can be detected in the retry rules, and thereby
25096 turned into a permanent error if you wish. In the second case, Exim tries to
25097 deliver the message unauthenticated.
25098 .endlist
25099
25100 .cindex "AUTH" "on MAIL command"
25101 When Exim has authenticated itself to a remote server, it adds the AUTH
25102 parameter to the MAIL commands it sends, if it has an authenticated sender for
25103 the message. If the message came from a remote host, the authenticated sender
25104 is the one that was receiving on an incoming MAIL command, provided that the
25105 incoming connection was authenticated and the &%server_mail_auth%& condition
25106 allowed the authenticated sender to be retained. If a local process calls Exim
25107 to send a message, the sender address that is built from the login name and
25108 &%qualify_domain%& is treated as authenticated. However, if the
25109 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25110 the authenticated sender that was received with the message.
25111 .ecindex IIDauthconf1
25112 .ecindex IIDauthconf2
25113
25114
25115
25116
25117
25118
25119 . ////////////////////////////////////////////////////////////////////////////
25120 . ////////////////////////////////////////////////////////////////////////////
25121
25122 .chapter "The plaintext authenticator" "CHAPplaintext"
25123 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25124 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25125 The &(plaintext)& authenticator can be configured to support the PLAIN and
25126 LOGIN authentication mechanisms, both of which transfer authentication data as
25127 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25128 security risk; you are strongly advised to insist on the use of SMTP encryption
25129 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25130 use unencrypted plain text, you should not use the same passwords for SMTP
25131 connections as you do for login accounts.
25132
25133 .section "Plaintext options" "SECID171"
25134 .cindex "options" "&(plaintext)& authenticator (server)"
25135 When configured as a server, &(plaintext)& uses the following options:
25136
25137 .option server_condition authenticators string&!! unset
25138 This is actually a global authentication option, but it must be set in order to
25139 configure the &(plaintext)& driver as a server. Its use is described below.
25140
25141 .option server_prompts plaintext string&!! unset
25142 The contents of this option, after expansion, must be a colon-separated list of
25143 prompt strings. If expansion fails, a temporary authentication rejection is
25144 given.
25145
25146 .section "Using plaintext in a server" "SECTplainserver"
25147 .cindex "AUTH" "in &(plaintext)& authenticator"
25148 .cindex "binary zero" "in &(plaintext)& authenticator"
25149 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25150         "in &(plaintext)& authenticator"
25151 .vindex "&$auth1$&, &$auth2$&, etc"
25152 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25153
25154 When running as a server, &(plaintext)& performs the authentication test by
25155 expanding a string. The data sent by the client with the AUTH command, or in
25156 response to subsequent prompts, is base64 encoded, and so may contain any byte
25157 values when decoded. If any data is supplied with the command, it is treated as
25158 a list of strings, separated by NULs (binary zeros), the first three of which
25159 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25160 (neither LOGIN nor PLAIN uses more than three strings).
25161
25162 For compatibility with previous releases of Exim, the values are also placed in
25163 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25164 variables for this purpose is now deprecated, as it can lead to confusion in
25165 string expansions that also use them for other things.
25166
25167 If there are more strings in &%server_prompts%& than the number of strings
25168 supplied with the AUTH command, the remaining prompts are used to obtain more
25169 data. Each response from the client may be a list of NUL-separated strings.
25170
25171 .vindex "&$authenticated_id$&"
25172 Once a sufficient number of data strings have been received,
25173 &%server_condition%& is expanded. If the expansion is forced to fail,
25174 authentication fails. Any other expansion failure causes a temporary error code
25175 to be returned. If the result of a successful expansion is an empty string,
25176 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25177 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25178 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25179 For any other result, a temporary error code is returned, with the expanded
25180 string as the error text
25181
25182 &*Warning*&: If you use a lookup in the expansion to find the user's
25183 password, be sure to make the authentication fail if the user is unknown.
25184 There are good and bad examples at the end of the next section.
25185
25186
25187
25188 .section "The PLAIN authentication mechanism" "SECID172"
25189 .cindex "PLAIN authentication mechanism"
25190 .cindex "authentication" "PLAIN mechanism"
25191 .cindex "binary zero" "in &(plaintext)& authenticator"
25192 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25193 sent as one item of data (that is, one combined string containing two NUL
25194 separators). The data is sent either as part of the AUTH command, or
25195 subsequently in response to an empty prompt from the server.
25196
25197 The second and third strings are a user name and a corresponding password.
25198 Using a single fixed user name and password as an example, this could be
25199 configured as follows:
25200 .code
25201 fixed_plain:
25202   driver = plaintext
25203   public_name = PLAIN
25204   server_prompts = :
25205   server_condition = \
25206     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25207   server_set_id = $auth2
25208 .endd
25209 Note that the default result strings from &%if%& (&"true"& or an empty string)
25210 are exactly what we want here, so they need not be specified. Obviously, if the
25211 password contains expansion-significant characters such as dollar, backslash,
25212 or closing brace, they have to be escaped.
25213
25214 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25215 the end of a string list are ignored). If all the data comes as part of the
25216 AUTH command, as is commonly the case, the prompt is not used. This
25217 authenticator is advertised in the response to EHLO as
25218 .code
25219 250-AUTH PLAIN
25220 .endd
25221 and a client host can authenticate itself by sending the command
25222 .code
25223 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25224 .endd
25225 As this contains three strings (more than the number of prompts), no further
25226 data is required from the client. Alternatively, the client may just send
25227 .code
25228 AUTH PLAIN
25229 .endd
25230 to initiate authentication, in which case the server replies with an empty
25231 prompt. The client must respond with the combined data string.
25232
25233 The data string is base64 encoded, as required by the RFC. This example,
25234 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25235 represents a zero byte. This is split up into three strings, the first of which
25236 is empty. The &%server_condition%& option in the authenticator checks that the
25237 second two are &`username`& and &`mysecret`& respectively.
25238
25239 Having just one fixed user name and password, as in this example, is not very
25240 realistic, though for a small organization with only a handful of
25241 authenticating clients it could make sense.
25242
25243 A more sophisticated instance of this authenticator could use the user name in
25244 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25245 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25246 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25247 This is an incorrect example:
25248 .code
25249 server_condition = \
25250   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25251 .endd
25252 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25253 which it then compares to the supplied password (&$auth3$&). Why is this example
25254 incorrect? It works fine for existing users, but consider what happens if a
25255 non-existent user name is given. The lookup fails, but as no success/failure
25256 strings are given for the lookup, it yields an empty string. Thus, to defeat
25257 the authentication, all a client has to do is to supply a non-existent user
25258 name and an empty password. The correct way of writing this test is:
25259 .code
25260 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25261   {${if eq{$value}{$auth3}}} {false}}
25262 .endd
25263 In this case, if the lookup succeeds, the result is checked; if the lookup
25264 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25265 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25266 always fails if its second argument is empty. However, the second way of
25267 writing the test makes the logic clearer.
25268
25269
25270 .section "The LOGIN authentication mechanism" "SECID173"
25271 .cindex "LOGIN authentication mechanism"
25272 .cindex "authentication" "LOGIN mechanism"
25273 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25274 in a number of programs. No data is sent with the AUTH command. Instead, a
25275 user name and password are supplied separately, in response to prompts. The
25276 plaintext authenticator can be configured to support this as in this example:
25277 .code
25278 fixed_login:
25279   driver = plaintext
25280   public_name = LOGIN
25281   server_prompts = User Name : Password
25282   server_condition = \
25283     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25284   server_set_id = $auth1
25285 .endd
25286 Because of the way plaintext operates, this authenticator accepts data supplied
25287 with the AUTH command (in contravention of the specification of LOGIN), but
25288 if the client does not supply it (as is the case for LOGIN clients), the prompt
25289 strings are used to obtain two data items.
25290
25291 Some clients are very particular about the precise text of the prompts. For
25292 example, Outlook Express is reported to recognize only &"Username:"& and
25293 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25294 strings. It uses the &%ldapauth%& expansion condition to check the user
25295 name and password by binding to an LDAP server:
25296 .code
25297 login:
25298   driver = plaintext
25299   public_name = LOGIN
25300   server_prompts = Username:: : Password::
25301   server_condition = ${if and{{ \
25302     !eq{}{$auth1} }{ \
25303     ldapauth{\
25304       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25305       pass=${quote:$auth2} \
25306       ldap://ldap.example.org/} }} }
25307   server_set_id = uid=$auth1,ou=people,o=example.org
25308 .endd
25309 We have to check that the username is not empty before using it, because LDAP
25310 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25311 operator to correctly quote the DN for authentication. However, the basic
25312 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25313 correct one to use for the password, because quoting is needed only to make
25314 the password conform to the Exim syntax. At the LDAP level, the password is an
25315 uninterpreted string.
25316
25317
25318 .section "Support for different kinds of authentication" "SECID174"
25319 A number of string expansion features are provided for the purpose of
25320 interfacing to different ways of user authentication. These include checking
25321 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25322 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25323 &<<SECTexpcond>>&.
25324
25325
25326
25327
25328 .section "Using plaintext in a client" "SECID175"
25329 .cindex "options" "&(plaintext)& authenticator (client)"
25330 The &(plaintext)& authenticator has two client options:
25331
25332 .option client_ignore_invalid_base64 plaintext boolean false
25333 If the client receives a server prompt that is not a valid base64 string,
25334 authentication is abandoned by default. However, if this option is set true,
25335 the error in the challenge is ignored and the client sends the response as
25336 usual.
25337
25338 .option client_send plaintext string&!! unset
25339 The string is a colon-separated list of authentication data strings. Each
25340 string is independently expanded before being sent to the server. The first
25341 string is sent with the AUTH command; any more strings are sent in response
25342 to prompts from the server. Before each string is expanded, the value of the
25343 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25344 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25345 way. Thus, the prompt that is received in response to sending the first string
25346 (with the AUTH command) can be used in the expansion of the second string, and
25347 so on. If an invalid base64 string is received when
25348 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25349 &$auth$&<&'n'&> variable.
25350
25351 &*Note*&: You cannot use expansion to create multiple strings, because
25352 splitting takes priority and happens first.
25353
25354 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25355 the data, further processing is applied to each string before it is sent. If
25356 there are any single circumflex characters in the string, they are converted to
25357 NULs. Should an actual circumflex be required as data, it must be doubled in
25358 the string.
25359
25360 This is an example of a client configuration that implements the PLAIN
25361 authentication mechanism with a fixed user name and password:
25362 .code
25363 fixed_plain:
25364   driver = plaintext
25365   public_name = PLAIN
25366   client_send = ^username^mysecret
25367 .endd
25368 The lack of colons means that the entire text is sent with the AUTH
25369 command, with the circumflex characters converted to NULs. A similar example
25370 that uses the LOGIN mechanism is:
25371 .code
25372 fixed_login:
25373   driver = plaintext
25374   public_name = LOGIN
25375   client_send = : username : mysecret
25376 .endd
25377 The initial colon means that the first string is empty, so no data is sent with
25378 the AUTH command itself. The remaining strings are sent in response to
25379 prompts.
25380 .ecindex IIDplaiauth1
25381 .ecindex IIDplaiauth2
25382
25383
25384
25385
25386 . ////////////////////////////////////////////////////////////////////////////
25387 . ////////////////////////////////////////////////////////////////////////////
25388
25389 .chapter "The cram_md5 authenticator" "CHID9"
25390 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25391 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25392 .cindex "CRAM-MD5 authentication mechanism"
25393 .cindex "authentication" "CRAM-MD5 mechanism"
25394 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25395 sends a challenge string to the client, and the response consists of a user
25396 name and the CRAM-MD5 digest of the challenge string combined with a secret
25397 string (password) which is known to both server and client. Thus, the secret
25398 is not sent over the network as plain text, which makes this authenticator more
25399 secure than &(plaintext)&. However, the downside is that the secret has to be
25400 available in plain text at either end.
25401
25402
25403 .section "Using cram_md5 as a server" "SECID176"
25404 .cindex "options" "&(cram_md5)& authenticator (server)"
25405 This authenticator has one server option, which must be set to configure the
25406 authenticator as a server:
25407
25408 .option server_secret cram_md5 string&!! unset
25409 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25410 When the server receives the client's response, the user name is placed in
25411 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25412 obtain the password for that user. The server then computes the CRAM-MD5 digest
25413 that the client should have sent, and checks that it received the correct
25414 string. If the expansion of &%server_secret%& is forced to fail, authentication
25415 fails. If the expansion fails for some other reason, a temporary error code is
25416 returned to the client.
25417
25418 For compatibility with previous releases of Exim, the user name is also placed
25419 in &$1$&. However, the use of this variables for this purpose is now
25420 deprecated, as it can lead to confusion in string expansions that also use
25421 numeric variables for other things.
25422
25423 For example, the following authenticator checks that the user name given by the
25424 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25425 user name, authentication fails.
25426 .code
25427 fixed_cram:
25428   driver = cram_md5
25429   public_name = CRAM-MD5
25430   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25431   server_set_id = $auth1
25432 .endd
25433 .vindex "&$authenticated_id$&"
25434 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25435 name in &$authenticated_id$&. A more typical configuration might look up the
25436 secret string in a file, using the user name as the key. For example:
25437 .code
25438 lookup_cram:
25439   driver = cram_md5
25440   public_name = CRAM-MD5
25441   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25442                   {$value}fail}
25443   server_set_id = $auth1
25444 .endd
25445 Note that this expansion explicitly forces failure if the lookup fails
25446 because &$auth1$& contains an unknown user name.
25447
25448 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25449 using the relevant libraries, you need to know the realm to specify in the
25450 lookup and then ask for the &"userPassword"& attribute for that user in that
25451 realm, with:
25452 .code
25453 cyrusless_crammd5:
25454   driver = cram_md5
25455   public_name = CRAM-MD5
25456   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25457                   dbmjz{/etc/sasldb2}}
25458   server_set_id = $auth1
25459 .endd
25460
25461 .section "Using cram_md5 as a client" "SECID177"
25462 .cindex "options" "&(cram_md5)& authenticator (client)"
25463 When used as a client, the &(cram_md5)& authenticator has two options:
25464
25465
25466
25467 .option client_name cram_md5 string&!! "the primary host name"
25468 This string is expanded, and the result used as the user name data when
25469 computing the response to the server's challenge.
25470
25471
25472 .option client_secret cram_md5 string&!! unset
25473 This option must be set for the authenticator to work as a client. Its value is
25474 expanded and the result used as the secret string when computing the response.
25475
25476
25477 .vindex "&$host$&"
25478 .vindex "&$host_address$&"
25479 Different user names and secrets can be used for different servers by referring
25480 to &$host$& or &$host_address$& in the options. Forced failure of either
25481 expansion string is treated as an indication that this authenticator is not
25482 prepared to handle this case. Exim moves on to the next configured client
25483 authenticator. Any other expansion failure causes Exim to give up trying to
25484 send the message to the current server.
25485
25486 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25487 strings, is:
25488 .code
25489 fixed_cram:
25490   driver = cram_md5
25491   public_name = CRAM-MD5
25492   client_name = ph10
25493   client_secret = secret
25494 .endd
25495 .ecindex IIDcramauth1
25496 .ecindex IIDcramauth2
25497
25498
25499
25500 . ////////////////////////////////////////////////////////////////////////////
25501 . ////////////////////////////////////////////////////////////////////////////
25502
25503 .chapter "The cyrus_sasl authenticator" "CHID10"
25504 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25505 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25506 .cindex "Cyrus" "SASL library"
25507 .cindex "Kerberos"
25508 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25509 Digital Ltd (&url(http://www.aldigital.co.uk)).
25510
25511 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25512 library implementation of the RFC 2222 (&"Simple Authentication and Security
25513 Layer"&). This library supports a number of authentication mechanisms,
25514 including PLAIN and LOGIN, but also several others that Exim does not support
25515 directly. In particular, there is support for Kerberos authentication.
25516
25517 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25518 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25519 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25520 name of the driver to determine which mechanism to support.
25521
25522 Where access to some kind of secret file is required, for example in GSSAPI
25523 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25524 user, and that the Cyrus SASL library has no way of escalating privileges
25525 by default. You may also find you need to set environment variables,
25526 depending on the driver you are using.
25527
25528 The application name provided by Exim is &"exim"&, so various SASL options may
25529 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25530 Kerberos, note that because of limitations in the GSSAPI interface,
25531 changing the server keytab might need to be communicated down to the Kerberos
25532 layer independently. The mechanism for doing so is dependent upon the Kerberos
25533 implementation.
25534
25535 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25536 may be set to point to an alternative keytab file. Exim will pass this
25537 variable through from its own inherited environment when started as root or the
25538 Exim user. The keytab file needs to be readable by the Exim user.
25539 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25540 environment variable.  In practice, for those releases, the Cyrus authenticator
25541 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25542 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25543
25544
25545 .section "Using cyrus_sasl as a server" "SECID178"
25546 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25547 (on a successful authentication) into &$auth1$&. For compatibility with
25548 previous releases of Exim, the username is also placed in &$1$&. However, the
25549 use of this variable for this purpose is now deprecated, as it can lead to
25550 confusion in string expansions that also use numeric variables for other
25551 things.
25552
25553
25554 .option server_hostname cyrus_sasl string&!! "see below"
25555 This option selects the hostname that is used when communicating with the
25556 library. The default value is &`$primary_hostname`&. It is up to the underlying
25557 SASL plug-in what it does with this data.
25558
25559
25560 .option server_mech cyrus_sasl string "see below"
25561 This option selects the authentication mechanism this driver should use. The
25562 default is the value of the generic &%public_name%& option. This option allows
25563 you to use a different underlying mechanism from the advertised name. For
25564 example:
25565 .code
25566 sasl:
25567   driver = cyrus_sasl
25568   public_name = X-ANYTHING
25569   server_mech = CRAM-MD5
25570   server_set_id = $auth1
25571 .endd
25572
25573 .option server_realm cyrus_sasl string&!! unset
25574 This specifies the SASL realm that the server claims to be in.
25575
25576
25577 .option server_service cyrus_sasl string &`smtp`&
25578 This is the SASL service that the server claims to implement.
25579
25580
25581 For straightforward cases, you do not need to set any of the authenticator's
25582 private options. All you need to do is to specify an appropriate mechanism as
25583 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25584 PLAIN, you could have two authenticators as follows:
25585 .code
25586 sasl_cram_md5:
25587   driver = cyrus_sasl
25588   public_name = CRAM-MD5
25589   server_set_id = $auth1
25590
25591 sasl_plain:
25592   driver = cyrus_sasl
25593   public_name = PLAIN
25594   server_set_id = $auth2
25595 .endd
25596 Cyrus SASL does implement the LOGIN authentication method, even though it is
25597 not a standard method. It is disabled by default in the source distribution,
25598 but it is present in many binary distributions.
25599 .ecindex IIDcyrauth1
25600 .ecindex IIDcyrauth2
25601
25602
25603
25604
25605 . ////////////////////////////////////////////////////////////////////////////
25606 . ////////////////////////////////////////////////////////////////////////////
25607 .chapter "The dovecot authenticator" "CHAPdovecot"
25608 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25609 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25610 This authenticator is an interface to the authentication facility of the
25611 Dovecot POP/IMAP server, which can support a number of authentication methods.
25612 Note that Dovecot must be configured to use auth-client not auth-userdb.
25613 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25614 to use the same mechanisms for SMTP authentication. This is a server
25615 authenticator only. There is only one option:
25616
25617 .option server_socket dovecot string unset
25618
25619 This option must specify the socket that is the interface to Dovecot
25620 authentication. The &%public_name%& option must specify an authentication
25621 mechanism that Dovecot is configured to support. You can have several
25622 authenticators for different mechanisms. For example:
25623 .code
25624 dovecot_plain:
25625   driver = dovecot
25626   public_name = PLAIN
25627   server_socket = /var/run/dovecot/auth-client
25628   server_set_id = $auth1
25629
25630 dovecot_ntlm:
25631   driver = dovecot
25632   public_name = NTLM
25633   server_socket = /var/run/dovecot/auth-client
25634   server_set_id = $auth1
25635 .endd
25636 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25637 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25638 option is passed in the Dovecot authentication command. If, for a TLS
25639 connection, a client certificate has been verified, the &"valid-client-cert"&
25640 option is passed. When authentication succeeds, the identity of the user
25641 who authenticated is placed in &$auth1$&.
25642 .ecindex IIDdcotauth1
25643 .ecindex IIDdcotauth2
25644
25645
25646 . ////////////////////////////////////////////////////////////////////////////
25647 . ////////////////////////////////////////////////////////////////////////////
25648 .chapter "The gsasl authenticator" "CHAPgsasl"
25649 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25650 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25651 .cindex "authentication" "GNU SASL"
25652 .cindex "authentication" "SASL"
25653 .cindex "authentication" "EXTERNAL"
25654 .cindex "authentication" "ANONYMOUS"
25655 .cindex "authentication" "PLAIN"
25656 .cindex "authentication" "LOGIN"
25657 .cindex "authentication" "DIGEST-MD5"
25658 .cindex "authentication" "CRAM-MD5"
25659 .cindex "authentication" "SCRAM-SHA-1"
25660 The &(gsasl)& authenticator provides server integration for the GNU SASL
25661 library and the mechanisms it provides.  This is new as of the 4.80 release
25662 and there are a few areas where the library does not let Exim smoothly
25663 scale to handle future authentication mechanisms, so no guarantee can be
25664 made that any particular new authentication mechanism will be supported
25665 without code changes in Exim.
25666
25667
25668 .option server_channelbinding gsasl boolean false
25669 Some authentication mechanisms are able to use external context at both ends
25670 of the session to bind the authentication to that context, and fail the
25671 authentication process if that context differs.  Specifically, some TLS
25672 ciphersuites can provide identifying information about the cryptographic
25673 context.
25674
25675 This means that certificate identity and verification becomes a non-issue,
25676 as a man-in-the-middle attack will cause the correct client and server to
25677 see different identifiers and authentication will fail.
25678
25679 This is currently only supported when using the GnuTLS library.  This is
25680 only usable by mechanisms which support "channel binding"; at time of
25681 writing, that's the SCRAM family.
25682
25683 This defaults off to ensure smooth upgrade across Exim releases, in case
25684 this option causes some clients to start failing.  Some future release
25685 of Exim may switch the default to be true.
25686
25687
25688 .option server_hostname gsasl string&!! "see below"
25689 This option selects the hostname that is used when communicating with the
25690 library. The default value is &`$primary_hostname`&.
25691 Some mechanisms will use this data.
25692
25693
25694 .option server_mech gsasl string "see below"
25695 This option selects the authentication mechanism this driver should use. The
25696 default is the value of the generic &%public_name%& option. This option allows
25697 you to use a different underlying mechanism from the advertised name. For
25698 example:
25699 .code
25700 sasl:
25701   driver = gsasl
25702   public_name = X-ANYTHING
25703   server_mech = CRAM-MD5
25704   server_set_id = $auth1
25705 .endd
25706
25707
25708 .option server_password gsasl string&!! unset
25709 Various mechanisms need access to the cleartext password on the server, so
25710 that proof-of-possession can be demonstrated on the wire, without sending
25711 the password itself.
25712
25713 The data available for lookup varies per mechanism.
25714 In all cases, &$auth1$& is set to the &'authentication id'&.
25715 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25716 if available, else the empty string.
25717 The &$auth3$& variable will always be the &'realm'& if available,
25718 else the empty string.
25719
25720 A forced failure will cause authentication to defer.
25721
25722 If using this option, it may make sense to set the &%server_condition%&
25723 option to be simply "true".
25724
25725
25726 .option server_realm gsasl string&!! unset
25727 This specifies the SASL realm that the server claims to be in.
25728 Some mechanisms will use this data.
25729
25730
25731 .option server_scram_iter gsasl string&!! unset
25732 This option provides data for the SCRAM family of mechanisms.
25733 &$auth1$& is not available at evaluation time.
25734 (This may change, as we receive feedback on use)
25735
25736
25737 .option server_scram_salt gsasl string&!! unset
25738 This option provides data for the SCRAM family of mechanisms.
25739 &$auth1$& is not available at evaluation time.
25740 (This may change, as we receive feedback on use)
25741
25742
25743 .option server_service gsasl string &`smtp`&
25744 This is the SASL service that the server claims to implement.
25745 Some mechanisms will use this data.
25746
25747
25748 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25749 .vindex "&$auth1$&, &$auth2$&, etc"
25750 These may be set when evaluating specific options, as detailed above.
25751 They will also be set when evaluating &%server_condition%&.
25752
25753 Unless otherwise stated below, the &(gsasl)& integration will use the following
25754 meanings for these variables:
25755
25756 .ilist
25757 .vindex "&$auth1$&"
25758 &$auth1$&: the &'authentication id'&
25759 .next
25760 .vindex "&$auth2$&"
25761 &$auth2$&: the &'authorization id'&
25762 .next
25763 .vindex "&$auth3$&"
25764 &$auth3$&: the &'realm'&
25765 .endlist
25766
25767 On a per-mechanism basis:
25768
25769 .ilist
25770 .cindex "authentication" "EXTERNAL"
25771 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25772 the &%server_condition%& option must be present.
25773 .next
25774 .cindex "authentication" "ANONYMOUS"
25775 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25776 the &%server_condition%& option must be present.
25777 .next
25778 .cindex "authentication" "GSSAPI"
25779 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25780 &$auth2$& will be set to the &'authorization id'&,
25781 the &%server_condition%& option must be present.
25782 .endlist
25783
25784 An &'anonymous token'& is something passed along as an unauthenticated
25785 identifier; this is analogous to FTP anonymous authentication passing an
25786 email address, or software-identifier@, as the "password".
25787
25788
25789 An example showing the password having the realm specified in the callback
25790 and demonstrating a Cyrus SASL to GSASL migration approach is:
25791 .code
25792 gsasl_cyrusless_crammd5:
25793   driver = gsasl
25794   public_name = CRAM-MD5
25795   server_realm = imap.example.org
25796   server_password = ${lookup{$auth1:$auth3:userPassword}\
25797                     dbmjz{/etc/sasldb2}{$value}fail}
25798   server_set_id = ${quote:$auth1}
25799   server_condition = yes
25800 .endd
25801
25802
25803 . ////////////////////////////////////////////////////////////////////////////
25804 . ////////////////////////////////////////////////////////////////////////////
25805
25806 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25807 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25808 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25809 .cindex "authentication" "GSSAPI"
25810 .cindex "authentication" "Kerberos"
25811 The &(heimdal_gssapi)& authenticator provides server integration for the
25812 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25813 reliably.
25814
25815 .option server_hostname heimdal_gssapi string&!! "see below"
25816 This option selects the hostname that is used, with &%server_service%&,
25817 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25818 identifier.  The default value is &`$primary_hostname`&.
25819
25820 .option server_keytab heimdal_gssapi string&!! unset
25821 If set, then Heimdal will not use the system default keytab (typically
25822 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25823 The value should be a pathname, with no &"file:"& prefix.
25824
25825 .option server_service heimdal_gssapi string&!! "smtp"
25826 This option specifies the service identifier used, in conjunction with
25827 &%server_hostname%&, for building the identifer for finding credentials
25828 from the keytab.
25829
25830
25831 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25832 Beware that these variables will typically include a realm, thus will appear
25833 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25834 not verified, so a malicious client can set it to anything.
25835
25836 The &$auth1$& field should be safely trustable as a value from the Key
25837 Distribution Center.  Note that these are not quite email addresses.
25838 Each identifier is for a role, and so the left-hand-side may include a
25839 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25840
25841 .vindex "&$auth1$&, &$auth2$&, etc"
25842 .ilist
25843 .vindex "&$auth1$&"
25844 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25845 .next
25846 .vindex "&$auth2$&"
25847 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25848 authentication.  If that was empty, this will also be set to the
25849 GSS Display Name.
25850 .endlist
25851
25852
25853 . ////////////////////////////////////////////////////////////////////////////
25854 . ////////////////////////////////////////////////////////////////////////////
25855
25856 .chapter "The spa authenticator" "CHAPspa"
25857 .scindex IIDspaauth1 "&(spa)& authenticator"
25858 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25859 .cindex "authentication" "Microsoft Secure Password"
25860 .cindex "authentication" "NTLM"
25861 .cindex "Microsoft Secure Password Authentication"
25862 .cindex "NTLM authentication"
25863 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25864 Password Authentication'& mechanism,
25865 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25866 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25867 taken from the Samba project (&url(http://www.samba.org)). The code for the
25868 server side was subsequently contributed by Tom Kistner. The mechanism works as
25869 follows:
25870
25871 .ilist
25872 After the AUTH command has been accepted, the client sends an SPA
25873 authentication request based on the user name and optional domain.
25874 .next
25875 The server sends back a challenge.
25876 .next
25877 The client builds a challenge response which makes use of the user's password
25878 and sends it to the server, which then accepts or rejects it.
25879 .endlist
25880
25881 Encryption is used to protect the password in transit.
25882
25883
25884
25885 .section "Using spa as a server" "SECID179"
25886 .cindex "options" "&(spa)& authenticator (server)"
25887 The &(spa)& authenticator has just one server option:
25888
25889 .option server_password spa string&!! unset
25890 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25891 This option is expanded, and the result must be the cleartext password for the
25892 authenticating user, whose name is at this point in &$auth1$&. For
25893 compatibility with previous releases of Exim, the user name is also placed in
25894 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25895 it can lead to confusion in string expansions that also use numeric variables
25896 for other things. For example:
25897 .code
25898 spa:
25899   driver = spa
25900   public_name = NTLM
25901   server_password = \
25902     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25903 .endd
25904 If the expansion is forced to fail, authentication fails. Any other expansion
25905 failure causes a temporary error code to be returned.
25906
25907
25908
25909
25910
25911 .section "Using spa as a client" "SECID180"
25912 .cindex "options" "&(spa)& authenticator (client)"
25913 The &(spa)& authenticator has the following client options:
25914
25915
25916
25917 .option client_domain spa string&!! unset
25918 This option specifies an optional domain for the authentication.
25919
25920
25921 .option client_password spa string&!! unset
25922 This option specifies the user's password, and must be set.
25923
25924
25925 .option client_username spa string&!! unset
25926 This option specifies the user name, and must be set. Here is an example of a
25927 configuration of this authenticator for use with the mail servers at
25928 &'msn.com'&:
25929 .code
25930 msn:
25931   driver = spa
25932   public_name = MSN
25933   client_username = msn/msn_username
25934   client_password = msn_plaintext_password
25935   client_domain = DOMAIN_OR_UNSET
25936 .endd
25937 .ecindex IIDspaauth1
25938 .ecindex IIDspaauth2
25939
25940
25941
25942
25943
25944 . ////////////////////////////////////////////////////////////////////////////
25945 . ////////////////////////////////////////////////////////////////////////////
25946
25947 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25948          "Encrypted SMTP connections"
25949 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25950 .scindex IIDencsmtp2 "SMTP" "encryption"
25951 .cindex "TLS" "on SMTP connection"
25952 .cindex "OpenSSL"
25953 .cindex "GnuTLS"
25954 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25955 Sockets Layer), is implemented by making use of the OpenSSL library or the
25956 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25957 cryptographic code in the Exim distribution itself for implementing TLS. In
25958 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25959 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25960 You also need to understand the basic concepts of encryption at a managerial
25961 level, and in particular, the way that public keys, private keys, and
25962 certificates are used.
25963
25964 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25965 connection is established, the client issues a STARTTLS command. If the
25966 server accepts this, the client and the server negotiate an encryption
25967 mechanism. If the negotiation succeeds, the data that subsequently passes
25968 between them is encrypted.
25969
25970 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25971 and if so, what cipher suite is in use, whether the client supplied a
25972 certificate, and whether or not that certificate was verified. This makes it
25973 possible for an Exim server to deny or accept certain commands based on the
25974 encryption state.
25975
25976 &*Warning*&: Certain types of firewall and certain anti-virus products can
25977 disrupt TLS connections. You need to turn off SMTP scanning for these products
25978 in order to get TLS to work.
25979
25980
25981
25982 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25983          "SECID284"
25984 .cindex "ssmtp protocol"
25985 .cindex "smtps protocol"
25986 .cindex "SMTP" "ssmtp protocol"
25987 .cindex "SMTP" "smtps protocol"
25988 Early implementations of encrypted SMTP used a different TCP port from normal
25989 SMTP, and expected an encryption negotiation to start immediately, instead of
25990 waiting for a STARTTLS command from the client using the standard SMTP
25991 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25992 allocated for this purpose.
25993
25994 This approach was abandoned when encrypted SMTP was standardized, but there are
25995 still some legacy clients that use it. Exim supports these clients by means of
25996 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25997 numbers; the most common use is expected to be:
25998 .code
25999 tls_on_connect_ports = 465
26000 .endd
26001 The port numbers specified by this option apply to all SMTP connections, both
26002 via the daemon and via &'inetd'&. You still need to specify all the ports that
26003 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26004 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26005 an extra port &-- rather, it specifies different behaviour on a port that is
26006 defined elsewhere.
26007
26008 There is also a &%-tls-on-connect%& command line option. This overrides
26009 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26010
26011
26012
26013
26014
26015
26016 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26017 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26018 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26019 followed later, when the first versions of GnuTLS were released. To build Exim
26020 to use GnuTLS, you need to set
26021 .code
26022 USE_GNUTLS=yes
26023 .endd
26024 in Local/Makefile, in addition to
26025 .code
26026 SUPPORT_TLS=yes
26027 .endd
26028 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26029 include files and libraries for GnuTLS can be found.
26030
26031 There are some differences in usage when using GnuTLS instead of OpenSSL:
26032
26033 .ilist
26034 The &%tls_verify_certificates%& option
26035 cannot be the path of a directory
26036 for GnuTLS versions before 3.3.6
26037 (for later versions, or OpenSSL, it can be either).
26038 .next
26039 The default value for &%tls_dhparam%& differs for historical reasons.
26040 .next
26041 .vindex "&$tls_in_peerdn$&"
26042 .vindex "&$tls_out_peerdn$&"
26043 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26044 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26045 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26046 .next
26047 OpenSSL identifies cipher suites using hyphens as separators, for example:
26048 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26049 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26050 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26051 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26052 to handle its own older variants) when processing lists of cipher suites in the
26053 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26054 option).
26055 .next
26056 The &%tls_require_ciphers%& options operate differently, as described in the
26057 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26058 .next
26059 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26060 When using OpenSSL, this option is ignored.
26061 (If an API is found to let OpenSSL be configured in this way,
26062 let the Exim Maintainers know and we'll likely use it).
26063 .next
26064 Some other recently added features may only be available in one or the other.
26065 This should be documented with the feature.  If the documentation does not
26066 explicitly state that the feature is infeasible in the other TLS
26067 implementation, then patches are welcome.
26068 .endlist
26069
26070
26071 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26072 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26073 an explicit path; if the latter, then the text about generation still applies,
26074 but not the chosen filename.
26075 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26076 See the documentation of &%tls_dhparam%& for more information.
26077
26078 GnuTLS uses D-H parameters that may take a substantial amount of time
26079 to compute. It is unreasonable to re-compute them for every TLS session.
26080 Therefore, Exim keeps this data in a file in its spool directory, called
26081 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26082 of bits requested.
26083 The file is owned by the Exim user and is readable only by
26084 its owner. Every Exim process that start up GnuTLS reads the D-H
26085 parameters from this file. If the file does not exist, the first Exim process
26086 that needs it computes the data and writes it to a temporary file which is
26087 renamed once it is complete. It does not matter if several Exim processes do
26088 this simultaneously (apart from wasting a few resources). Once a file is in
26089 place, new Exim processes immediately start using it.
26090
26091 For maximum security, the parameters that are stored in this file should be
26092 recalculated periodically, the frequency depending on your paranoia level.
26093 If you are avoiding using the fixed D-H primes published in RFCs, then you
26094 are concerned about some advanced attacks and will wish to do this; if you do
26095 not regenerate then you might as well stick to the standard primes.
26096
26097 Arranging this is easy in principle; just delete the file when you want new
26098 values to be computed. However, there may be a problem. The calculation of new
26099 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26100 If the system is not very active, &_/dev/random_& may delay returning data
26101 until enough randomness (entropy) is available. This may cause Exim to hang for
26102 a substantial amount of time, causing timeouts on incoming connections.
26103
26104 The solution is to generate the parameters externally to Exim. They are stored
26105 in &_gnutls-params-N_& in PEM format, which means that they can be
26106 generated externally using the &(certtool)& command that is part of GnuTLS.
26107
26108 To replace the parameters with new ones, instead of deleting the file
26109 and letting Exim re-create it, you can generate new parameters using
26110 &(certtool)& and, when this has been done, replace Exim's cache file by
26111 renaming. The relevant commands are something like this:
26112 .code
26113 # ls
26114 [ look for file; assume gnutls-params-2236 is the most recent ]
26115 # rm -f new-params
26116 # touch new-params
26117 # chown exim:exim new-params
26118 # chmod 0600 new-params
26119 # certtool --generate-dh-params --bits 2236 >>new-params
26120 # openssl dhparam -noout -text -in new-params | head
26121 [ check the first line, make sure it's not more than 2236;
26122   if it is, then go back to the start ("rm") and repeat
26123   until the size generated is at most the size requested ]
26124 # chmod 0400 new-params
26125 # mv new-params gnutls-params-2236
26126 .endd
26127 If Exim never has to generate the parameters itself, the possibility of
26128 stalling is removed.
26129
26130 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26131 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26132 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26133 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26134 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26135 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26136 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26137 which applies to all D-H usage, client or server.  If the value returned by
26138 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26139 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26140 limit, which is still much higher than Exim historically used.
26141
26142 The filename and bits used will change as the GnuTLS maintainers change the
26143 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26144 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26145 2432 bits, while NSS is limited to 2236 bits.
26146
26147 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26148 increase the chance of the generated prime actually being within acceptable
26149 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26150 procedure above.  There is no sane procedure available to Exim to double-check
26151 the size of the generated prime, so it might still be too large.
26152
26153
26154 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26155 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26156 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26157 There is a function in the OpenSSL library that can be passed a list of cipher
26158 suites before the cipher negotiation takes place. This specifies which ciphers
26159 are acceptable. The list is colon separated and may contain names like
26160 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26161 directly to this function call.
26162 Many systems will install the OpenSSL manual-pages, so you may have
26163 &'ciphers(1)'& available to you.
26164 The following quotation from the OpenSSL
26165 documentation specifies what forms of item are allowed in the cipher string:
26166
26167 .ilist
26168 It can consist of a single cipher suite such as RC4-SHA.
26169 .next
26170 It can represent a list of cipher suites containing a certain algorithm,
26171 or cipher suites of a certain type. For example SHA1 represents all
26172 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26173 SSL v3 algorithms.
26174 .next
26175 Lists of cipher suites can be combined in a single cipher string using
26176 the + character. This is used as a logical and operation. For example
26177 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26178 algorithms.
26179 .endlist
26180
26181 Each cipher string can be optionally preceded by one of the characters &`!`&,
26182 &`-`& or &`+`&.
26183 .ilist
26184 If &`!`& is used, the ciphers are permanently deleted from the list. The
26185 ciphers deleted can never reappear in the list even if they are explicitly
26186 stated.
26187 .next
26188 If &`-`& is used, the ciphers are deleted from the list, but some or all
26189 of the ciphers can be added again by later options.
26190 .next
26191 If &`+`& is used, the ciphers are moved to the end of the list. This
26192 option does not add any new ciphers; it just moves matching existing ones.
26193 .endlist
26194
26195 If none of these characters is present, the string is interpreted as
26196 a list of ciphers to be appended to the current preference list. If the list
26197 includes any ciphers already present they will be ignored: that is, they will
26198 not be moved to the end of the list.
26199 .endlist
26200
26201 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26202 string:
26203 .code
26204 # note single-quotes to get ! past any shell history expansion
26205 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26206 .endd
26207
26208 This example will let the library defaults be permitted on the MX port, where
26209 there's probably no identity verification anyway, but ups the ante on the
26210 submission ports where the administrator might have some influence on the
26211 choice of clients used:
26212 .code
26213 # OpenSSL variant; see man ciphers(1)
26214 tls_require_ciphers = ${if =={$received_port}{25}\
26215                            {DEFAULT}\
26216                            {HIGH:!MD5:!SHA1}}
26217 .endd
26218
26219
26220
26221 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26222          "SECTreqciphgnu"
26223 .cindex "GnuTLS" "specifying parameters for"
26224 .cindex "TLS" "specifying ciphers (GnuTLS)"
26225 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26226 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26227 .cindex "TLS" "specifying protocols (GnuTLS)"
26228 .cindex "TLS" "specifying priority string (GnuTLS)"
26229 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26230 The GnuTLS library allows the caller to provide a "priority string", documented
26231 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26232 ciphersuite specification in OpenSSL.
26233
26234 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26235 and controls both protocols and ciphers.
26236
26237 The &%tls_require_ciphers%& option is available both as an global option,
26238 controlling how Exim behaves as a server, and also as an option of the
26239 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26240 the value is string expanded.  The resulting string is not an Exim list and
26241 the string is given to the GnuTLS library, so that Exim does not need to be
26242 aware of future feature enhancements of GnuTLS.
26243
26244 Documentation of the strings accepted may be found in the GnuTLS manual, under
26245 "Priority strings".  This is online as
26246 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26247 but beware that this relates to GnuTLS 3, which may be newer than the version
26248 installed on your system.  If you are using GnuTLS 3,
26249 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26250 on that site can be used to test a given string.
26251
26252 For example:
26253 .code
26254 # Disable older versions of protocols
26255 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26256 .endd
26257
26258 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26259 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26260 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26261
26262 This example will let the library defaults be permitted on the MX port, where
26263 there's probably no identity verification anyway, and lowers security further
26264 by increasing compatibility; but this ups the ante on the submission ports
26265 where the administrator might have some influence on the choice of clients
26266 used:
26267 .code
26268 # GnuTLS variant
26269 tls_require_ciphers = ${if =={$received_port}{25}\
26270                            {NORMAL:%COMPAT}\
26271                            {SECURE128}}
26272 .endd
26273
26274
26275 .section "Configuring an Exim server to use TLS" "SECID182"
26276 .cindex "TLS" "configuring an Exim server"
26277 When Exim has been built with TLS support, it advertises the availability of
26278 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26279 but not to any others. The default value of this option is unset, which means
26280 that STARTTLS is not advertised at all. This default is chosen because you
26281 need to set some other options in order to make TLS available, and also it is
26282 sensible for systems that want to use TLS only as a client.
26283
26284 If a client issues a STARTTLS command and there is some configuration
26285 problem in the server, the command is rejected with a 454 error. If the client
26286 persists in trying to issue SMTP commands, all except QUIT are rejected
26287 with the error
26288 .code
26289 554 Security failure
26290 .endd
26291 If a STARTTLS command is issued within an existing TLS session, it is
26292 rejected with a 554 error code.
26293
26294 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26295 match some hosts. You can, of course, set it to * to match all hosts.
26296 However, this is not all you need to do. TLS sessions to a server won't work
26297 without some further configuration at the server end.
26298
26299 It is rumoured that all existing clients that support TLS/SSL use RSA
26300 encryption. To make this work you need to set, in the server,
26301 .code
26302 tls_certificate = /some/file/name
26303 tls_privatekey = /some/file/name
26304 .endd
26305 These options are, in fact, expanded strings, so you can make them depend on
26306 the identity of the client that is connected if you wish. The first file
26307 contains the server's X509 certificate, and the second contains the private key
26308 that goes with it. These files need to be
26309 PEM format and readable by the Exim user, and must
26310 always be given as full path names.
26311 The key must not be password-protected.
26312 They can be the same file if both the
26313 certificate and the key are contained within it. If &%tls_privatekey%& is not
26314 set, or if its expansion is forced to fail or results in an empty string, this
26315 is assumed to be the case. The certificate file may also contain intermediate
26316 certificates that need to be sent to the client to enable it to authenticate
26317 the server's certificate.
26318
26319 If you do not understand about certificates and keys, please try to find a
26320 source of this background information, which is not Exim-specific. (There are a
26321 few comments below in section &<<SECTcerandall>>&.)
26322
26323 &*Note*&: These options do not apply when Exim is operating as a client &--
26324 they apply only in the case of a server. If you need to use a certificate in an
26325 Exim client, you must set the options of the same names in an &(smtp)&
26326 transport.
26327
26328 With just these options, an Exim server will be able to use TLS. It does not
26329 require the client to have a certificate (but see below for how to insist on
26330 this). There is one other option that may be needed in other situations. If
26331 .code
26332 tls_dhparam = /some/file/name
26333 .endd
26334 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26335 with the parameters contained in the file.
26336 Set this to &`none`& to disable use of DH entirely, by making no prime
26337 available:
26338 .code
26339 tls_dhparam = none
26340 .endd
26341 This may also be set to a string identifying a standard prime to be used for
26342 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26343 used is &`ike23`&.  There are a few standard primes available, see the
26344 documentation for &%tls_dhparam%& for the complete list.
26345
26346 See the command
26347 .code
26348 openssl dhparam
26349 .endd
26350 for a way of generating file data.
26351
26352 The strings supplied for these three options are expanded every time a client
26353 host connects. It is therefore possible to use different certificates and keys
26354 for different hosts, if you so wish, by making use of the client's IP address
26355 in &$sender_host_address$& to control the expansion. If a string expansion is
26356 forced to fail, Exim behaves as if the option is not set.
26357
26358 .cindex "cipher" "logging"
26359 .cindex "log" "TLS cipher"
26360 .vindex "&$tls_in_cipher$&"
26361 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26362 an incoming TLS connection. It is included in the &'Received:'& header of an
26363 incoming message (by default &-- you can, of course, change this), and it is
26364 also included in the log line that records a message's arrival, keyed by
26365 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26366 condition can be used to test for specific cipher suites in ACLs.
26367
26368 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26369 can check the name of the cipher suite and vary their actions accordingly. The
26370 cipher suite names vary, depending on which TLS library is being used. For
26371 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26372 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26373 documentation for more details.
26374
26375 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26376 (again depending on the &%tls_cipher%& log selector).
26377
26378
26379 .section "Requesting and verifying client certificates" "SECID183"
26380 .cindex "certificate" "verification of client"
26381 .cindex "TLS" "client certificate verification"
26382 If you want an Exim server to request a certificate when negotiating a TLS
26383 session with a client, you must set either &%tls_verify_hosts%& or
26384 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26385 apply to all TLS connections. For any host that matches one of these options,
26386 Exim requests a certificate as part of the setup of the TLS session. The
26387 contents of the certificate are verified by comparing it with a list of
26388 expected certificates.
26389 These may be the system default set (depending on library version),
26390 an explicit file or,
26391 depending on library version, a directory, identified by
26392 &%tls_verify_certificates%&.
26393
26394 A file can contain multiple certificates, concatenated end to end. If a
26395 directory is used
26396 (OpenSSL only),
26397 each certificate must be in a separate file, with a name (or a symbolic link)
26398 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26399 certificate. You can compute the relevant hash by running the command
26400 .code
26401 openssl x509 -hash -noout -in /cert/file
26402 .endd
26403 where &_/cert/file_& contains a single certificate.
26404
26405 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26406 what happens if the client does not supply a certificate, or if the certificate
26407 does not match any of the certificates in the collection named by
26408 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26409 attempt to set up a TLS session is aborted, and the incoming connection is
26410 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26411 session continues. ACLs that run for subsequent SMTP commands can detect the
26412 fact that no certificate was verified, and vary their actions accordingly. For
26413 example, you can insist on a certificate before accepting a message for
26414 relaying, but not when the message is destined for local delivery.
26415
26416 .vindex "&$tls_in_peerdn$&"
26417 When a client supplies a certificate (whether it verifies or not), the value of
26418 the Distinguished Name of the certificate is made available in the variable
26419 &$tls_in_peerdn$& during subsequent processing of the message.
26420
26421 .cindex "log" "distinguished name"
26422 Because it is often a long text string, it is not included in the log line or
26423 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26424 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26425 &%received_header_text%& to change the &'Received:'& header. When no
26426 certificate is supplied, &$tls_in_peerdn$& is empty.
26427
26428
26429 .section "Revoked certificates" "SECID184"
26430 .cindex "TLS" "revoked certificates"
26431 .cindex "revocation list"
26432 .cindex "certificate" "revocation list"
26433 .cindex "OCSP" "stapling"
26434 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26435 certificates are revoked. If you have such a list, you can pass it to an Exim
26436 server using the global option called &%tls_crl%& and to an Exim client using
26437 an identically named option for the &(smtp)& transport. In each case, the value
26438 of the option is expanded and must then be the name of a file that contains a
26439 CRL in PEM format.
26440 The downside is that clients have to periodically re-download a potentially huge
26441 file from every certificate authority they know of.
26442
26443 The way with most moving parts at query time is Online Certificate
26444 Status Protocol (OCSP), where the client verifies the certificate
26445 against an OCSP server run by the CA.  This lets the CA track all
26446 usage of the certs.  It requires running software with access to the
26447 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26448 is based on HTTP and can be proxied accordingly.
26449
26450 The only widespread OCSP server implementation (known to this writer)
26451 comes as part of OpenSSL and aborts on an invalid request, such as
26452 connecting to the port and then disconnecting.  This requires
26453 re-entering the passphrase each time some random client does this.
26454
26455 The third way is OCSP Stapling; in this, the server using a certificate
26456 issued by the CA periodically requests an OCSP proof of validity from
26457 the OCSP server, then serves it up inline as part of the TLS
26458 negotiation.   This approach adds no extra round trips, does not let the
26459 CA track users, scales well with number of certs issued by the CA and is
26460 resilient to temporary OCSP server failures, as long as the server
26461 starts retrying to fetch an OCSP proof some time before its current
26462 proof expires.  The downside is that it requires server support.
26463
26464 Unless Exim is built with the support disabled,
26465 or with GnuTLS earlier than version 3.1.3,
26466 support for OCSP stapling is included.
26467
26468 There is a global option called &%tls_ocsp_file%&.
26469 The file specified therein is expected to be in DER format, and contain
26470 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26471 option will be re-expanded for SNI, if the &%tls_certificate%& option
26472 contains &`tls_in_sni`&, as per other TLS options.
26473
26474 Exim does not at this time implement any support for fetching a new OCSP
26475 proof.  The burden is on the administrator to handle this, outside of
26476 Exim.  The file specified should be replaced atomically, so that the
26477 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26478 on each connection, so a new file will be handled transparently on the
26479 next connection.
26480
26481 When built with OpenSSL Exim will check for a valid next update timestamp
26482 in the OCSP proof; if not present, or if the proof has expired, it will be
26483 ignored.
26484
26485 For the client to be able to verify the stapled OCSP the server must
26486 also supply, in its stapled information, any intermediate
26487 certificates for the chain leading to the OCSP proof from the signer
26488 of the server certificate.  There may be zero or one such. These
26489 intermediate certificates should be added to the server OCSP stapling
26490 file named by &%tls_ocsp_file%&.
26491
26492 Note that the proof only covers the terminal server certificate,
26493 not any of the chain from CA to it.
26494
26495 There is no current way to staple a proof for a client certificate.
26496
26497 .code
26498   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26499   OCSP server is supplied.  The server URL may be included in the
26500   server certificate, if the CA is helpful.
26501
26502   One failure mode seen was the OCSP Signer cert expiring before the end
26503   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26504   noted this as invalid overall, but the re-fetch script did not.
26505 .endd
26506
26507
26508
26509
26510 .section "Configuring an Exim client to use TLS" "SECID185"
26511 .cindex "cipher" "logging"
26512 .cindex "log" "TLS cipher"
26513 .cindex "log" "distinguished name"
26514 .cindex "TLS" "configuring an Exim client"
26515 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26516 deliveries as well as to incoming, the latter one causing logging of the
26517 server certificate's DN. The remaining client configuration for TLS is all
26518 within the &(smtp)& transport.
26519
26520 It is not necessary to set any options to have TLS work in the &(smtp)&
26521 transport. If Exim is built with TLS support, and TLS is advertised by a
26522 server, the &(smtp)& transport always tries to start a TLS session. However,
26523 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26524 transport) to a list of server hosts for which TLS should not be used.
26525
26526 If you do not want Exim to attempt to send messages unencrypted when an attempt
26527 to set up an encrypted connection fails in any way, you can set
26528 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26529 those hosts, delivery is always deferred if an encrypted connection cannot be
26530 set up. If there are any other hosts for the address, they are tried in the
26531 usual way.
26532
26533 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26534 the message unencrypted. It always does this if the response to STARTTLS is
26535 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26536 session after a success response code, what happens is controlled by the
26537 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26538 delivery to this host is deferred, and other hosts (if available) are tried. If
26539 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26540 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26541 negotiation fails, Exim closes the current connection (because it is in an
26542 unknown state), opens a new one to the same host, and then tries the delivery
26543 unencrypted.
26544
26545 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26546 transport provide the client with a certificate, which is passed to the server
26547 if it requests it. If the server is Exim, it will request a certificate only if
26548 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26549
26550 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26551 specifies a collection of expected server certificates.
26552 These may be the system default set (depeding on library version),
26553 a file or,
26554 depnding on liibrary version, a directory,
26555 must name a file or,
26556 for OpenSSL only (not GnuTLS), a directory.
26557 The client verifies the server's certificate
26558 against this collection, taking into account any revoked certificates that are
26559 in the list defined by &%tls_crl%&.
26560 Failure to verify fails the TLS connection unless either of the
26561 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26562
26563 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26564 certificate verification to the listed servers.  Verification either must
26565 or need not succeed respectively.
26566
26567 The &(smtp)& transport has two OCSP-related options:
26568 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26569 is requested and required for the connection to proceed.  The default
26570 value is empty.
26571 &%hosts_request_ocsp%&; a host-list for which (additionally)
26572 a Certificate Status is requested (but not necessarily verified).  The default
26573 value is "*" meaning that requests are made unless configured
26574 otherwise.
26575
26576 The host(s) should also be in &%hosts_require_tls%&, and
26577 &%tls_verify_certificates%& configured for the transport,
26578 for OCSP to be relevant.
26579
26580 If
26581 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26582 list of permitted cipher suites. If either of these checks fails, delivery to
26583 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26584 alternative hosts, if any.
26585
26586  &*Note*&:
26587 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26588 is operating as a client. Exim does not assume that a server certificate (set
26589 by the global options of the same name) should also be used when operating as a
26590 client.
26591
26592 .vindex "&$host$&"
26593 .vindex "&$host_address$&"
26594 All the TLS options in the &(smtp)& transport are expanded before use, with
26595 &$host$& and &$host_address$& containing the name and address of the server to
26596 which the client is connected. Forced failure of an expansion causes Exim to
26597 behave as if the relevant option were unset.
26598
26599 .vindex &$tls_out_bits$&
26600 .vindex &$tls_out_cipher$&
26601 .vindex &$tls_out_peerdn$&
26602 .vindex &$tls_out_sni$&
26603 Before an SMTP connection is established, the
26604 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26605 variables are emptied. (Until the first connection, they contain the values
26606 that were set when the message was received.) If STARTTLS is subsequently
26607 successfully obeyed, these variables are set to the relevant values for the
26608 outgoing connection.
26609
26610
26611
26612 .section "Use of TLS Server Name Indication" "SECTtlssni"
26613 .cindex "TLS" "Server Name Indication"
26614 .vindex "&$tls_in_sni$&"
26615 .oindex "&%tls_in_sni%&"
26616 With TLS1.0 or above, there is an extension mechanism by which extra
26617 information can be included at various points in the protocol.  One of these
26618 extensions, documented in RFC 6066 (and before that RFC 4366) is
26619 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26620 client in the initial handshake, so that the server can examine the servername
26621 within and possibly choose to use different certificates and keys (and more)
26622 for this session.
26623
26624 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26625 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26626 address.
26627
26628 With SMTP to MX, there are the same problems here as in choosing the identity
26629 against which to validate a certificate: you can't rely on insecure DNS to
26630 provide the identity which you then cryptographically verify.  So this will
26631 be of limited use in that environment.
26632
26633 With SMTP to Submission, there is a well-defined hostname which clients are
26634 connecting to and can validate certificates against.  Thus clients &*can*&
26635 choose to include this information in the TLS negotiation.  If this becomes
26636 wide-spread, then hosters can choose to present different certificates to
26637 different clients.  Or even negotiate different cipher suites.
26638
26639 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26640 if not empty, will be sent on a TLS session as part of the handshake.  There's
26641 nothing more to it.  Choosing a sensible value not derived insecurely is the
26642 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26643 for the lifetime of the client connection (including during authentication).
26644
26645 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26646 received from a client.
26647 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26648
26649 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26650 option (prior to expansion) then the following options will be re-expanded
26651 during TLS session handshake, to permit alternative values to be chosen:
26652
26653 .ilist
26654 .vindex "&%tls_certificate%&"
26655 &%tls_certificate%&
26656 .next
26657 .vindex "&%tls_crl%&"
26658 &%tls_crl%&
26659 .next
26660 .vindex "&%tls_privatekey%&"
26661 &%tls_privatekey%&
26662 .next
26663 .vindex "&%tls_verify_certificates%&"
26664 &%tls_verify_certificates%&
26665 .next
26666 .vindex "&%tls_ocsp_file%&"
26667 &%tls_verify_certificates%&
26668 .endlist
26669
26670 Great care should be taken to deal with matters of case, various injection
26671 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26672 can always be referenced; it is important to remember that &$tls_sni$& is
26673 arbitrary unverified data provided prior to authentication.
26674
26675 The Exim developers are proceeding cautiously and so far no other TLS options
26676 are re-expanded.
26677
26678 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26679 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26680 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26681 see &`-servername`& in the output, then OpenSSL has support.
26682
26683 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26684 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26685 built, then you have SNI support).
26686
26687
26688
26689 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26690          "SECTmulmessam"
26691 .cindex "multiple SMTP deliveries with TLS"
26692 .cindex "TLS" "multiple message deliveries"
26693 Exim sends multiple messages down the same TCP/IP connection by starting up
26694 an entirely new delivery process for each message, passing the socket from
26695 one process to the next. This implementation does not fit well with the use
26696 of TLS, because there is quite a lot of state information associated with a TLS
26697 connection, not just a socket identification. Passing all the state information
26698 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26699 session before passing the socket to a new process. The new process may then
26700 try to start a new TLS session, and if successful, may try to re-authenticate
26701 if AUTH is in use, before sending the next message.
26702
26703 The RFC is not clear as to whether or not an SMTP session continues in clear
26704 after TLS has been shut down, or whether TLS may be restarted again later, as
26705 just described. However, if the server is Exim, this shutdown and
26706 reinitialization works. It is not known which (if any) other servers operate
26707 successfully if the client closes a TLS session and continues with unencrypted
26708 SMTP, but there are certainly some that do not work. For such servers, Exim
26709 should not pass the socket to another process, because the failure of the
26710 subsequent attempt to use it would cause Exim to record a temporary host error,
26711 and delay other deliveries to that host.
26712
26713 To test for this case, Exim sends an EHLO command to the server after
26714 closing down the TLS session. If this fails in any way, the connection is
26715 closed instead of being passed to a new delivery process, but no retry
26716 information is recorded.
26717
26718 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26719 &(smtp)& transport to match those hosts for which Exim should not pass
26720 connections to new processes if TLS has been used.
26721
26722
26723
26724
26725 .section "Certificates and all that" "SECTcerandall"
26726 .cindex "certificate" "references to discussion"
26727 In order to understand fully how TLS works, you need to know about
26728 certificates, certificate signing, and certificate authorities. This is not the
26729 place to give a tutorial, especially as I do not know very much about it
26730 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26731 to Apache, currently at
26732 .display
26733 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26734 .endd
26735 Other parts of the &'modssl'& documentation are also helpful, and have
26736 links to further files.
26737 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26738 0-201-61598-3), contains both introductory and more in-depth descriptions.
26739 Some sample programs taken from the book are available from
26740 .display
26741 &url(http://www.rtfm.com/openssl-examples/)
26742 .endd
26743
26744
26745 .section "Certificate chains" "SECID186"
26746 The file named by &%tls_certificate%& may contain more than one
26747 certificate. This is useful in the case where the certificate that is being
26748 sent is validated by an intermediate certificate which the other end does
26749 not have. Multiple certificates must be in the correct order in the file.
26750 First the host's certificate itself, then the first intermediate
26751 certificate to validate the issuer of the host certificate, then the next
26752 intermediate certificate to validate the issuer of the first intermediate
26753 certificate, and so on, until finally (optionally) the root certificate.
26754 The root certificate must already be trusted by the recipient for
26755 validation to succeed, of course, but if it's not preinstalled, sending the
26756 root certificate along with the rest makes it available for the user to
26757 install if the receiving end is a client MUA that can interact with a user.
26758
26759 Note that certificates using MD5 are unlikely to work on today's Internet;
26760 even if your libraries allow loading them for use in Exim when acting as a
26761 server, increasingly clients will not accept such certificates.  The error
26762 diagnostics in such a case can be frustratingly vague.
26763
26764
26765
26766 .section "Self-signed certificates" "SECID187"
26767 .cindex "certificate" "self-signed"
26768 You can create a self-signed certificate using the &'req'& command provided
26769 with OpenSSL, like this:
26770 . ==== Do not shorten the duration here without reading and considering
26771 . ==== the text below.  Please leave it at 9999 days.
26772 .code
26773 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26774             -days 9999 -nodes
26775 .endd
26776 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26777 delimited and so can be identified independently. The &%-days%& option
26778 specifies a period for which the certificate is valid. The &%-nodes%& option is
26779 important: if you do not set it, the key is encrypted with a passphrase
26780 that you are prompted for, and any use that is made of the key causes more
26781 prompting for the passphrase. This is not helpful if you are going to use
26782 this certificate and key in an MTA, where prompting is not possible.
26783
26784 . ==== I expect to still be working 26 years from now.  The less technical
26785 . ==== debt I create, in terms of storing up trouble for my later years, the
26786 . ==== happier I will be then.  We really have reached the point where we
26787 . ==== should start, at the very least, provoking thought and making folks
26788 . ==== pause before proceeding, instead of leaving all the fixes until two
26789 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26790 . ==== -pdp, 2012
26791 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26792 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26793 the above command might produce a date in the past.  Think carefully about
26794 the lifetime of the systems you're deploying, and either reduce the duration
26795 of the certificate or reconsider your platform deployment.  (At time of
26796 writing, reducing the duration is the most likely choice, but the inexorable
26797 progression of time takes us steadily towards an era where this will not
26798 be a sensible resolution).
26799
26800 A self-signed certificate made in this way is sufficient for testing, and
26801 may be adequate for all your requirements if you are mainly interested in
26802 encrypting transfers, and not in secure identification.
26803
26804 However, many clients require that the certificate presented by the server be a
26805 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26806 certificate. In this situation, the self-signed certificate described above
26807 must be installed on the client host as a trusted root &'certification
26808 authority'& (CA), and the certificate used by Exim must be a user certificate
26809 signed with that self-signed certificate.
26810
26811 For information on creating self-signed CA certificates and using them to sign
26812 user certificates, see the &'General implementation overview'& chapter of the
26813 Open-source PKI book, available online at
26814 &url(http://ospkibook.sourceforge.net/).
26815 .ecindex IIDencsmtp1
26816 .ecindex IIDencsmtp2
26817
26818
26819
26820 . ////////////////////////////////////////////////////////////////////////////
26821 . ////////////////////////////////////////////////////////////////////////////
26822
26823 .chapter "Access control lists" "CHAPACL"
26824 .scindex IIDacl "&ACL;" "description"
26825 .cindex "control of incoming mail"
26826 .cindex "message" "controlling incoming"
26827 .cindex "policy control" "access control lists"
26828 Access Control Lists (ACLs) are defined in a separate section of the run time
26829 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26830 name, terminated by a colon. Here is a complete ACL section that contains just
26831 one very small ACL:
26832 .code
26833 begin acl
26834 small_acl:
26835   accept   hosts = one.host.only
26836 .endd
26837 You can have as many lists as you like in the ACL section, and the order in
26838 which they appear does not matter. The lists are self-terminating.
26839
26840 The majority of ACLs are used to control Exim's behaviour when it receives
26841 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26842 when a local process submits a message using SMTP by specifying the &%-bs%&
26843 option. The most common use is for controlling which recipients are accepted
26844 in incoming messages. In addition, you can define an ACL that is used to check
26845 local non-SMTP messages. The default configuration file contains an example of
26846 a realistic ACL for checking RCPT commands. This is discussed in chapter
26847 &<<CHAPdefconfil>>&.
26848
26849
26850 .section "Testing ACLs" "SECID188"
26851 The &%-bh%& command line option provides a way of testing your ACL
26852 configuration locally by running a fake SMTP session with which you interact.
26853 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26854 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26855
26856
26857
26858 .section "Specifying when ACLs are used" "SECID189"
26859 .cindex "&ACL;" "options for specifying"
26860 In order to cause an ACL to be used, you have to name it in one of the relevant
26861 options in the main part of the configuration. These options are:
26862 .cindex "AUTH" "ACL for"
26863 .cindex "DATA" "ACLs for"
26864 .cindex "ETRN" "ACL for"
26865 .cindex "EXPN" "ACL for"
26866 .cindex "HELO" "ACL for"
26867 .cindex "EHLO" "ACL for"
26868 .cindex "MAIL" "ACL for"
26869 .cindex "QUIT, ACL for"
26870 .cindex "RCPT" "ACL for"
26871 .cindex "STARTTLS, ACL for"
26872 .cindex "VRFY" "ACL for"
26873 .cindex "SMTP" "connection, ACL for"
26874 .cindex "non-SMTP messages" "ACLs for"
26875 .cindex "MIME content scanning" "ACL for"
26876 .cindex "PRDR" "ACL for"
26877
26878 .table2 140pt
26879 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26880 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26881 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26882 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26883 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26884 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26885 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26886 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26887 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26888 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26889 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26890 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26891 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26892 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26893 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26894 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26895 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26896 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26897 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26898 .endtable
26899
26900 For example, if you set
26901 .code
26902 acl_smtp_rcpt = small_acl
26903 .endd
26904 the little ACL defined above is used whenever Exim receives a RCPT command
26905 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26906 done when RCPT commands arrive. A rejection of RCPT should cause the
26907 sending MTA to give up on the recipient address contained in the RCPT
26908 command, whereas rejection at other times may cause the client MTA to keep on
26909 trying to deliver the message. It is therefore recommended that you do as much
26910 testing as possible at RCPT time.
26911
26912
26913 .section "The non-SMTP ACLs" "SECID190"
26914 .cindex "non-SMTP messages" "ACLs for"
26915 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26916 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26917 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26918 the state of the SMTP connection such as encryption and authentication) are not
26919 relevant and are forbidden in these ACLs. However, the sender and recipients
26920 are known, so the &%senders%& and &%sender_domains%& conditions and the
26921 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26922 &$authenticated_sender$& are also available. You can specify added header lines
26923 in any of these ACLs.
26924
26925 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26926 non-SMTP message, before any of the message has been read. (This is the
26927 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26928 batched SMTP input, it runs after the DATA command has been reached. The
26929 result of this ACL is ignored; it cannot be used to reject a message. If you
26930 really need to, you could set a value in an ACL variable here and reject based
26931 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26932 controls, and in particular, it can be used to set
26933 .code
26934 control = suppress_local_fixups
26935 .endd
26936 This cannot be used in the other non-SMTP ACLs because by the time they are
26937 run, it is too late.
26938
26939 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26940 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26941
26942 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26943 kind of rejection is treated as permanent, because there is no way of sending a
26944 temporary error for these kinds of message.
26945
26946
26947 .section "The SMTP connect ACL" "SECID191"
26948 .cindex "SMTP" "connection, ACL for"
26949 .oindex &%smtp_banner%&
26950 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26951 session, after the test specified by &%host_reject_connection%& (which is now
26952 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26953 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26954 the message override the banner message that is otherwise specified by the
26955 &%smtp_banner%& option.
26956
26957
26958 .section "The EHLO/HELO ACL" "SECID192"
26959 .cindex "EHLO" "ACL for"
26960 .cindex "HELO" "ACL for"
26961 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26962 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26963 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26964 Note that a client may issue more than one EHLO or HELO command in an SMTP
26965 session, and indeed is required to issue a new EHLO or HELO after successfully
26966 setting up encryption following a STARTTLS command.
26967
26968 If the command is accepted by an &%accept%& verb that has a &%message%&
26969 modifier, the message may not contain more than one line (it will be truncated
26970 at the first newline and a panic logged if it does). Such a message cannot
26971 affect the EHLO options that are listed on the second and subsequent lines of
26972 an EHLO response.
26973
26974
26975 .section "The DATA ACLs" "SECID193"
26976 .cindex "DATA" "ACLs for"
26977 Two ACLs are associated with the DATA command, because it is two-stage
26978 command, with two responses being sent to the client.
26979 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26980 is obeyed. This gives you control after all the RCPT commands, but before
26981 the message itself is received. It offers the opportunity to give a negative
26982 response to the DATA command before the data is transmitted. Header lines
26983 added by MAIL or RCPT ACLs are not visible at this time, but any that
26984 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26985
26986 You cannot test the contents of the message, for example, to verify addresses
26987 in the headers, at RCPT time or when the DATA command is received. Such
26988 tests have to appear in the ACL that is run after the message itself has been
26989 received, before the final response to the DATA command is sent. This is
26990 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26991 associated with the DATA command.
26992
26993 For both of these ACLs, it is not possible to reject individual recipients. An
26994 error response rejects the entire message. Unfortunately, it is known that some
26995 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26996 before or after the data) correctly &-- they keep the message on their queues
26997 and try again later, but that is their problem, though it does waste some of
26998 your resources.
26999
27000 The &%acl_smtp_data%& ACL is run after
27001 the &%acl_smtp_data_prdr%&,
27002 the &%acl_smtp_dkim%&
27003 and the &%acl_smtp_mime%& ACLs.
27004
27005 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27006 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27007 enabled (which is the default).
27008
27009 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27010 received, and is executed for each DKIM signature found in a message.  If not
27011 otherwise specified, the default action is to accept.
27012
27013 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27014
27015 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27016
27017
27018 .section "The SMTP MIME ACL" "SECID194"
27019 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27020 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27021
27022 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27023
27024
27025 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27026 .cindex "PRDR" "ACL for"
27027 .oindex "&%prdr_enable%&"
27028 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27029 with PRDR support enabled (which is the default).
27030 It becomes active only when the PRDR feature is negotiated between
27031 client and server for a message, and more than one recipient
27032 has been accepted.
27033
27034 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27035 has been recieved, and is executed once for each recipient of the message
27036 with &$local_part$& and &$domain$& valid.
27037 The test may accept, defer or deny for inividual recipients.
27038 The &%acl_smtp_data%& will still be called after this ACL and
27039 can reject the message overall, even if this ACL has accepted it
27040 for some or all recipients.
27041
27042 PRDR may be used to support per-user content filtering.  Without it
27043 one must defer any recipient after the first that has a different
27044 content-filter configuration.  With PRDR, the RCPT-time check
27045 for this can be disabled when the MAIL-time $smtp_command included
27046 "PRDR".  Any required difference in behaviour of the main DATA-time
27047 ACL should however depend on the PRDR-time ACL having run, as Exim
27048 will avoid doing so in some situations (eg.  single-recipient mails).
27049
27050 See also the &%prdr_enable%& global option
27051 and the &%hosts_try_prdr%& smtp transport option.
27052
27053 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27054 If the ACL is not defined, processing completes as if
27055 the feature was not requested by the client.
27056
27057 .section "The QUIT ACL" "SECTQUITACL"
27058 .cindex "QUIT, ACL for"
27059 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27060 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27061 does not in fact control any access. For this reason, the only verbs that are
27062 permitted are &%accept%& and &%warn%&.
27063
27064 This ACL can be used for tasks such as custom logging at the end of an SMTP
27065 session. For example, you can use ACL variables in other ACLs to count
27066 messages, recipients, etc., and log the totals at QUIT time using one or
27067 more &%logwrite%& modifiers on a &%warn%& verb.
27068
27069 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27070 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27071
27072 You do not need to have a final &%accept%&, but if you do, you can use a
27073 &%message%& modifier to specify custom text that is sent as part of the 221
27074 response to QUIT.
27075
27076 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27077 failure (for example, failure to open a log file, or when Exim is bombing out
27078 because it has detected an unrecoverable error), all SMTP commands from the
27079 client are given temporary error responses until QUIT is received or the
27080 connection is closed. In these special cases, the QUIT ACL does not run.
27081
27082
27083 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27084 .vindex &$acl_smtp_notquit$&
27085 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27086 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27087 trouble, such as being unable to write to its log files, this ACL is not run,
27088 because it might try to do things (such as write to log files) that make the
27089 situation even worse.
27090
27091 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27092 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27093 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27094 and &%warn%&.
27095
27096 .vindex &$smtp_notquit_reason$&
27097 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27098 to a string that indicates the reason for the termination of the SMTP
27099 connection. The possible values are:
27100 .table2
27101 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27102 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27103 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27104 .irow &`connection-lost`&          "The SMTP connection has been lost"
27105 .irow &`data-timeout`&             "Timeout while reading message data"
27106 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27107 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27108 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27109 .irow &`synchronization-error`&    "SMTP synchronization error"
27110 .irow &`tls-failed`&               "TLS failed to start"
27111 .endtable
27112 In most cases when an SMTP connection is closed without having received QUIT,
27113 Exim sends an SMTP response message before actually closing the connection.
27114 With the exception of the &`acl-drop`& case, the default message can be
27115 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27116 &%drop%& verb in another ACL, it is the message from the other ACL that is
27117 used.
27118
27119
27120 .section "Finding an ACL to use" "SECID195"
27121 .cindex "&ACL;" "finding which to use"
27122 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27123 you can use different ACLs in different circumstances. For example,
27124 .code
27125 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27126                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27127 .endd
27128 In the default configuration file there are some example settings for
27129 providing an RFC 4409 message submission service on port 587 and a
27130 non-standard &"smtps"& service on port 465. You can use a string
27131 expansion like this to choose an ACL for MUAs on these ports which is
27132 more appropriate for this purpose than the default ACL on port 25.
27133
27134 The expanded string does not have to be the name of an ACL in the
27135 configuration file; there are other possibilities. Having expanded the
27136 string, Exim searches for an ACL as follows:
27137
27138 .ilist
27139 If the string begins with a slash, Exim uses it as a file name, and reads its
27140 contents as an ACL. The lines are processed in the same way as lines in the
27141 Exim configuration file. In particular, continuation lines are supported, blank
27142 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27143 If the file does not exist or cannot be read, an error occurs (typically
27144 causing a temporary failure of whatever caused the ACL to be run). For example:
27145 .code
27146 acl_smtp_data = /etc/acls/\
27147   ${lookup{$sender_host_address}lsearch\
27148   {/etc/acllist}{$value}{default}}
27149 .endd
27150 This looks up an ACL file to use on the basis of the host's IP address, falling
27151 back to a default if the lookup fails. If an ACL is successfully read from a
27152 file, it is retained in memory for the duration of the Exim process, so that it
27153 can be re-used without having to re-read the file.
27154 .next
27155 If the string does not start with a slash, and does not contain any spaces,
27156 Exim searches the ACL section of the configuration for an ACL whose name
27157 matches the string.
27158 .next
27159 If no named ACL is found, or if the string contains spaces, Exim parses
27160 the string as an inline ACL. This can save typing in cases where you just
27161 want to have something like
27162 .code
27163 acl_smtp_vrfy = accept
27164 .endd
27165 in order to allow free use of the VRFY command. Such a string may contain
27166 newlines; it is processed in the same way as an ACL that is read from a file.
27167 .endlist
27168
27169
27170
27171
27172 .section "ACL return codes" "SECID196"
27173 .cindex "&ACL;" "return codes"
27174 Except for the QUIT ACL, which does not affect the SMTP return code (see
27175 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27176 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27177 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27178 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27179 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27180 This also causes a 4&'xx'& return code.
27181
27182 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27183 &"deny"&, because there is no mechanism for passing temporary errors to the
27184 submitters of non-SMTP messages.
27185
27186
27187 ACLs that are relevant to message reception may also return &"discard"&. This
27188 has the effect of &"accept"&, but causes either the entire message or an
27189 individual recipient address to be discarded. In other words, it is a
27190 blackholing facility. Use it with care.
27191
27192 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27193 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27194 RCPT ACL is to discard just the one recipient address. If there are no
27195 recipients left when the message's data is received, the DATA ACL is not
27196 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27197 remaining recipients. The &"discard"& return is not permitted for the
27198 &%acl_smtp_predata%& ACL.
27199
27200
27201 .cindex "&[local_scan()]& function" "when all recipients discarded"
27202 The &[local_scan()]& function is always run, even if there are no remaining
27203 recipients; it may create new recipients.
27204
27205
27206
27207 .section "Unset ACL options" "SECID197"
27208 .cindex "&ACL;" "unset options"
27209 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27210 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27211 not defined at all. For any defined ACL, the default action when control
27212 reaches the end of the ACL statements is &"deny"&.
27213
27214 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27215 these two are ACLs that are used only for their side effects. They cannot be
27216 used to accept or reject anything.
27217
27218 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27219 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27220 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27221 when the ACL is not defined is &"accept"&.
27222
27223 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27224 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27225 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27226 messages over an SMTP connection. For an example, see the ACL in the default
27227 configuration file.
27228
27229
27230
27231
27232 .section "Data for message ACLs" "SECID198"
27233 .cindex "&ACL;" "data for message ACL"
27234 .vindex &$domain$&
27235 .vindex &$local_part$&
27236 .vindex &$sender_address$&
27237 .vindex &$sender_host_address$&
27238 .vindex &$smtp_command$&
27239 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27240 that contain information about the host and the message's sender (for example,
27241 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27242 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27243 &$local_part$& are set from the argument address. The entire SMTP command
27244 is available in &$smtp_command$&.
27245
27246 When an ACL for the AUTH parameter of MAIL is running, the variables that
27247 contain information about the host are set, but &$sender_address$& is not yet
27248 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27249 how it is used.
27250
27251 .vindex "&$message_size$&"
27252 The &$message_size$& variable is set to the value of the SIZE parameter on
27253 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27254 that parameter is not given. The value is updated to the true message size by
27255 the time the final DATA ACL is run (after the message data has been
27256 received).
27257
27258 .vindex "&$rcpt_count$&"
27259 .vindex "&$recipients_count$&"
27260 The &$rcpt_count$& variable increases by one for each RCPT command received.
27261 The &$recipients_count$& variable increases by one each time a RCPT command is
27262 accepted, so while an ACL for RCPT is being processed, it contains the number
27263 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27264 &$rcpt_count$& contains the total number of RCPT commands, and
27265 &$recipients_count$& contains the total number of accepted recipients.
27266
27267
27268
27269
27270
27271 .section "Data for non-message ACLs" "SECTdatfornon"
27272 .cindex "&ACL;" "data for non-message ACL"
27273 .vindex &$smtp_command_argument$&
27274 .vindex &$smtp_command$&
27275 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27276 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27277 and the entire SMTP command is available in &$smtp_command$&.
27278 These variables can be tested using a &%condition%& condition. For example,
27279 here is an ACL for use with AUTH, which insists that either the session is
27280 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27281 does not permit authentication methods that use cleartext passwords on
27282 unencrypted connections.
27283 .code
27284 acl_check_auth:
27285   accept encrypted = *
27286   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27287                      {CRAM-MD5}}
27288   deny   message   = TLS encryption or CRAM-MD5 required
27289 .endd
27290 (Another way of applying this restriction is to arrange for the authenticators
27291 that use cleartext passwords not to be advertised when the connection is not
27292 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27293 option to do this.)
27294
27295
27296
27297 .section "Format of an ACL" "SECID199"
27298 .cindex "&ACL;" "format of"
27299 .cindex "&ACL;" "verbs, definition of"
27300 An individual ACL consists of a number of statements. Each statement starts
27301 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27302 Modifiers can change the way the verb operates, define error and log messages,
27303 set variables, insert delays, and vary the processing of accepted messages.
27304
27305 If all the conditions are met, the verb is obeyed. The same condition may be
27306 used (with different arguments) more than once in the same statement. This
27307 provides a means of specifying an &"and"& conjunction between conditions. For
27308 example:
27309 .code
27310 deny  dnslists = list1.example
27311 dnslists = list2.example
27312 .endd
27313 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27314 the conditions and modifiers when it reaches a condition that fails. What
27315 happens then depends on the verb (and in one case, on a special modifier). Not
27316 all the conditions make sense at every testing point. For example, you cannot
27317 test a sender address in the ACL that is run for a VRFY command.
27318
27319
27320 .section "ACL verbs" "SECID200"
27321 The ACL verbs are as follows:
27322
27323 .ilist
27324 .cindex "&%accept%& ACL verb"
27325 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27326 of the conditions are not met, what happens depends on whether &%endpass%&
27327 appears among the conditions (for syntax see below). If the failing condition
27328 is before &%endpass%&, control is passed to the next ACL statement; if it is
27329 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27330 check a RCPT command:
27331 .code
27332 accept domains = +local_domains
27333 endpass
27334 verify = recipient
27335 .endd
27336 If the recipient domain does not match the &%domains%& condition, control
27337 passes to the next statement. If it does match, the recipient is verified, and
27338 the command is accepted if verification succeeds. However, if verification
27339 fails, the ACL yields &"deny"&, because the failing condition is after
27340 &%endpass%&.
27341
27342 The &%endpass%& feature has turned out to be confusing to many people, so its
27343 use is not recommended nowadays. It is always possible to rewrite an ACL so
27344 that &%endpass%& is not needed, and it is no longer used in the default
27345 configuration.
27346
27347 .cindex "&%message%& ACL modifier" "with &%accept%&"
27348 If a &%message%& modifier appears on an &%accept%& statement, its action
27349 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27350 (when an &%accept%& verb either accepts or passes control to the next
27351 statement), &%message%& can be used to vary the message that is sent when an
27352 SMTP command is accepted. For example, in a RCPT ACL you could have:
27353 .display
27354 &`accept  `&<&'some conditions'&>
27355 &`        message = OK, I will allow you through today`&
27356 .endd
27357 You can specify an SMTP response code, optionally followed by an &"extended
27358 response code"& at the start of the message, but the first digit must be the
27359 same as would be sent by default, which is 2 for an &%accept%& verb.
27360
27361 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27362 an error message that is used when access is denied. This behaviour is retained
27363 for backward compatibility, but current &"best practice"& is to avoid the use
27364 of &%endpass%&.
27365
27366
27367 .next
27368 .cindex "&%defer%& ACL verb"
27369 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27370 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27371 &%defer%& is the same as &%deny%&, because there is no way of sending a
27372 temporary error. For a RCPT command, &%defer%& is much the same as using a
27373 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27374 be used in any ACL, and even for a recipient it might be a simpler approach.
27375
27376
27377 .next
27378 .cindex "&%deny%& ACL verb"
27379 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27380 the conditions are not met, control is passed to the next ACL statement. For
27381 example,
27382 .code
27383 deny dnslists = blackholes.mail-abuse.org
27384 .endd
27385 rejects commands from hosts that are on a DNS black list.
27386
27387
27388 .next
27389 .cindex "&%discard%& ACL verb"
27390 &%discard%&: This verb behaves like &%accept%&, except that it returns
27391 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27392 that are concerned with receiving messages. When all the conditions are true,
27393 the sending entity receives a &"success"& response. However, &%discard%& causes
27394 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27395 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27396 message's recipients are discarded. Recipients that are discarded before DATA
27397 do not appear in the log line when the &%received_recipients%& log selector is set.
27398
27399 If the &%log_message%& modifier is set when &%discard%& operates,
27400 its contents are added to the line that is automatically written to the log.
27401 The &%message%& modifier operates exactly as it does for &%accept%&.
27402
27403
27404 .next
27405 .cindex "&%drop%& ACL verb"
27406 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27407 forcibly closed after the 5&'xx'& error message has been sent. For example:
27408 .code
27409 drop   message   = I don't take more than 20 RCPTs
27410        condition = ${if > {$rcpt_count}{20}}
27411 .endd
27412 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27413 The connection is always dropped after sending a 550 response.
27414
27415 .next
27416 .cindex "&%require%& ACL verb"
27417 &%require%&: If all the conditions are met, control is passed to the next ACL
27418 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27419 example, when checking a RCPT command,
27420 .code
27421 require message = Sender did not verify
27422         verify  = sender
27423 .endd
27424 passes control to subsequent statements only if the message's sender can be
27425 verified. Otherwise, it rejects the command. Note the positioning of the
27426 &%message%& modifier, before the &%verify%& condition. The reason for this is
27427 discussed in section &<<SECTcondmodproc>>&.
27428
27429 .next
27430 .cindex "&%warn%& ACL verb"
27431 &%warn%&: If all the conditions are true, a line specified by the
27432 &%log_message%& modifier is written to Exim's main log. Control always passes
27433 to the next ACL statement. If any condition is false, the log line is not
27434 written. If an identical log line is requested several times in the same
27435 message, only one copy is actually written to the log. If you want to force
27436 duplicates to be written, use the &%logwrite%& modifier instead.
27437
27438 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27439 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27440 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27441 first failing condition. There is more about adding header lines in section
27442 &<<SECTaddheadacl>>&.
27443
27444 If any condition on a &%warn%& statement cannot be completed (that is, there is
27445 some sort of defer), the log line specified by &%log_message%& is not written.
27446 This does not include the case of a forced failure from a lookup, which
27447 is considered to be a successful completion. After a defer, no further
27448 conditions or modifiers in the &%warn%& statement are processed. The incident
27449 is logged, and the ACL continues to be processed, from the next statement
27450 onwards.
27451
27452
27453 .vindex "&$acl_verify_message$&"
27454 When one of the &%warn%& conditions is an address verification that fails, the
27455 text of the verification failure message is in &$acl_verify_message$&. If you
27456 want this logged, you must set it up explicitly. For example:
27457 .code
27458 warn   !verify = sender
27459        log_message = sender verify failed: $acl_verify_message
27460 .endd
27461 .endlist
27462
27463 At the end of each ACL there is an implicit unconditional &%deny%&.
27464
27465 As you can see from the examples above, the conditions and modifiers are
27466 written one to a line, with the first one on the same line as the verb, and
27467 subsequent ones on following lines. If you have a very long condition, you can
27468 continue it onto several physical lines by the usual backslash continuation
27469 mechanism. It is conventional to align the conditions vertically.
27470
27471
27472
27473 .section "ACL variables" "SECTaclvariables"
27474 .cindex "&ACL;" "variables"
27475 There are some special variables that can be set during ACL processing. They
27476 can be used to pass information between different ACLs, different invocations
27477 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27478 transports, and filters that are used to deliver a message. The names of these
27479 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27480 an underscore, but the remainder of the name can be any sequence of
27481 alphanumeric characters and underscores that you choose. There is no limit on
27482 the number of ACL variables. The two sets act as follows:
27483 .ilist
27484 The values of those variables whose names begin with &$acl_c$& persist
27485 throughout an SMTP connection. They are never reset. Thus, a value that is set
27486 while receiving one message is still available when receiving the next message
27487 on the same SMTP connection.
27488 .next
27489 The values of those variables whose names begin with &$acl_m$& persist only
27490 while a message is being received. They are reset afterwards. They are also
27491 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27492 .endlist
27493
27494 When a message is accepted, the current values of all the ACL variables are
27495 preserved with the message and are subsequently made available at delivery
27496 time. The ACL variables are set by a modifier called &%set%&. For example:
27497 .code
27498 accept hosts = whatever
27499        set acl_m4 = some value
27500 accept authenticated = *
27501        set acl_c_auth = yes
27502 .endd
27503 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27504 be set. If you want to set a variable without taking any action, you can use a
27505 &%warn%& verb without any other modifiers or conditions.
27506
27507 .oindex &%strict_acl_vars%&
27508 What happens if a syntactically valid but undefined ACL variable is
27509 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27510 false (the default), an empty string is substituted; if it is true, an
27511 error is generated.
27512
27513 Versions of Exim before 4.64 have a limited set of numbered variables, but
27514 their names are compatible, so there is no problem with upgrading.
27515
27516
27517 .section "Condition and modifier processing" "SECTcondmodproc"
27518 .cindex "&ACL;" "conditions; processing"
27519 .cindex "&ACL;" "modifiers; processing"
27520 An exclamation mark preceding a condition negates its result. For example:
27521 .code
27522 deny   domains = *.dom.example
27523       !verify  = recipient
27524 .endd
27525 causes the ACL to return &"deny"& if the recipient domain ends in
27526 &'dom.example'& and the recipient address cannot be verified. Sometimes
27527 negation can be used on the right-hand side of a condition. For example, these
27528 two statements are equivalent:
27529 .code
27530 deny  hosts = !192.168.3.4
27531 deny !hosts =  192.168.3.4
27532 .endd
27533 However, for many conditions (&%verify%& being a good example), only left-hand
27534 side negation of the whole condition is possible.
27535
27536 The arguments of conditions and modifiers are expanded. A forced failure
27537 of an expansion causes a condition to be ignored, that is, it behaves as if the
27538 condition is true. Consider these two statements:
27539 .code
27540 accept  senders = ${lookup{$host_name}lsearch\
27541                   {/some/file}{$value}fail}
27542 accept  senders = ${lookup{$host_name}lsearch\
27543                   {/some/file}{$value}{}}
27544 .endd
27545 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27546 the returned list is searched, but if the lookup fails the behaviour is
27547 different in the two cases. The &%fail%& in the first statement causes the
27548 condition to be ignored, leaving no further conditions. The &%accept%& verb
27549 therefore succeeds. The second statement, however, generates an empty list when
27550 the lookup fails. No sender can match an empty list, so the condition fails,
27551 and therefore the &%accept%& also fails.
27552
27553 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27554 specify actions that are taken as the conditions for a statement are checked;
27555 others specify text for messages that are used when access is denied or a
27556 warning is generated. The &%control%& modifier affects the way an incoming
27557 message is handled.
27558
27559 The positioning of the modifiers in an ACL statement is important, because the
27560 processing of a verb ceases as soon as its outcome is known. Only those
27561 modifiers that have already been encountered will take effect. For example,
27562 consider this use of the &%message%& modifier:
27563 .code
27564 require message = Can't verify sender
27565         verify  = sender
27566         message = Can't verify recipient
27567         verify  = recipient
27568         message = This message cannot be used
27569 .endd
27570 If sender verification fails, Exim knows that the result of the statement is
27571 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27572 so its text is used as the error message. If sender verification succeeds, but
27573 recipient verification fails, the second message is used. If recipient
27574 verification succeeds, the third message becomes &"current"&, but is never used
27575 because there are no more conditions to cause failure.
27576
27577 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27578 modifier that is used, because all the conditions must be true for rejection to
27579 happen. Specifying more than one &%message%& modifier does not make sense, and
27580 the message can even be specified after all the conditions. For example:
27581 .code
27582 deny   hosts = ...
27583       !senders = *@my.domain.example
27584        message = Invalid sender from client host
27585 .endd
27586 The &"deny"& result does not happen until the end of the statement is reached,
27587 by which time Exim has set up the message.
27588
27589
27590
27591 .section "ACL modifiers" "SECTACLmodi"
27592 .cindex "&ACL;" "modifiers; list of"
27593 The ACL modifiers are as follows:
27594
27595 .vlist
27596 .vitem &*add_header*&&~=&~<&'text'&>
27597 This modifier specifies one or more header lines that are to be added to an
27598 incoming message, assuming, of course, that the message is ultimately
27599 accepted. For details, see section &<<SECTaddheadacl>>&.
27600
27601 .vitem &*continue*&&~=&~<&'text'&>
27602 .cindex "&%continue%& ACL modifier"
27603 .cindex "database" "updating in ACL"
27604 This modifier does nothing of itself, and processing of the ACL always
27605 continues with the next condition or modifier. The value of &%continue%& is in
27606 the side effects of expanding its argument. Typically this could be used to
27607 update a database. It is really just a syntactic tidiness, to avoid having to
27608 write rather ugly lines like this:
27609 .display
27610 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27611 .endd
27612 Instead, all you need is
27613 .display
27614 &`continue = `&<&'some expansion'&>
27615 .endd
27616
27617 .vitem &*control*&&~=&~<&'text'&>
27618 .cindex "&%control%& ACL modifier"
27619 This modifier affects the subsequent processing of the SMTP connection or of an
27620 incoming message that is accepted. The effect of the first type of control
27621 lasts for the duration of the connection, whereas the effect of the second type
27622 lasts only until the current message has been received. The message-specific
27623 controls always apply to the whole message, not to individual recipients,
27624 even if the &%control%& modifier appears in a RCPT ACL.
27625
27626 As there are now quite a few controls that can be applied, they are described
27627 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27628 in several different ways. For example:
27629
27630 . ==== As this is a nested list, any displays it contains must be indented
27631 . ==== as otherwise they are too far to the left. That comment applies only
27632 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27633 . ==== way.
27634
27635 .ilist
27636 It can be at the end of an &%accept%& statement:
27637 .code
27638     accept  ...some conditions
27639             control = queue_only
27640 .endd
27641 In this case, the control is applied when this statement yields &"accept"&, in
27642 other words, when the conditions are all true.
27643
27644 .next
27645 It can be in the middle of an &%accept%& statement:
27646 .code
27647     accept  ...some conditions...
27648             control = queue_only
27649             ...some more conditions...
27650 .endd
27651 If the first set of conditions are true, the control is applied, even if the
27652 statement does not accept because one of the second set of conditions is false.
27653 In this case, some subsequent statement must yield &"accept"& for the control
27654 to be relevant.
27655
27656 .next
27657 It can be used with &%warn%& to apply the control, leaving the
27658 decision about accepting or denying to a subsequent verb. For
27659 example:
27660 .code
27661     warn    ...some conditions...
27662             control = freeze
27663     accept  ...
27664 .endd
27665 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27666 &%logwrite%&, so it does not add anything to the message and does not write a
27667 log entry.
27668
27669 .next
27670 If you want to apply a control unconditionally, you can use it with a
27671 &%require%& verb. For example:
27672 .code
27673     require  control = no_multiline_responses
27674 .endd
27675 .endlist
27676
27677 .vitem &*delay*&&~=&~<&'time'&>
27678 .cindex "&%delay%& ACL modifier"
27679 .oindex "&%-bh%&"
27680 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27681 the time interval before proceeding. However, when testing Exim using the
27682 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27683 output instead). The time is given in the usual Exim notation, and the delay
27684 happens as soon as the modifier is processed. In an SMTP session, pending
27685 output is flushed before the delay is imposed.
27686
27687 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27688 example:
27689 .code
27690 deny    ...some conditions...
27691         delay = 30s
27692 .endd
27693 The delay happens if all the conditions are true, before the statement returns
27694 &"deny"&. Compare this with:
27695 .code
27696 deny    delay = 30s
27697         ...some conditions...
27698 .endd
27699 which waits for 30s before processing the conditions. The &%delay%& modifier
27700 can also be used with &%warn%& and together with &%control%&:
27701 .code
27702 warn    ...some conditions...
27703         delay = 2m
27704         control = freeze
27705 accept  ...
27706 .endd
27707
27708 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27709 responses to several commands are no longer buffered and sent in one packet (as
27710 they would normally be) because all output is flushed before imposing the
27711 delay. This optimization is disabled so that a number of small delays do not
27712 appear to the client as one large aggregated delay that might provoke an
27713 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27714 using a &%control%& modifier to set &%no_delay_flush%&.
27715
27716
27717 .vitem &*endpass*&
27718 .cindex "&%endpass%& ACL modifier"
27719 This modifier, which has no argument, is recognized only in &%accept%& and
27720 &%discard%& statements. It marks the boundary between the conditions whose
27721 failure causes control to pass to the next statement, and the conditions whose
27722 failure causes the ACL to return &"deny"&. This concept has proved to be
27723 confusing to some people, so the use of &%endpass%& is no longer recommended as
27724 &"best practice"&. See the description of &%accept%& above for more details.
27725
27726
27727 .vitem &*log_message*&&~=&~<&'text'&>
27728 .cindex "&%log_message%& ACL modifier"
27729 This modifier sets up a message that is used as part of the log message if the
27730 ACL denies access or a &%warn%& statement's conditions are true. For example:
27731 .code
27732 require log_message = wrong cipher suite $tls_in_cipher
27733         encrypted   = DES-CBC3-SHA
27734 .endd
27735 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27736 example:
27737 .display
27738 &`discard `&<&'some conditions'&>
27739 &`        log_message = Discarded $local_part@$domain because...`&
27740 .endd
27741 When access is denied, &%log_message%& adds to any underlying error message
27742 that may exist because of a condition failure. For example, while verifying a
27743 recipient address, a &':fail:'& redirection might have already set up a
27744 message.
27745
27746 The message may be defined before the conditions to which it applies, because
27747 the string expansion does not happen until Exim decides that access is to be
27748 denied. This means that any variables that are set by the condition are
27749 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27750 variables are set after a DNS black list lookup succeeds. If the expansion of
27751 &%log_message%& fails, or if the result is an empty string, the modifier is
27752 ignored.
27753
27754 .vindex "&$acl_verify_message$&"
27755 If you want to use a &%warn%& statement to log the result of an address
27756 verification, you can use &$acl_verify_message$& to include the verification
27757 error message.
27758
27759 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27760 the start of the logged message. If the same warning log message is requested
27761 more than once while receiving  a single email message, only one copy is
27762 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27763 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27764 is logged for a successful &%warn%& statement.
27765
27766 If &%log_message%& is not present and there is no underlying error message (for
27767 example, from the failure of address verification), but &%message%& is present,
27768 the &%message%& text is used for logging rejections. However, if any text for
27769 logging contains newlines, only the first line is logged. In the absence of
27770 both &%log_message%& and &%message%&, a default built-in message is used for
27771 logging rejections.
27772
27773
27774 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27775 .cindex "&%log_reject_target%& ACL modifier"
27776 .cindex "logging in ACL" "specifying which log"
27777 This modifier makes it possible to specify which logs are used for messages
27778 about ACL rejections. Its argument is a colon-separated list of words that can
27779 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27780 may be empty, in which case a rejection is not logged at all. For example, this
27781 ACL fragment writes no logging information when access is denied:
27782 .display
27783 &`deny `&<&'some conditions'&>
27784 &`     log_reject_target =`&
27785 .endd
27786 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27787 permanent and temporary rejections. Its effect lasts for the rest of the
27788 current ACL.
27789
27790
27791 .vitem &*logwrite*&&~=&~<&'text'&>
27792 .cindex "&%logwrite%& ACL modifier"
27793 .cindex "logging in ACL" "immediate"
27794 This modifier writes a message to a log file as soon as it is encountered when
27795 processing an ACL. (Compare &%log_message%&, which, except in the case of
27796 &%warn%& and &%discard%&, is used only if the ACL statement denies
27797 access.) The &%logwrite%& modifier can be used to log special incidents in
27798 ACLs. For example:
27799 .display
27800 &`accept `&<&'some special conditions'&>
27801 &`       control  = freeze`&
27802 &`       logwrite = froze message because ...`&
27803 .endd
27804 By default, the message is written to the main log. However, it may begin
27805 with a colon, followed by a comma-separated list of log names, and then
27806 another colon, to specify exactly which logs are to be written. For
27807 example:
27808 .code
27809 logwrite = :main,reject: text for main and reject logs
27810 logwrite = :panic: text for panic log only
27811 .endd
27812
27813
27814 .vitem &*message*&&~=&~<&'text'&>
27815 .cindex "&%message%& ACL modifier"
27816 This modifier sets up a text string that is expanded and used as a response
27817 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27818 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27819 there is some complication if &%endpass%& is involved; see the description of
27820 &%accept%& for details.)
27821
27822 The expansion of the message happens at the time Exim decides that the ACL is
27823 to end, not at the time it processes &%message%&. If the expansion fails, or
27824 generates an empty string, the modifier is ignored. Here is an example where
27825 &%message%& must be specified first, because the ACL ends with a rejection if
27826 the &%hosts%& condition fails:
27827 .code
27828 require  message = Host not recognized
27829          hosts = 10.0.0.0/8
27830 .endd
27831 (Once a condition has failed, no further conditions or modifiers are
27832 processed.)
27833
27834 .cindex "SMTP" "error codes"
27835 .oindex "&%smtp_banner%&
27836 For ACLs that are triggered by SMTP commands, the message is returned as part
27837 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27838 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27839 is accepted. In the case of the connect ACL, accepting with a message modifier
27840 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27841 accept message may not contain more than one line (otherwise it will be
27842 truncated at the first newline and a panic logged), and it cannot affect the
27843 EHLO options.
27844
27845 When SMTP is involved, the message may begin with an overriding response code,
27846 consisting of three digits optionally followed by an &"extended response code"&
27847 of the form &'n.n.n'&, each code being followed by a space. For example:
27848 .code
27849 deny  message = 599 1.2.3 Host not welcome
27850       hosts = 192.168.34.0/24
27851 .endd
27852 The first digit of the supplied response code must be the same as would be sent
27853 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27854 access, but for the predata ACL, note that the default success code is 354, not
27855 2&'xx'&.
27856
27857 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27858 the message modifier cannot override the 221 response code.
27859
27860 The text in a &%message%& modifier is literal; any quotes are taken as
27861 literals, but because the string is expanded, backslash escapes are processed
27862 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27863 response.
27864
27865 .vindex "&$acl_verify_message$&"
27866 .new
27867 For ACLs that are called by an &%acl =%& ACL condition, the message is
27868 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27869 .wen
27870
27871 If &%message%& is used on a statement that verifies an address, the message
27872 specified overrides any message that is generated by the verification process.
27873 However, the original message is available in the variable
27874 &$acl_verify_message$&, so you can incorporate it into your message if you
27875 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27876 routers to be passed back as part of the SMTP response, you should either not
27877 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27878
27879 For compatibility with previous releases of Exim, a &%message%& modifier that
27880 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27881 modifier, but this usage is now deprecated. However, &%message%& acts only when
27882 all the conditions are true, wherever it appears in an ACL command, whereas
27883 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27884 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27885 effect.
27886
27887
27888 .vitem &*remove_header*&&~=&~<&'text'&>
27889 This modifier specifies one or more header names in a colon-separated list
27890  that are to be removed from an incoming message, assuming, of course, that
27891 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27892
27893
27894 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27895 .cindex "&%set%& ACL modifier"
27896 This modifier puts a value into one of the ACL variables (see section
27897 &<<SECTaclvariables>>&).
27898
27899
27900 .vitem &*udpsend*&&~=&~<&'parameters'&>
27901 This modifier sends a UDP packet, for purposes such as statistics
27902 collection or behaviour monitoring. The parameters are expanded, and
27903 the result of the expansion must be a colon-separated list consisting
27904 of a destination server, port number, and the packet contents. The
27905 server can be specified as a host name or IPv4 or IPv6 address. The
27906 separator can be changed with the usual angle bracket syntax. For
27907 example, you might want to collect information on which hosts connect
27908 when:
27909 .code
27910 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27911              $tod_zulu $sender_host_address
27912 .endd
27913 .endlist
27914
27915
27916
27917
27918 .section "Use of the control modifier" "SECTcontrols"
27919 .cindex "&%control%& ACL modifier"
27920 The &%control%& modifier supports the following settings:
27921
27922 .vlist
27923 .vitem &*control&~=&~allow_auth_unadvertised*&
27924 This modifier allows a client host to use the SMTP AUTH command even when it
27925 has not been advertised in response to EHLO. Furthermore, because there are
27926 apparently some really broken clients that do this, Exim will accept AUTH after
27927 HELO (rather than EHLO) when this control is set. It should be used only if you
27928 really need it, and you should limit its use to those broken clients that do
27929 not work without it. For example:
27930 .code
27931 warn hosts   = 192.168.34.25
27932      control = allow_auth_unadvertised
27933 .endd
27934 Normally, when an Exim server receives an AUTH command, it checks the name of
27935 the authentication mechanism that is given in the command to ensure that it
27936 matches an advertised mechanism. When this control is set, the check that a
27937 mechanism has been advertised is bypassed. Any configured mechanism can be used
27938 by the client. This control is permitted only in the connection and HELO ACLs.
27939
27940
27941 .vitem &*control&~=&~caseful_local_part*& &&&
27942        &*control&~=&~caselower_local_part*&
27943 .cindex "&ACL;" "case of local part in"
27944 .cindex "case of local parts"
27945 .vindex "&$local_part$&"
27946 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27947 (that is, during RCPT processing). By default, the contents of &$local_part$&
27948 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27949 any uppercase letters in the original local part are restored in &$local_part$&
27950 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27951 is encountered.
27952
27953 These controls affect only the current recipient. Moreover, they apply only to
27954 local part handling that takes place directly in the ACL (for example, as a key
27955 in lookups). If a test to verify the recipient is obeyed, the case-related
27956 handling of the local part during the verification is controlled by the router
27957 configuration (see the &%caseful_local_part%& generic router option).
27958
27959 This facility could be used, for example, to add a spam score to local parts
27960 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27961 spam score:
27962 .code
27963 warn  control = caseful_local_part
27964       set acl_m4 = ${eval:\
27965                      $acl_m4 + \
27966                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27967                     }
27968       control = caselower_local_part
27969 .endd
27970 Notice that we put back the lower cased version afterwards, assuming that
27971 is what is wanted for subsequent tests.
27972
27973
27974 .vitem &*control&~=&~cutthrough_delivery*&
27975 .cindex "&ACL;" "cutthrough routing"
27976 .cindex "cutthrough" "requesting"
27977 This option requests delivery be attempted while the item is being received.
27978 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27979 from one SMTP connection to another.  If a recipient-verify callout connection is
27980 requested in the same ACL it is held open and used for the data, otherwise one is made
27981 after the ACL completes.
27982
27983 Note that routers are used in verify mode,
27984 and cannot depend on content of received headers.
27985 Note also that headers cannot be
27986 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27987 Headers may be modified by routers (subject to the above) and transports.
27988
27989 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27990 of outgoing messages is done, because it sends data to the ultimate destination
27991 before the entire message has been received from the source.
27992
27993 Should the ultimate destination system positively accept or reject the mail,
27994 a corresponding indication is given to the source system and nothing is queued.
27995 If there is a temporary error the item is queued for later delivery in the
27996 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27997 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27998 line.
27999
28000 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
28001 sender when the destination system is doing content-scan based rejection.
28002
28003
28004 .vitem &*control&~=&~debug/*&<&'options'&>
28005 .cindex "&ACL;" "enabling debug logging"
28006 .cindex "debugging" "enabling from an ACL"
28007 This control turns on debug logging, almost as though Exim had been invoked
28008 with &`-d`&, with the output going to a new logfile, by default called
28009 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28010 may access any variables already defined.  The logging may be adjusted with
28011 the &'opts'& option, which takes the same values as the &`-d`& command-line
28012 option.  Some examples (which depend on variables that don't exist in all
28013 contexts):
28014 .code
28015       control = debug
28016       control = debug/tag=.$sender_host_address
28017       control = debug/opts=+expand+acl
28018       control = debug/tag=.$message_exim_id/opts=+expand
28019 .endd
28020
28021
28022 .vitem &*control&~=&~dkim_disable_verify*&
28023 .cindex "disable DKIM verify"
28024 .cindex "DKIM" "disable verify"
28025 This control turns off DKIM verification processing entirely.  For details on
28026 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28027
28028
28029 .vitem &*control&~=&~dscp/*&<&'value'&>
28030 .cindex "&ACL;" "setting DSCP value"
28031 .cindex "DSCP" "inbound"
28032 This option causes the DSCP value associated with the socket for the inbound
28033 connection to be adjusted to a given value, given as one of a number of fixed
28034 strings or to numeric value.
28035 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28036 Common values include &`throughput`&, &`mincost`&, and on newer systems
28037 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28038
28039 The outbound packets from Exim will be marked with this value in the header
28040 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28041 that these values will have any effect, not be stripped by networking
28042 equipment, or do much of anything without cooperation with your Network
28043 Engineer and those of all network operators between the source and destination.
28044
28045
28046 .vitem &*control&~=&~enforce_sync*& &&&
28047        &*control&~=&~no_enforce_sync*&
28048 .cindex "SMTP" "synchronization checking"
28049 .cindex "synchronization checking in SMTP"
28050 These controls make it possible to be selective about when SMTP synchronization
28051 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28052 state of the switch (it is true by default). See the description of this option
28053 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28054
28055 The effect of these two controls lasts for the remainder of the SMTP
28056 connection. They can appear in any ACL except the one for the non-SMTP
28057 messages. The most straightforward place to put them is in the ACL defined by
28058 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28059 before the first synchronization check. The expected use is to turn off the
28060 synchronization checks for badly-behaved hosts that you nevertheless need to
28061 work with.
28062
28063
28064 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28065 .cindex "fake defer"
28066 .cindex "defer, fake"
28067 This control works in exactly the same way as &%fakereject%& (described below)
28068 except that it causes an SMTP 450 response after the message data instead of a
28069 550 response. You must take care when using &%fakedefer%& because it causes the
28070 messages to be duplicated when the sender retries. Therefore, you should not
28071 use &%fakedefer%& if the message is to be delivered normally.
28072
28073 .vitem &*control&~=&~fakereject/*&<&'message'&>
28074 .cindex "fake rejection"
28075 .cindex "rejection, fake"
28076 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28077 words, only when an SMTP message is being received. If Exim accepts the
28078 message, instead the final 250 response, a 550 rejection message is sent.
28079 However, Exim proceeds to deliver the message as normal. The control applies
28080 only to the current message, not to any subsequent ones that may be received in
28081 the same SMTP connection.
28082
28083 The text for the 550 response is taken from the &%control%& modifier. If no
28084 message is supplied, the following is used:
28085 .code
28086 550-Your message has been rejected but is being
28087 550-kept for evaluation.
28088 550-If it was a legitimate message, it may still be
28089 550 delivered to the target recipient(s).
28090 .endd
28091 This facility should be used with extreme caution.
28092
28093 .vitem &*control&~=&~freeze*&
28094 .cindex "frozen messages" "forcing in ACL"
28095 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28096 other words, only when a message is being received. If the message is accepted,
28097 it is placed on Exim's queue and frozen. The control applies only to the
28098 current message, not to any subsequent ones that may be received in the same
28099 SMTP connection.
28100
28101 This modifier can optionally be followed by &`/no_tell`&. If the global option
28102 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28103 is told about the freezing), provided all the &*control=freeze*& modifiers that
28104 are obeyed for the current message have the &`/no_tell`& option.
28105
28106 .vitem &*control&~=&~no_delay_flush*&
28107 .cindex "SMTP" "output flushing, disabling for delay"
28108 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28109 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28110 use. This control, as long as it is encountered before the &%delay%& modifier,
28111 disables such output flushing.
28112
28113 .vitem &*control&~=&~no_callout_flush*&
28114 .cindex "SMTP" "output flushing, disabling for callout"
28115 Exim normally flushes SMTP output before performing a callout in an ACL, to
28116 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28117 use. This control, as long as it is encountered before the &%verify%& condition
28118 that causes the callout, disables such output flushing.
28119
28120 .vitem &*control&~=&~no_mbox_unspool*&
28121 This control is available when Exim is compiled with the content scanning
28122 extension. Content scanning may require a copy of the current message, or parts
28123 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28124 or spam scanner. Normally, such copies are deleted when they are no longer
28125 needed. If this control is set, the copies are not deleted. The control applies
28126 only to the current message, not to any subsequent ones that may be received in
28127 the same SMTP connection. It is provided for debugging purposes and is unlikely
28128 to be useful in production.
28129
28130 .vitem &*control&~=&~no_multiline_responses*&
28131 .cindex "multiline responses, suppressing"
28132 This control is permitted for any ACL except the one for non-SMTP messages.
28133 It seems that there are broken clients in use that cannot handle multiline
28134 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28135
28136 If this control is set, multiline SMTP responses from ACL rejections are
28137 suppressed. One way of doing this would have been to put out these responses as
28138 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28139 (&"use multiline responses for more"& it says &-- ha!), and some of the
28140 responses might get close to that. So this facility, which is after all only a
28141 sop to broken clients, is implemented by doing two very easy things:
28142
28143 .ilist
28144 Extra information that is normally output as part of a rejection caused by
28145 sender verification failure is omitted. Only the final line (typically &"sender
28146 verification failed"&) is sent.
28147 .next
28148 If a &%message%& modifier supplies a multiline response, only the first
28149 line is output.
28150 .endlist
28151
28152 The setting of the switch can, of course, be made conditional on the
28153 calling host. Its effect lasts until the end of the SMTP connection.
28154
28155 .vitem &*control&~=&~no_pipelining*&
28156 .cindex "PIPELINING" "suppressing advertising"
28157 This control turns off the advertising of the PIPELINING extension to SMTP in
28158 the current session. To be useful, it must be obeyed before Exim sends its
28159 response to an EHLO command. Therefore, it should normally appear in an ACL
28160 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28161 &%pipelining_advertise_hosts%&.
28162
28163 .vitem &*control&~=&~queue_only*&
28164 .oindex "&%queue_only%&"
28165 .cindex "queueing incoming messages"
28166 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28167 other words, only when a message is being received. If the message is accepted,
28168 it is placed on Exim's queue and left there for delivery by a subsequent queue
28169 runner. No immediate delivery process is started. In other words, it has the
28170 effect as the &%queue_only%& global option. However, the control applies only
28171 to the current message, not to any subsequent ones that may be received in the
28172 same SMTP connection.
28173
28174 .vitem &*control&~=&~submission/*&<&'options'&>
28175 .cindex "message" "submission"
28176 .cindex "submission mode"
28177 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28178 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28179 the current message is a submission from a local MUA. In this case, Exim
28180 operates in &"submission mode"&, and applies certain fixups to the message if
28181 necessary. For example, it adds a &'Date:'& header line if one is not present.
28182 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28183 late (the message has already been created).
28184
28185 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28186 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28187 submission mode; the available options for this control are described there.
28188 The control applies only to the current message, not to any subsequent ones
28189 that may be received in the same SMTP connection.
28190
28191 .vitem &*control&~=&~suppress_local_fixups*&
28192 .cindex "submission fixups, suppressing"
28193 This control applies to locally submitted (non TCP/IP) messages, and is the
28194 complement of &`control = submission`&. It disables the fixups that are
28195 normally applied to locally-submitted messages. Specifically:
28196
28197 .ilist
28198 Any &'Sender:'& header line is left alone (in this respect, it is a
28199 dynamic version of &%local_sender_retain%&).
28200 .next
28201 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28202 .next
28203 There is no check that &'From:'& corresponds to the actual sender.
28204 .endlist ilist
28205
28206 This control may be useful when a remotely-originated message is accepted,
28207 passed to some scanning program, and then re-submitted for delivery. It can be
28208 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28209 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28210 data is read.
28211
28212 &*Note:*& This control applies only to the current message, not to any others
28213 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28214 .endlist vlist
28215
28216
28217 .section "Summary of message fixup control" "SECTsummesfix"
28218 All four possibilities for message fixups can be specified:
28219
28220 .ilist
28221 Locally submitted, fixups applied: the default.
28222 .next
28223 Locally submitted, no fixups applied: use
28224 &`control = suppress_local_fixups`&.
28225 .next
28226 Remotely submitted, no fixups applied: the default.
28227 .next
28228 Remotely submitted, fixups applied: use &`control = submission`&.
28229 .endlist
28230
28231
28232
28233 .section "Adding header lines in ACLs" "SECTaddheadacl"
28234 .cindex "header lines" "adding in an ACL"
28235 .cindex "header lines" "position of added lines"
28236 .cindex "&%add_header%& ACL modifier"
28237 The &%add_header%& modifier can be used to add one or more extra header lines
28238 to an incoming message, as in this example:
28239 .code
28240 warn dnslists = sbl.spamhaus.org : \
28241                 dialup.mail-abuse.org
28242      add_header = X-blacklisted-at: $dnslist_domain
28243 .endd
28244 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28245 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28246 receiving a message). The message must ultimately be accepted for
28247 &%add_header%& to have any significant effect. You can use &%add_header%& with
28248 any ACL verb, including &%deny%& (though this is potentially useful only in a
28249 RCPT ACL).
28250
28251 Headers will not be added to the message if the modifier is used in
28252 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28253
28254 Leading and trailing newlines are removed from
28255 the data for the &%add_header%& modifier; if it then
28256 contains one or more newlines that
28257 are not followed by a space or a tab, it is assumed to contain multiple header
28258 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28259 front of any line that is not a valid header line.
28260
28261 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28262 They are added to the message before processing the DATA and MIME ACLs.
28263 However, if an identical header line is requested more than once, only one copy
28264 is actually added to the message. Further header lines may be accumulated
28265 during the DATA and MIME ACLs, after which they are added to the message, again
28266 with duplicates suppressed. Thus, it is possible to add two identical header
28267 lines to an SMTP message, but only if one is added before DATA and one after.
28268 In the case of non-SMTP messages, new headers are accumulated during the
28269 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28270 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28271 are included in the entry that is written to the reject log.
28272
28273 .cindex "header lines" "added; visibility of"
28274 Header lines are not visible in string expansions
28275 of message headers
28276 until they are added to the
28277 message. It follows that header lines defined in the MAIL, RCPT, and predata
28278 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28279 header lines that are added by the DATA or MIME ACLs are not visible in those
28280 ACLs. Because of this restriction, you cannot use header lines as a way of
28281 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28282 this, you can use ACL variables, as described in section
28283 &<<SECTaclvariables>>&.
28284
28285 The list of headers yet to be added is given by the &%$headers_added%& variable.
28286
28287 The &%add_header%& modifier acts immediately as it is encountered during the
28288 processing of an ACL. Notice the difference between these two cases:
28289 .display
28290 &`accept add_header = ADDED: some text`&
28291 &`       `&<&'some condition'&>
28292
28293 &`accept `&<&'some condition'&>
28294 &`       add_header = ADDED: some text`&
28295 .endd
28296 In the first case, the header line is always added, whether or not the
28297 condition is true. In the second case, the header line is added only if the
28298 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28299 ACL statement. All those that are encountered before a condition fails are
28300 honoured.
28301
28302 .cindex "&%warn%& ACL verb"
28303 For compatibility with previous versions of Exim, a &%message%& modifier for a
28304 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28305 effect only if all the conditions are true, even if it appears before some of
28306 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28307 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28308 are present on a &%warn%& verb, both are processed according to their
28309 specifications.
28310
28311 By default, new header lines are added to a message at the end of the existing
28312 header lines. However, you can specify that any particular header line should
28313 be added right at the start (before all the &'Received:'& lines), immediately
28314 after the first block of &'Received:'& lines, or immediately before any line
28315 that is not a &'Received:'& or &'Resent-something:'& header.
28316
28317 This is done by specifying &":at_start:"&, &":after_received:"&, or
28318 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28319 header line, respectively. (Header text cannot start with a colon, as there has
28320 to be a header name first.) For example:
28321 .code
28322 warn add_header = \
28323        :after_received:X-My-Header: something or other...
28324 .endd
28325 If more than one header line is supplied in a single &%add_header%& modifier,
28326 each one is treated independently and can therefore be placed differently. If
28327 you add more than one line at the start, or after the Received: block, they end
28328 up in reverse order.
28329
28330 &*Warning*&: This facility currently applies only to header lines that are
28331 added in an ACL. It does NOT work for header lines that are added in a
28332 system filter or in a router or transport.
28333
28334
28335
28336 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28337 .cindex "header lines" "removing in an ACL"
28338 .cindex "header lines" "position of removed lines"
28339 .cindex "&%remove_header%& ACL modifier"
28340 The &%remove_header%& modifier can be used to remove one or more header lines
28341 from an incoming message, as in this example:
28342 .code
28343 warn   message        = Remove internal headers
28344        remove_header  = x-route-mail1 : x-route-mail2
28345 .endd
28346 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28347 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28348 receiving a message). The message must ultimately be accepted for
28349 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28350 with any ACL verb, including &%deny%&, though this is really not useful for
28351 any verb that doesn't result in a delivered message.
28352
28353 Headers will not be removed to the message if the modifier is used in
28354 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28355
28356 More than one header can be removed at the same time by using a colon separated
28357 list of header names. The header matching is case insensitive. Wildcards are
28358 not permitted, nor is list expansion performed, so you cannot use hostlists to
28359 create a list of headers, however both connection and message variable expansion
28360 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28361 .code
28362 warn   hosts           = +internal_hosts
28363        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28364 warn   message         = Remove internal headers
28365        remove_header   = $acl_c_ihdrs
28366 .endd
28367 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28368 They are removed from the message before processing the DATA and MIME ACLs.
28369 There is no harm in attempting to remove the same header twice nor is removing
28370 a non-existent header. Further header lines to be removed may be accumulated
28371 during the DATA and MIME ACLs, after which they are removed from the message,
28372 if present. In the case of non-SMTP messages, headers to be removed are
28373 accumulated during the non-SMTP ACLs, and are removed from the message after
28374 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28375 ACL, there really is no effect because there is no logging of what headers
28376 would have been removed.
28377
28378 .cindex "header lines" "removed; visibility of"
28379 Header lines are not visible in string expansions until the DATA phase when it
28380 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28381 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28382 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28383 this restriction, you cannot use header lines as a way of controlling data
28384 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28385 you should instead use ACL variables, as described in section
28386 &<<SECTaclvariables>>&.
28387
28388 The &%remove_header%& modifier acts immediately as it is encountered during the
28389 processing of an ACL. Notice the difference between these two cases:
28390 .display
28391 &`accept remove_header = X-Internal`&
28392 &`       `&<&'some condition'&>
28393
28394 &`accept `&<&'some condition'&>
28395 &`       remove_header = X-Internal`&
28396 .endd
28397 In the first case, the header line is always removed, whether or not the
28398 condition is true. In the second case, the header line is removed only if the
28399 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28400 same ACL statement. All those that are encountered before a condition fails
28401 are honoured.
28402
28403 &*Warning*&: This facility currently applies only to header lines that are
28404 present during ACL processing. It does NOT remove header lines that are added
28405 in a system filter or in a router or transport.
28406
28407
28408
28409
28410 .section "ACL conditions" "SECTaclconditions"
28411 .cindex "&ACL;" "conditions; list of"
28412 Some of the conditions listed in this section are available only when Exim is
28413 compiled with the content-scanning extension. They are included here briefly
28414 for completeness. More detailed descriptions can be found in the discussion on
28415 content scanning in chapter &<<CHAPexiscan>>&.
28416
28417 Not all conditions are relevant in all circumstances. For example, testing
28418 senders and recipients does not make sense in an ACL that is being run as the
28419 result of the arrival of an ETRN command, and checks on message headers can be
28420 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28421 can use the same condition (with different parameters) more than once in the
28422 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28423 The conditions are as follows:
28424
28425
28426 .vlist
28427 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28428 .cindex "&ACL;" "nested"
28429 .cindex "&ACL;" "indirect"
28430 .cindex "&ACL;" "arguments"
28431 .cindex "&%acl%& ACL condition"
28432 The possible values of the argument are the same as for the
28433 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28434 &"accept"& the condition is true; if it returns &"deny"& the condition is
28435 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28436 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28437 condition false. This means that further processing of the &%warn%& verb
28438 ceases, but processing of the ACL continues.
28439
28440 If the argument is a named ACL, up to nine space-separated optional values
28441 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28442 and $acl_narg is set to the count of values.
28443 Previous values of these variables are restored after the call returns.
28444 The name and values are expanded separately.
28445 Note that spaces in complex expansions which are used as arguments
28446 will act as argument separators.
28447
28448 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28449 the connection is dropped. If it returns &"discard"&, the verb must be
28450 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28451 conditions are tested.
28452
28453 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28454 loops. This condition allows you to use different ACLs in different
28455 circumstances. For example, different ACLs can be used to handle RCPT commands
28456 for different local users or different local domains.
28457
28458 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28459 .cindex "&%authenticated%& ACL condition"
28460 .cindex "authentication" "ACL checking"
28461 .cindex "&ACL;" "testing for authentication"
28462 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28463 the name of the authenticator is tested against the list. To test for
28464 authentication by any authenticator, you can set
28465 .code
28466 authenticated = *
28467 .endd
28468
28469 .vitem &*condition&~=&~*&<&'string'&>
28470 .cindex "&%condition%& ACL condition"
28471 .cindex "customizing" "ACL condition"
28472 .cindex "&ACL;" "customized test"
28473 .cindex "&ACL;" "testing, customized"
28474 This feature allows you to make up custom conditions. If the result of
28475 expanding the string is an empty string, the number zero, or one of the strings
28476 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28477 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28478 any other value, some error is assumed to have occurred, and the ACL returns
28479 &"defer"&. However, if the expansion is forced to fail, the condition is
28480 ignored. The effect is to treat it as true, whether it is positive or
28481 negative.
28482
28483 .vitem &*decode&~=&~*&<&'location'&>
28484 .cindex "&%decode%& ACL condition"
28485 This condition is available only when Exim is compiled with the
28486 content-scanning extension, and it is allowed only in the ACL defined by
28487 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28488 If all goes well, the condition is true. It is false only if there are
28489 problems such as a syntax error or a memory shortage. For more details, see
28490 chapter &<<CHAPexiscan>>&.
28491
28492 .vitem &*demime&~=&~*&<&'extension&~list'&>
28493 .cindex "&%demime%& ACL condition"
28494 This condition is available only when Exim is compiled with the
28495 content-scanning extension. Its use is described in section
28496 &<<SECTdemimecond>>&.
28497
28498 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28499 .cindex "&%dnslists%& ACL condition"
28500 .cindex "DNS list" "in ACL"
28501 .cindex "black list (DNS)"
28502 .cindex "&ACL;" "testing a DNS list"
28503 This condition checks for entries in DNS black lists. These are also known as
28504 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28505 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28506 different variants of this condition to describe briefly here. See sections
28507 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28508
28509 .vitem &*domains&~=&~*&<&'domain&~list'&>
28510 .cindex "&%domains%& ACL condition"
28511 .cindex "domain" "ACL checking"
28512 .cindex "&ACL;" "testing a recipient domain"
28513 .vindex "&$domain_data$&"
28514 This condition is relevant only after a RCPT command. It checks that the domain
28515 of the recipient address is in the domain list. If percent-hack processing is
28516 enabled, it is done before this test is done. If the check succeeds with a
28517 lookup, the result of the lookup is placed in &$domain_data$& until the next
28518 &%domains%& test.
28519
28520 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28521 use &%domains%& in a DATA ACL.
28522
28523
28524 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28525 .cindex "&%encrypted%& ACL condition"
28526 .cindex "encryption" "checking in an ACL"
28527 .cindex "&ACL;" "testing for encryption"
28528 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28529 name of the cipher suite in use is tested against the list. To test for
28530 encryption without testing for any specific cipher suite(s), set
28531 .code
28532 encrypted = *
28533 .endd
28534
28535
28536 .vitem &*hosts&~=&~*&<&'host&~list'&>
28537 .cindex "&%hosts%& ACL condition"
28538 .cindex "host" "ACL checking"
28539 .cindex "&ACL;" "testing the client host"
28540 This condition tests that the calling host matches the host list. If you have
28541 name lookups or wildcarded host names and IP addresses in the same host list,
28542 you should normally put the IP addresses first. For example, you could have:
28543 .code
28544 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28545 .endd
28546 The lookup in this example uses the host name for its key. This is implied by
28547 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28548 and it wouldn't matter which way round you had these two items.)
28549
28550 The reason for the problem with host names lies in the left-to-right way that
28551 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28552 but when it reaches an item that requires a host name, it fails if it cannot
28553 find a host name to compare with the pattern. If the above list is given in the
28554 opposite order, the &%accept%& statement fails for a host whose name cannot be
28555 found, even if its IP address is 10.9.8.7.
28556
28557 If you really do want to do the name check first, and still recognize the IP
28558 address even if the name lookup fails, you can rewrite the ACL like this:
28559 .code
28560 accept hosts = dbm;/etc/friendly/hosts
28561 accept hosts = 10.9.8.7
28562 .endd
28563 The default action on failing to find the host name is to assume that the host
28564 is not in the list, so the first &%accept%& statement fails. The second
28565 statement can then check the IP address.
28566
28567 .vindex "&$host_data$&"
28568 If a &%hosts%& condition is satisfied by means of a lookup, the result
28569 of the lookup is made available in the &$host_data$& variable. This
28570 allows you, for example, to set up a statement like this:
28571 .code
28572 deny  hosts = net-lsearch;/some/file
28573 message = $host_data
28574 .endd
28575 which gives a custom error message for each denied host.
28576
28577 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28578 .cindex "&%local_parts%& ACL condition"
28579 .cindex "local part" "ACL checking"
28580 .cindex "&ACL;" "testing a local part"
28581 .vindex "&$local_part_data$&"
28582 This condition is relevant only after a RCPT command. It checks that the local
28583 part of the recipient address is in the list. If percent-hack processing is
28584 enabled, it is done before this test. If the check succeeds with a lookup, the
28585 result of the lookup is placed in &$local_part_data$&, which remains set until
28586 the next &%local_parts%& test.
28587
28588 .vitem &*malware&~=&~*&<&'option'&>
28589 .cindex "&%malware%& ACL condition"
28590 .cindex "&ACL;" "virus scanning"
28591 .cindex "&ACL;" "scanning for viruses"
28592 This condition is available only when Exim is compiled with the
28593 content-scanning extension. It causes the incoming message to be scanned for
28594 viruses. For details, see chapter &<<CHAPexiscan>>&.
28595
28596 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28597 .cindex "&%mime_regex%& ACL condition"
28598 .cindex "&ACL;" "testing by regex matching"
28599 This condition is available only when Exim is compiled with the
28600 content-scanning extension, and it is allowed only in the ACL defined by
28601 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28602 with any of the regular expressions. For details, see chapter
28603 &<<CHAPexiscan>>&.
28604
28605 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28606 .cindex "rate limiting"
28607 This condition can be used to limit the rate at which a user or host submits
28608 messages. Details are given in section &<<SECTratelimiting>>&.
28609
28610 .vitem &*recipients&~=&~*&<&'address&~list'&>
28611 .cindex "&%recipients%& ACL condition"
28612 .cindex "recipient" "ACL checking"
28613 .cindex "&ACL;" "testing a recipient"
28614 This condition is relevant only after a RCPT command. It checks the entire
28615 recipient address against a list of recipients.
28616
28617 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28618 .cindex "&%regex%& ACL condition"
28619 .cindex "&ACL;" "testing by regex matching"
28620 This condition is available only when Exim is compiled with the
28621 content-scanning extension, and is available only in the DATA, MIME, and
28622 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28623 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28624
28625 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28626 .cindex "&%sender_domains%& ACL condition"
28627 .cindex "sender" "ACL checking"
28628 .cindex "&ACL;" "testing a sender domain"
28629 .vindex "&$domain$&"
28630 .vindex "&$sender_address_domain$&"
28631 This condition tests the domain of the sender of the message against the given
28632 domain list. &*Note*&: The domain of the sender address is in
28633 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28634 of this condition. This is an exception to the general rule for testing domain
28635 lists. It is done this way so that, if this condition is used in an ACL for a
28636 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28637 influence the sender checking.
28638
28639 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28640 relaying, because sender addresses are easily, and commonly, forged.
28641
28642 .vitem &*senders&~=&~*&<&'address&~list'&>
28643 .cindex "&%senders%& ACL condition"
28644 .cindex "sender" "ACL checking"
28645 .cindex "&ACL;" "testing a sender"
28646 This condition tests the sender of the message against the given list. To test
28647 for a bounce message, which has an empty sender, set
28648 .code
28649 senders = :
28650 .endd
28651 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28652 relaying, because sender addresses are easily, and commonly, forged.
28653
28654 .vitem &*spam&~=&~*&<&'username'&>
28655 .cindex "&%spam%& ACL condition"
28656 .cindex "&ACL;" "scanning for spam"
28657 This condition is available only when Exim is compiled with the
28658 content-scanning extension. It causes the incoming message to be scanned by
28659 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28660
28661 .vitem &*verify&~=&~certificate*&
28662 .cindex "&%verify%& ACL condition"
28663 .cindex "TLS" "client certificate verification"
28664 .cindex "certificate" "verification of client"
28665 .cindex "&ACL;" "certificate verification"
28666 .cindex "&ACL;" "testing a TLS certificate"
28667 This condition is true in an SMTP session if the session is encrypted, and a
28668 certificate was received from the client, and the certificate was verified. The
28669 server requests a certificate only if the client matches &%tls_verify_hosts%&
28670 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28671
28672 .vitem &*verify&~=&~csa*&
28673 .cindex "CSA verification"
28674 This condition checks whether the sending host (the client) is authorized to
28675 send email. Details of how this works are given in section
28676 &<<SECTverifyCSA>>&.
28677
28678 .vitem &*verify&~=&~header_names_ascii*&
28679 .cindex "&%verify%& ACL condition"
28680 .cindex "&ACL;" "verifying header names only ASCII"
28681 .cindex "header lines" "verifying header names only ASCII"
28682 .cindex "verifying" "header names only ASCII"
28683 This condition is relevant only in an ACL that is run after a message has been
28684 received, that is, in an ACL specified by &%acl_smtp_data%& or
28685 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28686 there are no non-ASCII characters, also excluding control characters.  The
28687 allowable characters are decimal ASCII values 33 through 126.
28688
28689 Exim itself will handle headers with non-ASCII characters, but it can cause
28690 problems for downstream applications, so this option will allow their
28691 detection and rejection in the DATA ACL's.
28692
28693 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28694 .cindex "&%verify%& ACL condition"
28695 .cindex "&ACL;" "verifying sender in the header"
28696 .cindex "header lines" "verifying the sender in"
28697 .cindex "sender" "verifying in header"
28698 .cindex "verifying" "sender in header"
28699 This condition is relevant only in an ACL that is run after a message has been
28700 received, that is, in an ACL specified by &%acl_smtp_data%& or
28701 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28702 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28703 is loosely thought of as a &"sender"& address (hence the name of the test).
28704 However, an address that appears in one of these headers need not be an address
28705 that accepts bounce messages; only sender addresses in envelopes are required
28706 to accept bounces. Therefore, if you use the callout option on this check, you
28707 might want to arrange for a non-empty address in the MAIL command.
28708
28709 Details of address verification and the options are given later, starting at
28710 section &<<SECTaddressverification>>& (callouts are described in section
28711 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28712 condition to restrict it to bounce messages only:
28713 .code
28714 deny    senders = :
28715         message = A valid sender header is required for bounces
28716        !verify  = header_sender
28717 .endd
28718
28719 .vitem &*verify&~=&~header_syntax*&
28720 .cindex "&%verify%& ACL condition"
28721 .cindex "&ACL;" "verifying header syntax"
28722 .cindex "header lines" "verifying syntax"
28723 .cindex "verifying" "header syntax"
28724 This condition is relevant only in an ACL that is run after a message has been
28725 received, that is, in an ACL specified by &%acl_smtp_data%& or
28726 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28727 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28728 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28729 permitted only in locally generated messages and from hosts that match
28730 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28731 appropriate.
28732
28733 Note that this condition is a syntax check only. However, a common spamming
28734 ploy used to be to send syntactically invalid headers such as
28735 .code
28736 To: @
28737 .endd
28738 and this condition can be used to reject such messages, though they are not as
28739 common as they used to be.
28740
28741 .vitem &*verify&~=&~helo*&
28742 .cindex "&%verify%& ACL condition"
28743 .cindex "&ACL;" "verifying HELO/EHLO"
28744 .cindex "HELO" "verifying"
28745 .cindex "EHLO" "verifying"
28746 .cindex "verifying" "EHLO"
28747 .cindex "verifying" "HELO"
28748 This condition is true if a HELO or EHLO command has been received from the
28749 client host, and its contents have been verified. If there has been no previous
28750 attempt to verify the HELO/EHLO contents, it is carried out when this
28751 condition is encountered. See the description of the &%helo_verify_hosts%& and
28752 &%helo_try_verify_hosts%& options for details of how to request verification
28753 independently of this condition.
28754
28755 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28756 option), this condition is always true.
28757
28758
28759 .vitem &*verify&~=&~not_blind*&
28760 .cindex "verifying" "not blind"
28761 .cindex "bcc recipients, verifying none"
28762 This condition checks that there are no blind (bcc) recipients in the message.
28763 Every envelope recipient must appear either in a &'To:'& header line or in a
28764 &'Cc:'& header line for this condition to be true. Local parts are checked
28765 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28766 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28767 used only in a DATA or non-SMTP ACL.
28768
28769 There are, of course, many legitimate messages that make use of blind (bcc)
28770 recipients. This check should not be used on its own for blocking messages.
28771
28772
28773 .vitem &*verify&~=&~recipient/*&<&'options'&>
28774 .cindex "&%verify%& ACL condition"
28775 .cindex "&ACL;" "verifying recipient"
28776 .cindex "recipient" "verifying"
28777 .cindex "verifying" "recipient"
28778 .vindex "&$address_data$&"
28779 This condition is relevant only after a RCPT command. It verifies the current
28780 recipient. Details of address verification are given later, starting at section
28781 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28782 of &$address_data$& is the last value that was set while routing the address.
28783 This applies even if the verification fails. When an address that is being
28784 verified is redirected to a single address, verification continues with the new
28785 address, and in that case, the subsequent value of &$address_data$& is the
28786 value for the child address.
28787
28788 .vitem &*verify&~=&~reverse_host_lookup*&
28789 .cindex "&%verify%& ACL condition"
28790 .cindex "&ACL;" "verifying host reverse lookup"
28791 .cindex "host" "verifying reverse lookup"
28792 This condition ensures that a verified host name has been looked up from the IP
28793 address of the client host. (This may have happened already if the host name
28794 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28795 Verification ensures that the host name obtained from a reverse DNS lookup, or
28796 one of its aliases, does, when it is itself looked up in the DNS, yield the
28797 original IP address.
28798
28799 If this condition is used for a locally generated message (that is, when there
28800 is no client host involved), it always succeeds.
28801
28802 .vitem &*verify&~=&~sender/*&<&'options'&>
28803 .cindex "&%verify%& ACL condition"
28804 .cindex "&ACL;" "verifying sender"
28805 .cindex "sender" "verifying"
28806 .cindex "verifying" "sender"
28807 This condition is relevant only after a MAIL or RCPT command, or after a
28808 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28809 the message's sender is empty (that is, this is a bounce message), the
28810 condition is true. Otherwise, the sender address is verified.
28811
28812 .vindex "&$address_data$&"
28813 .vindex "&$sender_address_data$&"
28814 If there is data in the &$address_data$& variable at the end of routing, its
28815 value is placed in &$sender_address_data$& at the end of verification. This
28816 value can be used in subsequent conditions and modifiers in the same ACL
28817 statement. It does not persist after the end of the current statement. If you
28818 want to preserve the value for longer, you can save it in an ACL variable.
28819
28820 Details of verification are given later, starting at section
28821 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28822 to avoid doing it more than once per message.
28823
28824 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28825 .cindex "&%verify%& ACL condition"
28826 This is a variation of the previous option, in which a modified address is
28827 verified as a sender.
28828 .endlist
28829
28830
28831
28832 .section "Using DNS lists" "SECTmorednslists"
28833 .cindex "DNS list" "in ACL"
28834 .cindex "black list (DNS)"
28835 .cindex "&ACL;" "testing a DNS list"
28836 In its simplest form, the &%dnslists%& condition tests whether the calling host
28837 is on at least one of a number of DNS lists by looking up the inverted IP
28838 address in one or more DNS domains. (Note that DNS list domains are not mail
28839 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28840 special options instead.) For example, if the calling host's IP
28841 address is 192.168.62.43, and the ACL statement is
28842 .code
28843 deny dnslists = blackholes.mail-abuse.org : \
28844                 dialups.mail-abuse.org
28845 .endd
28846 the following records are looked up:
28847 .code
28848 43.62.168.192.blackholes.mail-abuse.org
28849 43.62.168.192.dialups.mail-abuse.org
28850 .endd
28851 As soon as Exim finds an existing DNS record, processing of the list stops.
28852 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28853 to test that a host is on more than one list (an &"and"& conjunction), you can
28854 use two separate conditions:
28855 .code
28856 deny dnslists = blackholes.mail-abuse.org
28857      dnslists = dialups.mail-abuse.org
28858 .endd
28859 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28860 behaves as if the host does not match the list item, that is, as if the DNS
28861 record does not exist. If there are further items in the DNS list, they are
28862 processed.
28863
28864 This is usually the required action when &%dnslists%& is used with &%deny%&
28865 (which is the most common usage), because it prevents a DNS failure from
28866 blocking mail. However, you can change this behaviour by putting one of the
28867 following special items in the list:
28868 .display
28869 &`+include_unknown `&   behave as if the item is on the list
28870 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28871 &`+defer_unknown   `&   give a temporary error
28872 .endd
28873 .cindex "&`+include_unknown`&"
28874 .cindex "&`+exclude_unknown`&"
28875 .cindex "&`+defer_unknown`&"
28876 Each of these applies to any subsequent items on the list. For example:
28877 .code
28878 deny dnslists = +defer_unknown : foo.bar.example
28879 .endd
28880 Testing the list of domains stops as soon as a match is found. If you want to
28881 warn for one list and block for another, you can use two different statements:
28882 .code
28883 deny  dnslists = blackholes.mail-abuse.org
28884 warn  message  = X-Warn: sending host is on dialups list
28885       dnslists = dialups.mail-abuse.org
28886 .endd
28887 DNS list lookups are cached by Exim for the duration of the SMTP session,
28888 so a lookup based on the IP address is done at most once for any incoming
28889 connection. Exim does not share information between multiple incoming
28890 connections (but your local name server cache should be active).
28891
28892
28893
28894 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28895 .cindex "DNS list" "keyed by explicit IP address"
28896 By default, the IP address that is used in a DNS list lookup is the IP address
28897 of the calling host. However, you can specify another IP address by listing it
28898 after the domain name, introduced by a slash. For example:
28899 .code
28900 deny dnslists = black.list.tld/192.168.1.2
28901 .endd
28902 This feature is not very helpful with explicit IP addresses; it is intended for
28903 use with IP addresses that are looked up, for example, the IP addresses of the
28904 MX hosts or nameservers of an email sender address. For an example, see section
28905 &<<SECTmulkeyfor>>& below.
28906
28907
28908
28909
28910 .section "DNS lists keyed on domain names" "SECID202"
28911 .cindex "DNS list" "keyed by domain name"
28912 There are some lists that are keyed on domain names rather than inverted IP
28913 addresses (see for example the &'domain based zones'& link at
28914 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28915 with these lists. You can change the name that is looked up in a DNS list by
28916 listing it after the domain name, introduced by a slash. For example,
28917 .code
28918 deny  message  = Sender's domain is listed at $dnslist_domain
28919       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28920 .endd
28921 This particular example is useful only in ACLs that are obeyed after the
28922 RCPT or DATA commands, when a sender address is available. If (for
28923 example) the message's sender is &'user@tld.example'& the name that is looked
28924 up by this example is
28925 .code
28926 tld.example.dsn.rfc-ignorant.org
28927 .endd
28928 A single &%dnslists%& condition can contain entries for both names and IP
28929 addresses. For example:
28930 .code
28931 deny dnslists = sbl.spamhaus.org : \
28932                 dsn.rfc-ignorant.org/$sender_address_domain
28933 .endd
28934 The first item checks the sending host's IP address; the second checks a domain
28935 name. The whole condition is true if either of the DNS lookups succeeds.
28936
28937
28938
28939
28940 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28941 .cindex "DNS list" "multiple keys for"
28942 The syntax described above for looking up explicitly-defined values (either
28943 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28944 name for the DNS list, what follows the slash can in fact be a list of items.
28945 As with all lists in Exim, the default separator is a colon. However, because
28946 this is a sublist within the list of DNS blacklist domains, it is necessary
28947 either to double the separators like this:
28948 .code
28949 dnslists = black.list.tld/name.1::name.2
28950 .endd
28951 or to change the separator character, like this:
28952 .code
28953 dnslists = black.list.tld/<;name.1;name.2
28954 .endd
28955 If an item in the list is an IP address, it is inverted before the DNS
28956 blacklist domain is appended. If it is not an IP address, no inversion
28957 occurs. Consider this condition:
28958 .code
28959 dnslists = black.list.tld/<;192.168.1.2;a.domain
28960 .endd
28961 The DNS lookups that occur are:
28962 .code
28963 2.1.168.192.black.list.tld
28964 a.domain.black.list.tld
28965 .endd
28966 Once a DNS record has been found (that matches a specific IP return
28967 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28968 are done. If there is a temporary DNS error, the rest of the sublist of domains
28969 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28970 only if no other DNS lookup in this sublist succeeds. In other words, a
28971 successful lookup for any of the items in the sublist overrides a temporary
28972 error for a previous item.
28973
28974 The ability to supply a list of items after the slash is in some sense just a
28975 syntactic convenience. These two examples have the same effect:
28976 .code
28977 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28978 dnslists = black.list.tld/a.domain::b.domain
28979 .endd
28980 However, when the data for the list is obtained from a lookup, the second form
28981 is usually much more convenient. Consider this example:
28982 .code
28983 deny message  = The mail servers for the domain \
28984                 $sender_address_domain \
28985                 are listed at $dnslist_domain ($dnslist_value); \
28986                 see $dnslist_text.
28987      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28988                                    ${lookup dnsdb {>|mxh=\
28989                                    $sender_address_domain} }} }
28990 .endd
28991 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28992 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28993 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28994 of expanding the condition might be something like this:
28995 .code
28996 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28997 .endd
28998 Thus, this example checks whether or not the IP addresses of the sender
28999 domain's mail servers are on the Spamhaus black list.
29000
29001 The key that was used for a successful DNS list lookup is put into the variable
29002 &$dnslist_matched$& (see section &<<SECID204>>&).
29003
29004
29005
29006
29007 .section "Data returned by DNS lists" "SECID203"
29008 .cindex "DNS list" "data returned from"
29009 DNS lists are constructed using address records in the DNS. The original RBL
29010 just used the address 127.0.0.1 on the right hand side of each record, but the
29011 RBL+ list and some other lists use a number of values with different meanings.
29012 The values used on the RBL+ list are:
29013 .display
29014 127.1.0.1  RBL
29015 127.1.0.2  DUL
29016 127.1.0.3  DUL and RBL
29017 127.1.0.4  RSS
29018 127.1.0.5  RSS and RBL
29019 127.1.0.6  RSS and DUL
29020 127.1.0.7  RSS and DUL and RBL
29021 .endd
29022 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29023 different values. Some DNS lists may return more than one address record;
29024 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29025
29026
29027 .section "Variables set from DNS lists" "SECID204"
29028 .cindex "expansion" "variables, set from DNS list"
29029 .cindex "DNS list" "variables set from"
29030 .vindex "&$dnslist_domain$&"
29031 .vindex "&$dnslist_matched$&"
29032 .vindex "&$dnslist_text$&"
29033 .vindex "&$dnslist_value$&"
29034 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29035 the name of the overall domain that matched (for example,
29036 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29037 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29038 the DNS record. When the key is an IP address, it is not reversed in
29039 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29040 cases, for example:
29041 .code
29042 deny dnslists = spamhaus.example
29043 .endd
29044 the key is also available in another variable (in this case,
29045 &$sender_host_address$&). In more complicated cases, however, this is not true.
29046 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29047 might generate a dnslists lookup like this:
29048 .code
29049 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29050 .endd
29051 If this condition succeeds, the value in &$dnslist_matched$& might be
29052 &`192.168.6.7`& (for example).
29053
29054 If more than one address record is returned by the DNS lookup, all the IP
29055 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29056 The variable &$dnslist_text$& contains the contents of any associated TXT
29057 record. For lists such as RBL+ the TXT record for a merged entry is often not
29058 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29059 information.
29060
29061 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29062 &-- although these appear before the condition in the ACL, they are not
29063 expanded until after it has failed. For example:
29064 .code
29065 deny    hosts = !+local_networks
29066         message = $sender_host_address is listed \
29067                   at $dnslist_domain
29068         dnslists = rbl-plus.mail-abuse.example
29069 .endd
29070
29071
29072
29073 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29074 .cindex "DNS list" "matching specific returned data"
29075 You can add an equals sign and an IP address after a &%dnslists%& domain name
29076 in order to restrict its action to DNS records with a matching right hand side.
29077 For example,
29078 .code
29079 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29080 .endd
29081 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29082 any address record is considered to be a match. For the moment, we assume
29083 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29084 describes how multiple records are handled.
29085
29086 More than one IP address may be given for checking, using a comma as a
29087 separator. These are alternatives &-- if any one of them matches, the
29088 &%dnslists%& condition is true. For example:
29089 .code
29090 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29091 .endd
29092 If you want to specify a constraining address list and also specify names or IP
29093 addresses to be looked up, the constraining address list must be specified
29094 first. For example:
29095 .code
29096 deny dnslists = dsn.rfc-ignorant.org\
29097                 =127.0.0.2/$sender_address_domain
29098 .endd
29099
29100 If the character &`&&`& is used instead of &`=`&, the comparison for each
29101 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29102 In other words, the listed addresses are used as bit masks. The comparison is
29103 true if all the bits in the mask are present in the address that is being
29104 tested. For example:
29105 .code
29106 dnslists = a.b.c&0.0.0.3
29107 .endd
29108 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29109 want to test whether one bit or another bit is present (as opposed to both
29110 being present), you must use multiple values. For example:
29111 .code
29112 dnslists = a.b.c&0.0.0.1,0.0.0.2
29113 .endd
29114 matches if the final component of the address is an odd number or two times
29115 an odd number.
29116
29117
29118
29119 .section "Negated DNS matching conditions" "SECID205"
29120 You can supply a negative list of IP addresses as part of a &%dnslists%&
29121 condition. Whereas
29122 .code
29123 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29124 .endd
29125 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29126 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29127 .code
29128 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29129 .endd
29130 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29131 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29132 words, the result of the test is inverted if an exclamation mark appears before
29133 the &`=`& (or the &`&&`&) sign.
29134
29135 &*Note*&: This kind of negation is not the same as negation in a domain,
29136 host, or address list (which is why the syntax is different).
29137
29138 If you are using just one list, the negation syntax does not gain you much. The
29139 previous example is precisely equivalent to
29140 .code
29141 deny  dnslists = a.b.c
29142      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29143 .endd
29144 However, if you are using multiple lists, the negation syntax is clearer.
29145 Consider this example:
29146 .code
29147 deny  dnslists = sbl.spamhaus.org : \
29148                  list.dsbl.org : \
29149                  dnsbl.njabl.org!=127.0.0.3 : \
29150                  relays.ordb.org
29151 .endd
29152 Using only positive lists, this would have to be:
29153 .code
29154 deny  dnslists = sbl.spamhaus.org : \
29155                  list.dsbl.org
29156 deny  dnslists = dnsbl.njabl.org
29157      !dnslists = dnsbl.njabl.org=127.0.0.3
29158 deny  dnslists = relays.ordb.org
29159 .endd
29160 which is less clear, and harder to maintain.
29161
29162
29163
29164
29165 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29166 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29167 thereby providing more than one IP address. When an item in a &%dnslists%& list
29168 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29169 the match to specific results from the DNS lookup, there are two ways in which
29170 the checking can be handled. For example, consider the condition:
29171 .code
29172 dnslists = a.b.c=127.0.0.1
29173 .endd
29174 What happens if the DNS lookup for the incoming IP address yields both
29175 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29176 condition true because at least one given value was found, or is it false
29177 because at least one of the found values was not listed? And how does this
29178 affect negated conditions? Both possibilities are provided for with the help of
29179 additional separators &`==`& and &`=&&`&.
29180
29181 .ilist
29182 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29183 IP addresses matches one of the listed addresses. For the example above, the
29184 condition is true because 127.0.0.1 matches.
29185 .next
29186 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29187 looked up IP addresses matches one of the listed addresses. If the condition is
29188 changed to:
29189 .code
29190 dnslists = a.b.c==127.0.0.1
29191 .endd
29192 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29193 false because 127.0.0.2 is not listed. You would need to have:
29194 .code
29195 dnslists = a.b.c==127.0.0.1,127.0.0.2
29196 .endd
29197 for the condition to be true.
29198 .endlist
29199
29200 When &`!`& is used to negate IP address matching, it inverts the result, giving
29201 the precise opposite of the behaviour above. Thus:
29202 .ilist
29203 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29204 addresses matches one of the listed addresses. Consider:
29205 .code
29206 dnslists = a.b.c!&0.0.0.1
29207 .endd
29208 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29209 false because 127.0.0.1 matches.
29210 .next
29211 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29212 looked up IP address that does not match. Consider:
29213 .code
29214 dnslists = a.b.c!=&0.0.0.1
29215 .endd
29216 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29217 true, because 127.0.0.2 does not match. You would need to have:
29218 .code
29219 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29220 .endd
29221 for the condition to be false.
29222 .endlist
29223 When the DNS lookup yields only a single IP address, there is no difference
29224 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29225
29226
29227
29228
29229 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29230 .cindex "DNS list" "information from merged"
29231 When the facility for restricting the matching IP values in a DNS list is used,
29232 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29233 the true reason for rejection. This happens when lists are merged and the IP
29234 address in the A record is used to distinguish them; unfortunately there is
29235 only one TXT record. One way round this is not to use merged lists, but that
29236 can be inefficient because it requires multiple DNS lookups where one would do
29237 in the vast majority of cases when the host of interest is not on any of the
29238 lists.
29239
29240 A less inefficient way of solving this problem is available. If
29241 two domain names, comma-separated, are given, the second is used first to
29242 do an initial check, making use of any IP value restrictions that are set.
29243 If there is a match, the first domain is used, without any IP value
29244 restrictions, to get the TXT record. As a byproduct of this, there is also
29245 a check that the IP being tested is indeed on the first list. The first
29246 domain is the one that is put in &$dnslist_domain$&. For example:
29247 .code
29248 reject message  = \
29249          rejected because $sender_host_address is blacklisted \
29250          at $dnslist_domain\n$dnslist_text
29251        dnslists = \
29252          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29253          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29254 .endd
29255 For the first blacklist item, this starts by doing a lookup in
29256 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29257 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29258 value, and as long as something is found, it looks for the corresponding TXT
29259 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29260 The second blacklist item is processed similarly.
29261
29262 If you are interested in more than one merged list, the same list must be
29263 given several times, but because the results of the DNS lookups are cached,
29264 the DNS calls themselves are not repeated. For example:
29265 .code
29266 reject dnslists = \
29267          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29268          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29269          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29270          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29271 .endd
29272 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29273 values matches (or if no record is found), this is the only lookup that is
29274 done. Only if there is a match is one of the more specific lists consulted.
29275
29276
29277
29278 .section "DNS lists and IPv6" "SECTmorednslistslast"
29279 .cindex "IPv6" "DNS black lists"
29280 .cindex "DNS list" "IPv6 usage"
29281 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29282 nibble by nibble. For example, if the calling host's IP address is
29283 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29284 .code
29285 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29286   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29287 .endd
29288 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29289 lists contain wildcard records, intended for IPv4, that interact badly with
29290 IPv6. For example, the DNS entry
29291 .code
29292 *.3.some.list.example.    A    127.0.0.1
29293 .endd
29294 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29295 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29296
29297 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29298 &%condition%& condition, as in this example:
29299 .code
29300 deny   condition = ${if isip4{$sender_host_address}}
29301        dnslists  = some.list.example
29302 .endd
29303
29304 If an explicit key is being used for a DNS lookup and it may be an IPv6
29305 address you should specify alternate list separators for both the outer
29306 (DNS list name) list and inner (lookup keys) list:
29307 .code
29308        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29309 .endd
29310
29311 .section "Rate limiting incoming messages" "SECTratelimiting"
29312 .cindex "rate limiting" "client sending"
29313 .cindex "limiting client sending rates"
29314 .oindex "&%smtp_ratelimit_*%&"
29315 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29316 which clients can send email. This is more powerful than the
29317 &%smtp_ratelimit_*%& options, because those options control the rate of
29318 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29319 works across all connections (concurrent and sequential) from the same client
29320 host. The syntax of the &%ratelimit%& condition is:
29321 .display
29322 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29323 .endd
29324 If the average client sending rate is less than &'m'& messages per time
29325 period &'p'& then the condition is false; otherwise it is true.
29326
29327 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29328 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29329 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29330 of &'p'&.
29331
29332 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29333 time interval, for example, &`8h`& for eight hours. A larger time constant
29334 means that it takes Exim longer to forget a client's past behaviour. The
29335 parameter &'m'& is the maximum number of messages that a client is permitted to
29336 send in each time interval. It also specifies the number of messages permitted
29337 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29338 constant, you can allow a client to send more messages in a burst without
29339 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29340 both small, messages must be sent at an even rate.
29341
29342 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29343 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29344 when deploying the &%ratelimit%& ACL condition. The script prints usage
29345 instructions when it is run with no arguments.
29346
29347 The key is used to look up the data for calculating the client's average
29348 sending rate. This data is stored in Exim's spool directory, alongside the
29349 retry and other hints databases. The default key is &$sender_host_address$&,
29350 which means Exim computes the sending rate of each client host IP address.
29351 By changing the key you can change how Exim identifies clients for the purpose
29352 of ratelimiting. For example, to limit the sending rate of each authenticated
29353 user, independent of the computer they are sending from, set the key to
29354 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29355 example, &$authenticated_id$& is only meaningful if the client has
29356 authenticated (which you can check with the &%authenticated%& ACL condition).
29357
29358 The lookup key does not have to identify clients: If you want to limit the
29359 rate at which a recipient receives messages, you can use the key
29360 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29361 ACL.
29362
29363 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29364 specifies what Exim measures the rate of, for example messages or recipients
29365 or bytes. You can adjust the measurement using the &%unique=%& and/or
29366 &%count=%& options. You can also control when Exim updates the recorded rate
29367 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29368 separated by a slash, like the other parameters. They may appear in any order.
29369
29370 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29371 any options that alter the meaning of the stored data. The limit &'m'& is not
29372 stored, so you can alter the configured maximum rate and Exim will still
29373 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29374 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29375 behaviour. The lookup key is not affected by changes to the update mode and
29376 the &%count=%& option.
29377
29378
29379 .section "Ratelimit options for what is being measured" "ratoptmea"
29380 .cindex "rate limiting" "per_* options"
29381 The &%per_conn%& option limits the client's connection rate. It is not
29382 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29383 &%acl_not_smtp_start%& ACLs.
29384
29385 The &%per_mail%& option limits the client's rate of sending messages. This is
29386 the default if none of the &%per_*%& options is specified. It can be used in
29387 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29388 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29389
29390 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29391 the same ACLs as the &%per_mail%& option, though it is best to use this option
29392 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29393 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29394 in its MAIL command, which may be inaccurate or completely missing. You can
29395 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29396 in kilobytes, megabytes, or gigabytes, respectively.
29397
29398 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29399 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29400 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29401 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29402 ACLs the rate is updated with the total recipient count in one go. Note that
29403 in either case the rate limiting engine will see a message with many
29404 recipients as a large high-speed burst.
29405
29406 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29407 number of different recipients that the client has sent messages to in the
29408 last time period. That is, if the client repeatedly sends messages to the same
29409 recipient, its measured rate is not increased. This option can only be used in
29410 &%acl_smtp_rcpt%&.
29411
29412 The &%per_cmd%& option causes Exim to recompute the rate every time the
29413 condition is processed. This can be used to limit the rate of any SMTP
29414 command. If it is used in multiple ACLs it can limit the aggregate rate of
29415 multiple different commands.
29416
29417 The &%count=%& option can be used to alter how much Exim adds to the client's
29418 measured rate. For example, the &%per_byte%& option is equivalent to
29419 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29420 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29421 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29422
29423 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29424
29425
29426 .section "Ratelimit update modes" "ratoptupd"
29427 .cindex "rate limiting" "reading data without updating"
29428 You can specify one of three options with the &%ratelimit%& condition to
29429 control when its database is updated. This section describes the &%readonly%&
29430 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29431
29432 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29433 previously-computed rate to check against the limit.
29434
29435 For example, you can test the client's sending rate and deny it access (when
29436 it is too fast) in the connect ACL. If the client passes this check then it
29437 can go on to send a message, in which case its recorded rate will be updated
29438 in the MAIL ACL. Subsequent connections from the same client will check this
29439 new rate.
29440 .code
29441 acl_check_connect:
29442  deny ratelimit = 100 / 5m / readonly
29443     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29444                   (max $sender_rate_limit)
29445 # ...
29446 acl_check_mail:
29447  warn ratelimit = 100 / 5m / strict
29448     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29449                   (max $sender_rate_limit)
29450 .endd
29451
29452 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29453 processing a message then it may increase the client's measured rate more than
29454 it should. For example, this will happen if you check the &%per_rcpt%& option
29455 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29456 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29457 multiple update problems by using the &%readonly%& option on later ratelimit
29458 checks.
29459
29460 The &%per_*%& options described above do not make sense in some ACLs. If you
29461 use a &%per_*%& option in an ACL where it is not normally permitted then the
29462 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29463 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29464 next section) so you must specify the &%readonly%& option explicitly.
29465
29466
29467 .section "Ratelimit options for handling fast clients" "ratoptfast"
29468 .cindex "rate limiting" "strict and leaky modes"
29469 If a client's average rate is greater than the maximum, the rate limiting
29470 engine can react in two possible ways, depending on the presence of the
29471 &%strict%& or &%leaky%& update modes. This is independent of the other
29472 counter-measures (such as rejecting the message) that may be specified by the
29473 rest of the ACL.
29474
29475 The &%leaky%& (default) option means that the client's recorded rate is not
29476 updated if it is above the limit. The effect of this is that Exim measures the
29477 client's average rate of successfully sent email, which cannot be greater than
29478 the maximum allowed. If the client is over the limit it may suffer some
29479 counter-measures (as specified in the ACL), but it will still be able to send
29480 email at the configured maximum rate, whatever the rate of its attempts. This
29481 is generally the better choice if you have clients that retry automatically.
29482 For example, it does not prevent a sender with an over-aggressive retry rate
29483 from getting any email through.
29484
29485 The &%strict%& option means that the client's recorded rate is always
29486 updated. The effect of this is that Exim measures the client's average rate
29487 of attempts to send email, which can be much higher than the maximum it is
29488 actually allowed. If the client is over the limit it may be subjected to
29489 counter-measures by the ACL. It must slow down and allow sufficient time to
29490 pass that its computed rate falls below the maximum before it can send email
29491 again. The time (the number of smoothing periods) it must wait and not
29492 attempt to send mail can be calculated with this formula:
29493 .code
29494         ln(peakrate/maxrate)
29495 .endd
29496
29497
29498 .section "Limiting the rate of different events" "ratoptuniq"
29499 .cindex "rate limiting" "counting unique events"
29500 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29501 rate of different events. For example, the &%per_addr%& option uses this
29502 mechanism to count the number of different recipients that the client has
29503 sent messages to in the last time period; it is equivalent to
29504 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29505 measure the rate that a client uses different sender addresses with the
29506 options &`per_mail/unique=$sender_address`&.
29507
29508 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29509 has seen for that key. The whole set is thrown away when it is older than the
29510 rate smoothing period &'p'&, so each different event is counted at most once
29511 per period. In the &%leaky%& update mode, an event that causes the client to
29512 go over the limit is not added to the set, in the same way that the client's
29513 recorded rate is not updated in the same situation.
29514
29515 When you combine the &%unique=%& and &%readonly%& options, the specific
29516 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29517 rate.
29518
29519 The &%unique=%& mechanism needs more space in the ratelimit database than the
29520 other &%ratelimit%& options in order to store the event set. The number of
29521 unique values is potentially as large as the rate limit, so the extra space
29522 required increases with larger limits.
29523
29524 The uniqueification is not perfect: there is a small probability that Exim
29525 will think a new event has happened before. If the sender's rate is less than
29526 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29527 the measured rate can go above the limit, in which case Exim may under-count
29528 events by a significant margin. Fortunately, if the rate is high enough (2.7
29529 times the limit) that the false positive rate goes above 9%, then Exim will
29530 throw away the over-full event set before the measured rate falls below the
29531 limit. Therefore the only harm should be that exceptionally high sending rates
29532 are logged incorrectly; any countermeasures you configure will be as effective
29533 as intended.
29534
29535
29536 .section "Using rate limiting" "useratlim"
29537 Exim's other ACL facilities are used to define what counter-measures are taken
29538 when the rate limit is exceeded. This might be anything from logging a warning
29539 (for example, while measuring existing sending rates in order to define
29540 policy), through time delays to slow down fast senders, up to rejecting the
29541 message. For example:
29542 .code
29543 # Log all senders' rates
29544 warn ratelimit = 0 / 1h / strict
29545      log_message = Sender rate $sender_rate / $sender_rate_period
29546
29547 # Slow down fast senders; note the need to truncate $sender_rate
29548 # at the decimal point.
29549 warn ratelimit = 100 / 1h / per_rcpt / strict
29550      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29551                    $sender_rate_limit }s
29552
29553 # Keep authenticated users under control
29554 deny authenticated = *
29555      ratelimit = 100 / 1d / strict / $authenticated_id
29556
29557 # System-wide rate limit
29558 defer message = Sorry, too busy. Try again later.
29559      ratelimit = 10 / 1s / $primary_hostname
29560
29561 # Restrict incoming rate from each host, with a default
29562 # set using a macro and special cases looked up in a table.
29563 defer message = Sender rate exceeds $sender_rate_limit \
29564                messages per $sender_rate_period
29565      ratelimit = ${lookup {$sender_host_address} \
29566                    cdb {DB/ratelimits.cdb} \
29567                    {$value} {RATELIMIT} }
29568 .endd
29569 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29570 especially with the &%per_rcpt%& option, you may suffer from a performance
29571 bottleneck caused by locking on the ratelimit hints database. Apart from
29572 making your ACLs less complicated, you can reduce the problem by using a
29573 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29574 this means that Exim will lose its hints data after a reboot (including retry
29575 hints, the callout cache, and ratelimit data).
29576
29577
29578
29579 .section "Address verification" "SECTaddressverification"
29580 .cindex "verifying address" "options for"
29581 .cindex "policy control" "address verification"
29582 Several of the &%verify%& conditions described in section
29583 &<<SECTaclconditions>>& cause addresses to be verified. Section
29584 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29585 The verification conditions can be followed by options that modify the
29586 verification process. The options are separated from the keyword and from each
29587 other by slashes, and some of them contain parameters. For example:
29588 .code
29589 verify = sender/callout
29590 verify = recipient/defer_ok/callout=10s,defer_ok
29591 .endd
29592 The first stage of address verification, which always happens, is to run the
29593 address through the routers, in &"verify mode"&. Routers can detect the
29594 difference between verification and routing for delivery, and their actions can
29595 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29596 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29597 The available options are as follows:
29598
29599 .ilist
29600 If the &%callout%& option is specified, successful routing to one or more
29601 remote hosts is followed by a &"callout"& to those hosts as an additional
29602 check. Callouts and their sub-options are discussed in the next section.
29603 .next
29604 If there is a defer error while doing verification routing, the ACL
29605 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29606 options, the condition is forced to be true instead. Note that this is a main
29607 verification option as well as a suboption for callouts.
29608 .next
29609 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29610 discusses the reporting of sender address verification failures.
29611 .next
29612 The &%success_on_redirect%& option causes verification always to succeed
29613 immediately after a successful redirection. By default, if a redirection
29614 generates just one address, that address is also verified. See further
29615 discussion in section &<<SECTredirwhilveri>>&.
29616 .endlist
29617
29618 .cindex "verifying address" "differentiating failures"
29619 .vindex "&$recipient_verify_failure$&"
29620 .vindex "&$sender_verify_failure$&"
29621 .vindex "&$acl_verify_message$&"
29622 After an address verification failure, &$acl_verify_message$& contains the
29623 error message that is associated with the failure. It can be preserved by
29624 coding like this:
29625 .code
29626 warn  !verify = sender
29627        set acl_m0 = $acl_verify_message
29628 .endd
29629 If you are writing your own custom rejection message or log message when
29630 denying access, you can use this variable to include information about the
29631 verification failure.
29632
29633 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29634 appropriate) contains one of the following words:
29635
29636 .ilist
29637 &%qualify%&: The address was unqualified (no domain), and the message
29638 was neither local nor came from an exempted host.
29639 .next
29640 &%route%&: Routing failed.
29641 .next
29642 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29643 occurred at or before the MAIL command (that is, on initial
29644 connection, HELO, or MAIL).
29645 .next
29646 &%recipient%&: The RCPT command in a callout was rejected.
29647 .next
29648 &%postmaster%&: The postmaster check in a callout was rejected.
29649 .endlist
29650
29651 The main use of these variables is expected to be to distinguish between
29652 rejections of MAIL and rejections of RCPT in callouts.
29653
29654
29655
29656
29657 .section "Callout verification" "SECTcallver"
29658 .cindex "verifying address" "by callout"
29659 .cindex "callout" "verification"
29660 .cindex "SMTP" "callout verification"
29661 For non-local addresses, routing verifies the domain, but is unable to do any
29662 checking of the local part. There are situations where some means of verifying
29663 the local part is desirable. One way this can be done is to make an SMTP
29664 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29665 a subsequent host for a recipient address, to see if the host accepts the
29666 address. We use the term &'callout'& to cover both cases. Note that for a
29667 sender address, the callback is not to the client host that is trying to
29668 deliver the message, but to one of the hosts that accepts incoming mail for the
29669 sender's domain.
29670
29671 Exim does not do callouts by default. If you want them to happen, you must
29672 request them by setting appropriate options on the &%verify%& condition, as
29673 described below. This facility should be used with care, because it can add a
29674 lot of resource usage to the cost of verifying an address. However, Exim does
29675 cache the results of callouts, which helps to reduce the cost. Details of
29676 caching are in section &<<SECTcallvercache>>&.
29677
29678 Recipient callouts are usually used only between hosts that are controlled by
29679 the same administration. For example, a corporate gateway host could use
29680 callouts to check for valid recipients on an internal mailserver. A successful
29681 callout does not guarantee that a real delivery to the address would succeed;
29682 on the other hand, a failing callout does guarantee that a delivery would fail.
29683
29684 If the &%callout%& option is present on a condition that verifies an address, a
29685 second stage of verification occurs if the address is successfully routed to
29686 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29687 &(manualroute)& router, where the router specifies the hosts. However, if a
29688 router that does not set up hosts routes to an &(smtp)& transport with a
29689 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29690 &%hosts_override%& set, its hosts are always used, whether or not the router
29691 supplies a host list.
29692 Callouts are only supported on &(smtp)& transports.
29693
29694 The port that is used is taken from the transport, if it is specified and is a
29695 remote transport. (For routers that do verification only, no transport need be
29696 specified.) Otherwise, the default SMTP port is used. If a remote transport
29697 specifies an outgoing interface, this is used; otherwise the interface is not
29698 specified. Likewise, the text that is used for the HELO command is taken from
29699 the transport's &%helo_data%& option; if there is no transport, the value of
29700 &$smtp_active_hostname$& is used.
29701
29702 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29703 test whether a bounce message could be delivered to the sender address. The
29704 following SMTP commands are sent:
29705 .display
29706 &`HELO `&<&'local host name'&>
29707 &`MAIL FROM:<>`&
29708 &`RCPT TO:`&<&'the address to be tested'&>
29709 &`QUIT`&
29710 .endd
29711 LHLO is used instead of HELO if the transport's &%protocol%& option is
29712 set to &"lmtp"&.
29713
29714 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29715 settings.
29716
29717 A recipient callout check is similar. By default, it also uses an empty address
29718 for the sender. This default is chosen because most hosts do not make use of
29719 the sender address when verifying a recipient. Using the same address means
29720 that a single cache entry can be used for each recipient. Some sites, however,
29721 do make use of the sender address when verifying. These are catered for by the
29722 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29723
29724 If the response to the RCPT command is a 2&'xx'& code, the verification
29725 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29726 Exim tries the next host, if any. If there is a problem with all the remote
29727 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29728 &%callout%& option is given, in which case the condition is forced to succeed.
29729
29730 .cindex "SMTP" "output flushing, disabling for callout"
29731 A callout may take a little time. For this reason, Exim normally flushes SMTP
29732 output before performing a callout in an ACL, to avoid unexpected timeouts in
29733 clients when the SMTP PIPELINING extension is in use. The flushing can be
29734 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29735
29736
29737
29738
29739 .section "Additional parameters for callouts" "CALLaddparcall"
29740 .cindex "callout" "additional parameters for"
29741 The &%callout%& option can be followed by an equals sign and a number of
29742 optional parameters, separated by commas. For example:
29743 .code
29744 verify = recipient/callout=10s,defer_ok
29745 .endd
29746 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29747 separate verify options, is retained for backwards compatibility, but is now
29748 deprecated. The additional parameters for &%callout%& are as follows:
29749
29750
29751 .vlist
29752 .vitem <&'a&~time&~interval'&>
29753 .cindex "callout" "timeout, specifying"
29754 This specifies the timeout that applies for the callout attempt to each host.
29755 For example:
29756 .code
29757 verify = sender/callout=5s
29758 .endd
29759 The default is 30 seconds. The timeout is used for each response from the
29760 remote host. It is also used for the initial connection, unless overridden by
29761 the &%connect%& parameter.
29762
29763
29764 .vitem &*connect&~=&~*&<&'time&~interval'&>
29765 .cindex "callout" "connection timeout, specifying"
29766 This parameter makes it possible to set a different (usually smaller) timeout
29767 for making the SMTP connection. For example:
29768 .code
29769 verify = sender/callout=5s,connect=1s
29770 .endd
29771 If not specified, this timeout defaults to the general timeout value.
29772
29773 .vitem &*defer_ok*&
29774 .cindex "callout" "defer, action on"
29775 When this parameter is present, failure to contact any host, or any other kind
29776 of temporary error, is treated as success by the ACL. However, the cache is not
29777 updated in this circumstance.
29778
29779 .vitem &*fullpostmaster*&
29780 .cindex "callout" "full postmaster check"
29781 This operates like the &%postmaster%& option (see below), but if the check for
29782 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29783 accordance with the specification in RFC 2821. The RFC states that the
29784 unqualified address &'postmaster'& should be accepted.
29785
29786
29787 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29788 .cindex "callout" "sender when verifying header"
29789 When verifying addresses in header lines using the &%header_sender%&
29790 verification option, Exim behaves by default as if the addresses are envelope
29791 sender addresses from a message. Callout verification therefore tests to see
29792 whether a bounce message could be delivered, by using an empty address in the
29793 MAIL command. However, it is arguable that these addresses might never be used
29794 as envelope senders, and could therefore justifiably reject bounce messages
29795 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29796 address to use in the MAIL command. For example:
29797 .code
29798 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29799 .endd
29800 This parameter is available only for the &%header_sender%& verification option.
29801
29802
29803 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29804 .cindex "callout" "overall timeout, specifying"
29805 This parameter sets an overall timeout for performing a callout verification.
29806 For example:
29807 .code
29808 verify = sender/callout=5s,maxwait=30s
29809 .endd
29810 This timeout defaults to four times the callout timeout for individual SMTP
29811 commands. The overall timeout applies when there is more than one host that can
29812 be tried. The timeout is checked before trying the next host. This prevents
29813 very long delays if there are a large number of hosts and all are timing out
29814 (for example, when network connections are timing out).
29815
29816
29817 .vitem &*no_cache*&
29818 .cindex "callout" "cache, suppressing"
29819 .cindex "caching callout, suppressing"
29820 When this parameter is given, the callout cache is neither read nor updated.
29821
29822 .vitem &*postmaster*&
29823 .cindex "callout" "postmaster; checking"
29824 When this parameter is set, a successful callout check is followed by a similar
29825 check for the local part &'postmaster'& at the same domain. If this address is
29826 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29827 the postmaster check is recorded in a cache record; if it is a failure, this is
29828 used to fail subsequent callouts for the domain without a connection being
29829 made, until the cache record expires.
29830
29831 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29832 The postmaster check uses an empty sender in the MAIL command by default.
29833 You can use this parameter to do a postmaster check using a different address.
29834 For example:
29835 .code
29836 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29837 .endd
29838 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29839 one overrides. The &%postmaster%& parameter is equivalent to this example:
29840 .code
29841 require  verify = sender/callout=postmaster_mailfrom=
29842 .endd
29843 &*Warning*&: The caching arrangements for postmaster checking do not take
29844 account of the sender address. It is assumed that either the empty address or
29845 a fixed non-empty address will be used. All that Exim remembers is that the
29846 postmaster check for the domain succeeded or failed.
29847
29848
29849 .vitem &*random*&
29850 .cindex "callout" "&""random""& check"
29851 When this parameter is set, before doing the normal callout check, Exim does a
29852 check for a &"random"& local part at the same domain. The local part is not
29853 really random &-- it is defined by the expansion of the option
29854 &%callout_random_local_part%&, which defaults to
29855 .code
29856 $primary_hostname-$tod_epoch-testing
29857 .endd
29858 The idea here is to try to determine whether the remote host accepts all local
29859 parts without checking. If it does, there is no point in doing callouts for
29860 specific local parts. If the &"random"& check succeeds, the result is saved in
29861 a cache record, and used to force the current and subsequent callout checks to
29862 succeed without a connection being made, until the cache record expires.
29863
29864 .vitem &*use_postmaster*&
29865 .cindex "callout" "sender for recipient check"
29866 This parameter applies to recipient callouts only. For example:
29867 .code
29868 deny  !verify = recipient/callout=use_postmaster
29869 .endd
29870 .vindex "&$qualify_domain$&"
29871 It causes a non-empty postmaster address to be used in the MAIL command when
29872 performing the callout for the recipient, and also for a &"random"& check if
29873 that is configured. The local part of the address is &`postmaster`& and the
29874 domain is the contents of &$qualify_domain$&.
29875
29876 .vitem &*use_sender*&
29877 This option applies to recipient callouts only. For example:
29878 .code
29879 require  verify = recipient/callout=use_sender
29880 .endd
29881 It causes the message's actual sender address to be used in the MAIL
29882 command when performing the callout, instead of an empty address. There is no
29883 need to use this option unless you know that the called hosts make use of the
29884 sender when checking recipients. If used indiscriminately, it reduces the
29885 usefulness of callout caching.
29886 .endlist
29887
29888 If you use any of the parameters that set a non-empty sender for the MAIL
29889 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29890 &%use_sender%&), you should think about possible loops. Recipient checking is
29891 usually done between two hosts that are under the same management, and the host
29892 that receives the callouts is not normally configured to do callouts itself.
29893 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29894 these circumstances.
29895
29896 However, if you use a non-empty sender address for a callout to an arbitrary
29897 host, there is the likelihood that the remote host will itself initiate a
29898 callout check back to your host. As it is checking what appears to be a message
29899 sender, it is likely to use an empty address in MAIL, thus avoiding a
29900 callout loop. However, to be on the safe side it would be best to set up your
29901 own ACLs so that they do not do sender verification checks when the recipient
29902 is the address you use for header sender or postmaster callout checking.
29903
29904 Another issue to think about when using non-empty senders for callouts is
29905 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29906 by the sender/recipient combination; thus, for any given recipient, many more
29907 actual callouts are performed than when an empty sender or postmaster is used.
29908
29909
29910
29911
29912 .section "Callout caching" "SECTcallvercache"
29913 .cindex "hints database" "callout cache"
29914 .cindex "callout" "cache, description of"
29915 .cindex "caching" "callout"
29916 Exim caches the results of callouts in order to reduce the amount of resources
29917 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29918 option. A hints database called &"callout"& is used for the cache. Two
29919 different record types are used: one records the result of a callout check for
29920 a specific address, and the other records information that applies to the
29921 entire domain (for example, that it accepts the local part &'postmaster'&).
29922
29923 When an original callout fails, a detailed SMTP error message is given about
29924 the failure. However, for subsequent failures use the cache data, this message
29925 is not available.
29926
29927 The expiry times for negative and positive address cache records are
29928 independent, and can be set by the global options &%callout_negative_expire%&
29929 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29930
29931 If a host gives a negative response to an SMTP connection, or rejects any
29932 commands up to and including
29933 .code
29934 MAIL FROM:<>
29935 .endd
29936 (but not including the MAIL command with a non-empty address),
29937 any callout attempt is bound to fail. Exim remembers such failures in a
29938 domain cache record, which it uses to fail callouts for the domain without
29939 making new connections, until the domain record times out. There are two
29940 separate expiry times for domain cache records:
29941 &%callout_domain_negative_expire%& (default 3h) and
29942 &%callout_domain_positive_expire%& (default 7d).
29943
29944 Domain records expire when the negative expiry time is reached if callouts
29945 cannot be made for the domain, or if the postmaster check failed.
29946 Otherwise, they expire when the positive expiry time is reached. This
29947 ensures that, for example, a host that stops accepting &"random"& local parts
29948 will eventually be noticed.
29949
29950 The callout caching mechanism is based on the domain of the address that is
29951 being tested. If the domain routes to several hosts, it is assumed that their
29952 behaviour will be the same.
29953
29954
29955
29956 .section "Sender address verification reporting" "SECTsenaddver"
29957 .cindex "verifying" "suppressing error details"
29958 See section &<<SECTaddressverification>>& for a general discussion of
29959 verification. When sender verification fails in an ACL, the details of the
29960 failure are given as additional output lines before the 550 response to the
29961 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29962 you might see:
29963 .code
29964 MAIL FROM:<xyz@abc.example>
29965 250 OK
29966 RCPT TO:<pqr@def.example>
29967 550-Verification failed for <xyz@abc.example>
29968 550-Called:   192.168.34.43
29969 550-Sent:     RCPT TO:<xyz@abc.example>
29970 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29971 550 Sender verification failed
29972 .endd
29973 If more than one RCPT command fails in the same way, the details are given
29974 only for the first of them. However, some administrators do not want to send
29975 out this much information. You can suppress the details by adding
29976 &`/no_details`& to the ACL statement that requests sender verification. For
29977 example:
29978 .code
29979 verify = sender/no_details
29980 .endd
29981
29982 .section "Redirection while verifying" "SECTredirwhilveri"
29983 .cindex "verifying" "redirection while"
29984 .cindex "address redirection" "while verifying"
29985 A dilemma arises when a local address is redirected by aliasing or forwarding
29986 during verification: should the generated addresses themselves be verified,
29987 or should the successful expansion of the original address be enough to verify
29988 it? By default, Exim takes the following pragmatic approach:
29989
29990 .ilist
29991 When an incoming address is redirected to just one child address, verification
29992 continues with the child address, and if that fails to verify, the original
29993 verification also fails.
29994 .next
29995 When an incoming address is redirected to more than one child address,
29996 verification does not continue. A success result is returned.
29997 .endlist
29998
29999 This seems the most reasonable behaviour for the common use of aliasing as a
30000 way of redirecting different local parts to the same mailbox. It means, for
30001 example, that a pair of alias entries of the form
30002 .code
30003 A.Wol:   aw123
30004 aw123:   :fail: Gone away, no forwarding address
30005 .endd
30006 work as expected, with both local parts causing verification failure. When a
30007 redirection generates more than one address, the behaviour is more like a
30008 mailing list, where the existence of the alias itself is sufficient for
30009 verification to succeed.
30010
30011 It is possible, however, to change the default behaviour so that all successful
30012 redirections count as successful verifications, however many new addresses are
30013 generated. This is specified by the &%success_on_redirect%& verification
30014 option. For example:
30015 .code
30016 require verify = recipient/success_on_redirect/callout=10s
30017 .endd
30018 In this example, verification succeeds if a router generates a new address, and
30019 the callout does not occur, because no address was routed to a remote host.
30020
30021 When verification is being tested via the &%-bv%& option, the treatment of
30022 redirections is as just described, unless the &%-v%& or any debugging option is
30023 also specified. In that case, full verification is done for every generated
30024 address and a report is output for each of them.
30025
30026
30027
30028 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30029 .cindex "CSA" "verifying"
30030 Client SMTP Authorization is a system that allows a site to advertise
30031 which machines are and are not permitted to send email. This is done by placing
30032 special SRV records in the DNS; these are looked up using the client's HELO
30033 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30034 Authorization checks in Exim are performed by the ACL condition:
30035 .code
30036 verify = csa
30037 .endd
30038 This fails if the client is not authorized. If there is a DNS problem, or if no
30039 valid CSA SRV record is found, or if the client is authorized, the condition
30040 succeeds. These three cases can be distinguished using the expansion variable
30041 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30042 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30043 be likely to cause problems for legitimate email.
30044
30045 The error messages produced by the CSA code include slightly more
30046 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30047 looking up the CSA SRV record, or problems looking up the CSA target
30048 address record. There are four reasons for &$csa_status$& being &"fail"&:
30049
30050 .ilist
30051 The client's host name is explicitly not authorized.
30052 .next
30053 The client's IP address does not match any of the CSA target IP addresses.
30054 .next
30055 The client's host name is authorized but it has no valid target IP addresses
30056 (for example, the target's addresses are IPv6 and the client is using IPv4).
30057 .next
30058 The client's host name has no CSA SRV record but a parent domain has asserted
30059 that all subdomains must be explicitly authorized.
30060 .endlist
30061
30062 The &%csa%& verification condition can take an argument which is the domain to
30063 use for the DNS query. The default is:
30064 .code
30065 verify = csa/$sender_helo_name
30066 .endd
30067 This implementation includes an extension to CSA. If the query domain
30068 is an address literal such as [192.0.2.95], or if it is a bare IP
30069 address, Exim searches for CSA SRV records in the reverse DNS as if
30070 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30071 meaningful to say:
30072 .code
30073 verify = csa/$sender_host_address
30074 .endd
30075 In fact, this is the check that Exim performs if the client does not say HELO.
30076 This extension can be turned off by setting the main configuration option
30077 &%dns_csa_use_reverse%& to be false.
30078
30079 If a CSA SRV record is not found for the domain itself, a search
30080 is performed through its parent domains for a record which might be
30081 making assertions about subdomains. The maximum depth of this search is limited
30082 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30083 default. Exim does not look for CSA SRV records in a top level domain, so the
30084 default settings handle HELO domains as long as seven
30085 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30086 of legitimate HELO domains.
30087
30088 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30089 direct SRV lookups, this is not sufficient because of the extra parent domain
30090 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30091 addresses into lookups in the reverse DNS space. The result of a successful
30092 lookup such as:
30093 .code
30094 ${lookup dnsdb {csa=$sender_helo_name}}
30095 .endd
30096 has two space-separated fields: an authorization code and a target host name.
30097 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30098 authorization required but absent, or &"?"& for unknown.
30099
30100
30101
30102
30103 .section "Bounce address tag validation" "SECTverifyPRVS"
30104 .cindex "BATV, verifying"
30105 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30106 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30107 Genuine incoming bounce messages should therefore always be addressed to
30108 recipients that have a valid tag. This scheme is a way of detecting unwanted
30109 bounce messages caused by sender address forgeries (often called &"collateral
30110 spam"&), because the recipients of such messages do not include valid tags.
30111
30112 There are two expansion items to help with the implementation of the BATV
30113 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30114 the original envelope sender address by using a simple key to add a hash of the
30115 address and some time-based randomizing information. The &%prvs%& expansion
30116 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30117 The syntax of these expansion items is described in section
30118 &<<SECTexpansionitems>>&.
30119
30120 As an example, suppose the secret per-address keys are stored in an MySQL
30121 database. A query to look up the key for an address could be defined as a macro
30122 like this:
30123 .code
30124 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30125                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30126                 }{$value}}
30127 .endd
30128 Suppose also that the senders who make use of BATV are defined by an address
30129 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30130 use this:
30131 .code
30132 # Bounces: drop unsigned addresses for BATV senders
30133 deny message = This address does not send an unsigned reverse path
30134      senders = :
30135      recipients = +batv_senders
30136
30137 # Bounces: In case of prvs-signed address, check signature.
30138 deny message = Invalid reverse path signature.
30139      senders = :
30140      condition  = ${prvscheck {$local_part@$domain}\
30141                   {PRVSCHECK_SQL}{1}}
30142      !condition = $prvscheck_result
30143 .endd
30144 The first statement rejects recipients for bounce messages that are addressed
30145 to plain BATV sender addresses, because it is known that BATV senders do not
30146 send out messages with plain sender addresses. The second statement rejects
30147 recipients that are prvs-signed, but with invalid signatures (either because
30148 the key is wrong, or the signature has timed out).
30149
30150 A non-prvs-signed address is not rejected by the second statement, because the
30151 &%prvscheck%& expansion yields an empty string if its first argument is not a
30152 prvs-signed address, thus causing the &%condition%& condition to be false. If
30153 the first argument is a syntactically valid prvs-signed address, the yield is
30154 the third string (in this case &"1"&), whether or not the cryptographic and
30155 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30156 of the checks (empty for failure, &"1"& for success).
30157
30158 There is one more issue you must consider when implementing prvs-signing:
30159 you have to ensure that the routers accept prvs-signed addresses and
30160 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30161 router to remove the signature with a configuration along these lines:
30162 .code
30163 batv_redirect:
30164   driver = redirect
30165   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30166 .endd
30167 This works because, if the third argument of &%prvscheck%& is empty, the result
30168 of the expansion of a prvs-signed address is the decoded value of the original
30169 address. This router should probably be the first of your routers that handles
30170 local addresses.
30171
30172 To create BATV-signed addresses in the first place, a transport of this form
30173 can be used:
30174 .code
30175 external_smtp_batv:
30176   driver = smtp
30177   return_path = ${prvs {$return_path} \
30178                        {${lookup mysql{SELECT \
30179                        secret FROM batv_prvs WHERE \
30180                        sender='${quote_mysql:$sender_address}'} \
30181                        {$value}fail}}}
30182 .endd
30183 If no key can be found for the existing return path, no signing takes place.
30184
30185
30186
30187 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30188 .cindex "&ACL;" "relay control"
30189 .cindex "relaying" "control by ACL"
30190 .cindex "policy control" "relay control"
30191 An MTA is said to &'relay'& a message if it receives it from some host and
30192 delivers it directly to another host as a result of a remote address contained
30193 within it. Redirecting a local address via an alias or forward file and then
30194 passing the message on to another host is not relaying,
30195 .cindex "&""percent hack""&"
30196 but a redirection as a result of the &"percent hack"& is.
30197
30198 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30199 A host which is acting as a gateway or an MX backup is concerned with incoming
30200 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30201 a host which is acting as a smart host for a number of clients is concerned
30202 with outgoing relaying from those clients to the Internet at large. Often the
30203 same host is fulfilling both functions,
30204 . ///
30205 . as illustrated in the diagram below,
30206 . ///
30207 but in principle these two kinds of relaying are entirely independent. What is
30208 not wanted is the transmission of mail from arbitrary remote hosts through your
30209 system to arbitrary domains.
30210
30211
30212 You can implement relay control by means of suitable statements in the ACL that
30213 runs for each RCPT command. For convenience, it is often easiest to use
30214 Exim's named list facility to define the domains and hosts involved. For
30215 example, suppose you want to do the following:
30216
30217 .ilist
30218 Deliver a number of domains to mailboxes on the local host (or process them
30219 locally in some other way). Let's say these are &'my.dom1.example'& and
30220 &'my.dom2.example'&.
30221 .next
30222 Relay mail for a number of other domains for which you are the secondary MX.
30223 These might be &'friend1.example'& and &'friend2.example'&.
30224 .next
30225 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30226 Suppose your LAN is 192.168.45.0/24.
30227 .endlist
30228
30229
30230 In the main part of the configuration, you put the following definitions:
30231 .code
30232 domainlist local_domains    = my.dom1.example : my.dom2.example
30233 domainlist relay_to_domains = friend1.example : friend2.example
30234 hostlist   relay_from_hosts = 192.168.45.0/24
30235 .endd
30236 Now you can use these definitions in the ACL that is run for every RCPT
30237 command:
30238 .code
30239 acl_check_rcpt:
30240   accept domains = +local_domains : +relay_to_domains
30241   accept hosts   = +relay_from_hosts
30242 .endd
30243 The first statement accepts any RCPT command that contains an address in
30244 the local or relay domains. For any other domain, control passes to the second
30245 statement, which accepts the command only if it comes from one of the relay
30246 hosts. In practice, you will probably want to make your ACL more sophisticated
30247 than this, for example, by including sender and recipient verification. The
30248 default configuration includes a more comprehensive example, which is described
30249 in chapter &<<CHAPdefconfil>>&.
30250
30251
30252
30253 .section "Checking a relay configuration" "SECTcheralcon"
30254 .cindex "relaying" "checking control of"
30255 You can check the relay characteristics of your configuration in the same way
30256 that you can test any ACL behaviour for an incoming SMTP connection, by using
30257 the &%-bh%& option to run a fake SMTP session with which you interact.
30258
30259 For specifically testing for unwanted relaying, the host
30260 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30261 host from the host on which Exim is running, using the normal telnet port, you
30262 will see a normal telnet connection message and then quite a long delay. Be
30263 patient. The remote host is making an SMTP connection back to your host, and
30264 trying a number of common probes to test for open relay vulnerability. The
30265 results of the tests will eventually appear on your terminal.
30266 .ecindex IIDacl
30267
30268
30269
30270 . ////////////////////////////////////////////////////////////////////////////
30271 . ////////////////////////////////////////////////////////////////////////////
30272
30273 .chapter "Content scanning at ACL time" "CHAPexiscan"
30274 .scindex IIDcosca "content scanning" "at ACL time"
30275 The extension of Exim to include content scanning at ACL time, formerly known
30276 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30277 was integrated into the main source for Exim release 4.50, and Tom continues to
30278 maintain it. Most of the wording of this chapter is taken from Tom's
30279 specification.
30280
30281 It is also possible to scan the content of messages at other times. The
30282 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30283 scanning after all the ACLs have run. A transport filter can be used to scan
30284 messages at delivery time (see the &%transport_filter%& option, described in
30285 chapter &<<CHAPtransportgeneric>>&).
30286
30287 If you want to include the ACL-time content-scanning features when you compile
30288 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30289 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30290
30291 .ilist
30292 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30293 for all MIME parts for SMTP and non-SMTP messages, respectively.
30294 .next
30295 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30296 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30297 run at the end of message reception (the &%acl_smtp_data%& ACL).
30298 .next
30299 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30300 of messages, or parts of messages, for debugging purposes.
30301 .next
30302 Additional expansion variables that are set in the new ACL and by the new
30303 conditions.
30304 .next
30305 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30306 .endlist
30307
30308 There is another content-scanning configuration option for &_Local/Makefile_&,
30309 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30310 condition is compiled, in addition to all the other content-scanning features.
30311
30312 Content-scanning is continually evolving, and new features are still being
30313 added. While such features are still unstable and liable to incompatible
30314 changes, they are made available in Exim by setting options whose names begin
30315 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30316 this manual. You can find out about them by reading the file called
30317 &_doc/experimental.txt_&.
30318
30319 All the content-scanning facilities work on a MBOX copy of the message that is
30320 temporarily created in a file called:
30321 .display
30322 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30323 .endd
30324 The &_.eml_& extension is a friendly hint to virus scanners that they can
30325 expect an MBOX-like structure inside that file. The file is created when the
30326 first content scanning facility is called. Subsequent calls to content
30327 scanning conditions open the same file again. The directory is recursively
30328 removed when the &%acl_smtp_data%& ACL has finished running, unless
30329 .code
30330 control = no_mbox_unspool
30331 .endd
30332 has been encountered. When the MIME ACL decodes files, they are put into the
30333 same directory by default.
30334
30335
30336
30337 .section "Scanning for viruses" "SECTscanvirus"
30338 .cindex "virus scanning"
30339 .cindex "content scanning" "for viruses"
30340 .cindex "content scanning" "the &%malware%& condition"
30341 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30342 It supports a &"generic"& interface to scanners called via the shell, and
30343 specialized interfaces for &"daemon"& type virus scanners, which are resident
30344 in memory and thus are much faster.
30345
30346 A timeout of 2 minutes is applied to a scanner call (by default);
30347 if it expires then a defer action is taken.
30348
30349 .oindex "&%av_scanner%&"
30350 You can set the &%av_scanner%& option in the main part of the configuration
30351 to specify which scanner to use, together with any additional options that
30352 are needed. The basic syntax is as follows:
30353 .display
30354 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30355 .endd
30356 If you do not set &%av_scanner%&, it defaults to
30357 .code
30358 av_scanner = sophie:/var/run/sophie
30359 .endd
30360 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30361 before use.
30362 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30363 The following scanner types are supported in this release:
30364
30365 .vlist
30366 .vitem &%avast%&
30367 .cindex "virus scanners" "avast"
30368 This is the scanner daemon of Avast. It has been tested with Avast Core
30369 Security (currenty at version 1.1.7).
30370 You can get a trial version at &url(http://www.avast.com) or for Linux
30371 at &url(http://www.avast.com/linux-server-antivirus).
30372 This scanner type takes one option,
30373 which can be either a full path to a UNIX socket,
30374 or host and port specifiers separated by white space.
30375 The host may be a name or an IP address; the port is either a
30376 single number or a pair of numbers with a dash between.
30377 Any further options are given, on separate lines,
30378 to the daemon as options before the main scan command.
30379 For example:
30380 .code
30381 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30382 av_scanner = avast:192.168.2.22 5036
30383 .endd
30384 If you omit the argument, the default path
30385 &_/var/run/avast/scan.sock_&
30386 is used.
30387 If you use a remote host,
30388 you need to make Exim's spool directory available to it,
30389 as the scanner is passed a file path, not file contents.
30390 For information about available commands and their options you may use 
30391 .code
30392 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30393     FLAGS
30394     SENSITIVITY
30395     PACK
30396 .endd
30397
30398
30399 .vitem &%aveserver%&
30400 .cindex "virus scanners" "Kaspersky"
30401 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30402 at &url(http://www.kaspersky.com). This scanner type takes one option,
30403 which is the path to the daemon's UNIX socket. The default is shown in this
30404 example:
30405 .code
30406 av_scanner = aveserver:/var/run/aveserver
30407 .endd
30408
30409
30410 .vitem &%clamd%&
30411 .cindex "virus scanners" "clamd"
30412 This daemon-type scanner is GPL and free. You can get it at
30413 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30414 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30415 in the MIME ACL. This no longer believed to be necessary. One option is
30416 required: either the path and name of a UNIX socket file, or a hostname or IP
30417 number, and a port, separated by space, as in the second of these examples:
30418 .code
30419 av_scanner = clamd:/opt/clamd/socket
30420 av_scanner = clamd:192.0.2.3 1234
30421 av_scanner = clamd:192.0.2.3 1234:local
30422 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30423 .endd
30424 If the value of av_scanner points to a UNIX socket file or contains the local
30425 keyword, then the ClamAV interface will pass a filename containing the data
30426 to be scanned, which will should normally result in less I/O happening and be
30427 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30428 Exim does not assume that there is a common filesystem with the remote host.
30429 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30430 you be running a version of ClamAV prior to 0.95.
30431
30432 The final example shows that multiple TCP targets can be specified.  Exim will
30433 randomly use one for each incoming email (i.e. it load balances them).  Note
30434 that only TCP targets may be used if specifying a list of scanners; a UNIX
30435 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30436 unavailable, Exim will try the remaining one(s) until it finds one that works.
30437 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30438 not keep track of scanner state between multiple messages, and the scanner
30439 selection is random, so the message will get logged in the mainlog for each
30440 email that the down scanner gets chosen first (message wrapped to be readable):
30441 .code
30442 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30443    clamd: connection to localhost, port 3310 failed
30444    (Connection refused)
30445 .endd
30446
30447 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30448 contributing the code for this scanner.
30449
30450 .vitem &%cmdline%&
30451 .cindex "virus scanners" "command line interface"
30452 This is the keyword for the generic command line scanner interface. It can be
30453 used to attach virus scanners that are invoked from the shell. This scanner
30454 type takes 3 mandatory options:
30455
30456 .olist
30457 The full path and name of the scanner binary, with all command line options,
30458 and a placeholder (&`%s`&) for the directory to scan.
30459
30460 .next
30461 A regular expression to match against the STDOUT and STDERR output of the
30462 virus scanner. If the expression matches, a virus was found. You must make
30463 absolutely sure that this expression matches on &"virus found"&. This is called
30464 the &"trigger"& expression.
30465
30466 .next
30467 Another regular expression, containing exactly one pair of parentheses, to
30468 match the name of the virus found in the scanners output. This is called the
30469 &"name"& expression.
30470 .endlist olist
30471
30472 For example, Sophos Sweep reports a virus on a line like this:
30473 .code
30474 Virus 'W32/Magistr-B' found in file ./those.bat
30475 .endd
30476 For the trigger expression, we can match the phrase &"found in file"&. For the
30477 name expression, we want to extract the W32/Magistr-B string, so we can match
30478 for the single quotes left and right of it. Altogether, this makes the
30479 configuration setting:
30480 .code
30481 av_scanner = cmdline:\
30482              /path/to/sweep -ss -all -rec -archive %s:\
30483              found in file:'(.+)'
30484 .endd
30485 .vitem &%drweb%&
30486 .cindex "virus scanners" "DrWeb"
30487 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30488 takes one option,
30489 either a full path to a UNIX socket,
30490 or host and port specifiers separated by white space.
30491 The host may be a name or an IP address; the port is either a
30492 single number or a pair of numbers with a dash between.
30493 For example:
30494 .code
30495 av_scanner = drweb:/var/run/drwebd.sock
30496 av_scanner = drweb:192.168.2.20 31337
30497 .endd
30498 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30499 is used. Thanks to Alex Miller for contributing the code for this scanner.
30500
30501 .vitem &%fsecure%&
30502 .cindex "virus scanners" "F-Secure"
30503 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30504 argument which is the path to a UNIX socket. For example:
30505 .code
30506 av_scanner = fsecure:/path/to/.fsav
30507 .endd
30508 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30509 Thelmen for contributing the code for this scanner.
30510
30511 .vitem &%kavdaemon%&
30512 .cindex "virus scanners" "Kaspersky"
30513 This is the scanner daemon of Kaspersky Version 4. This version of the
30514 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30515 scanner type takes one option, which is the path to the daemon's UNIX socket.
30516 For example:
30517 .code
30518 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30519 .endd
30520 The default path is &_/var/run/AvpCtl_&.
30521
30522 .vitem &%mksd%&
30523 .cindex "virus scanners" "mksd"
30524 This is a daemon type scanner that is aimed mainly at Polish users, though some
30525 parts of documentation are now available in English. You can get it at
30526 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30527 the maximum number of processes used simultaneously to scan the attachments,
30528 provided that the demime facility is employed and also provided that mksd has
30529 been run with at least the same number of child processes. For example:
30530 .code
30531 av_scanner = mksd:2
30532 .endd
30533 You can safely omit this option (the default value is 1).
30534
30535 .vitem &%sock%&
30536 .cindex "virus scanners" "simple socket-connected"
30537 This is a general-purpose way of talking to simple scanner daemons
30538 running on the local machine.
30539 There are four options:
30540 an address (which may be an IP addres and port, or the path of a Unix socket),
30541 a commandline to send (may include a single %s which will be replaced with
30542 the path to the mail file to be scanned),
30543 an RE to trigger on from the returned data,
30544 an RE to extract malware_name from the returned data.
30545 For example:
30546 .code
30547 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30548 .endd
30549 Default for the socket specifier is &_/tmp/malware.sock_&.
30550 Default for the commandline is &_%s\n_&.
30551 Both regular-expressions are required.
30552
30553 .vitem &%sophie%&
30554 .cindex "virus scanners" "Sophos and Sophie"
30555 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30556 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30557 for this scanner type is the path to the UNIX socket that Sophie uses for
30558 client communication. For example:
30559 .code
30560 av_scanner = sophie:/tmp/sophie
30561 .endd
30562 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30563 the option.
30564 .endlist
30565
30566 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30567 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30568 ACL.
30569
30570 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30571 makes it possible to use different scanners. See further below for an example.
30572 The &%malware%& condition caches its results, so when you use it multiple times
30573 for the same message, the actual scanning process is only carried out once.
30574 However, using expandable items in &%av_scanner%& disables this caching, in
30575 which case each use of the &%malware%& condition causes a new scan of the
30576 message.
30577
30578 The &%malware%& condition takes a right-hand argument that is expanded before
30579 use and taken as a list, slash-separated by default.
30580 The first element can then be one of
30581
30582 .ilist
30583 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30584 The condition succeeds if a virus was found, and fail otherwise. This is the
30585 recommended usage.
30586 .next
30587 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30588 the condition fails immediately.
30589 .next
30590 A regular expression, in which case the message is scanned for viruses. The
30591 condition succeeds if a virus is found and its name matches the regular
30592 expression. This allows you to take special actions on certain types of virus.
30593 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30594 unless the separator is changed (in the usual way).
30595 .endlist
30596
30597 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30598 messages even if there is a problem with the virus scanner.
30599 Otherwise, such a problem causes the ACL to defer.
30600
30601 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30602 specify a non-default timeout.  The default is two minutes.
30603 For example:
30604 .code
30605 malware = * / defer_ok / tmo=10s
30606 .endc
30607 A timeout causes the ACL to defer.
30608
30609 .vindex "&$malware_name$&"
30610 When a virus is found, the condition sets up an expansion variable called
30611 &$malware_name$& that contains the name of the virus. You can use it in a
30612 &%message%& modifier that specifies the error returned to the sender, and/or in
30613 logging data.
30614
30615 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30616 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30617 &%malware%& condition.
30618
30619 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30620 imposed by your anti-virus scanner.
30621
30622 Here is a very simple scanning example:
30623 .code
30624 deny message = This message contains malware ($malware_name)
30625      demime = *
30626      malware = *
30627 .endd
30628 The next example accepts messages when there is a problem with the scanner:
30629 .code
30630 deny message = This message contains malware ($malware_name)
30631      demime = *
30632      malware = */defer_ok
30633 .endd
30634 The next example shows how to use an ACL variable to scan with both sophie and
30635 aveserver. It assumes you have set:
30636 .code
30637 av_scanner = $acl_m0
30638 .endd
30639 in the main Exim configuration.
30640 .code
30641 deny message = This message contains malware ($malware_name)
30642      set acl_m0 = sophie
30643      malware = *
30644
30645 deny message = This message contains malware ($malware_name)
30646      set acl_m0 = aveserver
30647      malware = *
30648 .endd
30649
30650
30651 .section "Scanning with SpamAssassin" "SECTscanspamass"
30652 .cindex "content scanning" "for spam"
30653 .cindex "spam scanning"
30654 .cindex "SpamAssassin"
30655 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30656 score and a report for the message. You can get SpamAssassin at
30657 &url(http://www.spamassassin.org), or, if you have a working Perl
30658 installation, you can use CPAN by running:
30659 .code
30660 perl -MCPAN -e 'install Mail::SpamAssassin'
30661 .endd
30662 SpamAssassin has its own set of configuration files. Please review its
30663 documentation to see how you can tweak it. The default installation should work
30664 nicely, however.
30665
30666 .oindex "&%spamd_address%&"
30667 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30668 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30669 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30670 part of the Exim configuration as follows (example):
30671 .code
30672 spamd_address = 192.168.99.45 387
30673 .endd
30674 You do not need to set this option if you use the default. As of version 2.60,
30675 &%spamd%& also supports communication over UNIX sockets. If you want to use
30676 these, supply &%spamd_address%& with an absolute file name instead of a
30677 address/port pair:
30678 .code
30679 spamd_address = /var/run/spamd_socket
30680 .endd
30681 You can have multiple &%spamd%& servers to improve scalability. These can
30682 reside on other hardware reachable over the network. To specify multiple
30683 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30684 option, separated with colons:
30685 .code
30686 spamd_address = 192.168.2.10 783 : \
30687                 192.168.2.11 783 : \
30688                 192.168.2.12 783
30689 .endd
30690 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30691 fashion. When a server fails to respond to the connection attempt, all other
30692 servers are tried until one succeeds. If no server responds, the &%spam%&
30693 condition defers.
30694
30695 &*Warning*&: It is not possible to use the UNIX socket connection method with
30696 multiple &%spamd%& servers.
30697
30698 The &%spamd_address%& variable is expanded before use if it starts with
30699 a dollar sign. In this case, the expansion may return a string that is
30700 used as the list so that multiple spamd servers can be the result of an
30701 expansion.
30702
30703 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30704 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30705 .code
30706 deny message = This message was classified as SPAM
30707      spam = joe
30708 .endd
30709 The right-hand side of the &%spam%& condition specifies a name. This is
30710 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30711 to scan using a specific profile, but rather use the SpamAssassin system-wide
30712 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30713 However, you must put something on the right-hand side.
30714
30715 The name allows you to use per-domain or per-user antispam profiles in
30716 principle, but this is not straightforward in practice, because a message may
30717 have multiple recipients, not necessarily all in the same domain. Because the
30718 &%spam%& condition has to be called from a DATA ACL in order to be able to
30719 read the contents of the message, the variables &$local_part$& and &$domain$&
30720 are not set.
30721
30722 The right-hand side of the &%spam%& condition is expanded before being used, so
30723 you can put lookups or conditions there. When the right-hand side evaluates to
30724 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30725
30726
30727 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30728 large ones may cause significant performance degradation. As most spam messages
30729 are quite small, it is recommended that you do not scan the big ones. For
30730 example:
30731 .code
30732 deny message = This message was classified as SPAM
30733      condition = ${if < {$message_size}{10K}}
30734      spam = nobody
30735 .endd
30736
30737 The &%spam%& condition returns true if the threshold specified in the user's
30738 SpamAssassin profile has been matched or exceeded. If you want to use the
30739 &%spam%& condition for its side effects (see the variables below), you can make
30740 it always return &"true"& by appending &`:true`& to the username.
30741
30742 .cindex "spam scanning" "returned variables"
30743 When the &%spam%& condition is run, it sets up a number of expansion
30744 variables. These variables are saved with the received message, thus they are
30745 available for use at delivery time.
30746
30747 .vlist
30748 .vitem &$spam_score$&
30749 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30750 for inclusion in log or reject messages.
30751
30752 .vitem &$spam_score_int$&
30753 The spam score of the message, multiplied by ten, as an integer value. For
30754 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30755 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30756 The integer value is useful for numeric comparisons in conditions.
30757
30758 .vitem &$spam_bar$&
30759 A string consisting of a number of &"+"& or &"-"& characters, representing the
30760 integer part of the spam score value. A spam score of 4.4 would have a
30761 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30762 headers, since MUAs can match on such strings.
30763
30764 .vitem &$spam_report$&
30765 A multiline text table, containing the full SpamAssassin report for the
30766 message. Useful for inclusion in headers or reject messages.
30767 .endlist
30768
30769 The &%spam%& condition caches its results unless expansion in
30770 spamd_address was used. If you call it again with the same user name, it
30771 does not scan again, but rather returns the same values as before.
30772
30773 The &%spam%& condition returns DEFER if there is any error while running
30774 the message through SpamAssassin or if the expansion of spamd_address
30775 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30776 statement block), append &`/defer_ok`& to the right-hand side of the
30777 spam condition, like this:
30778 .code
30779 deny message = This message was classified as SPAM
30780      spam    = joe/defer_ok
30781 .endd
30782 This causes messages to be accepted even if there is a problem with &%spamd%&.
30783
30784 Here is a longer, commented example of the use of the &%spam%&
30785 condition:
30786 .code
30787 # put headers in all messages (no matter if spam or not)
30788 warn  spam = nobody:true
30789       add_header = X-Spam-Score: $spam_score ($spam_bar)
30790       add_header = X-Spam-Report: $spam_report
30791
30792 # add second subject line with *SPAM* marker when message
30793 # is over threshold
30794 warn  spam = nobody
30795       add_header = Subject: *SPAM* $h_Subject:
30796
30797 # reject spam at high scores (> 12)
30798 deny  message = This message scored $spam_score spam points.
30799       spam = nobody:true
30800       condition = ${if >{$spam_score_int}{120}{1}{0}}
30801 .endd
30802
30803
30804
30805 .section "Scanning MIME parts" "SECTscanmimepart"
30806 .cindex "content scanning" "MIME parts"
30807 .cindex "MIME content scanning"
30808 .oindex "&%acl_smtp_mime%&"
30809 .oindex "&%acl_not_smtp_mime%&"
30810 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30811 each MIME part of an SMTP message, including multipart types, in the sequence
30812 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30813 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30814 options may both refer to the same ACL if you want the same processing in both
30815 cases.
30816
30817 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30818 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30819 the case of a non-SMTP message. However, a MIME ACL is called only if the
30820 message contains a &'Content-Type:'& header line. When a call to a MIME
30821 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30822 result code is sent to the client. In the case of an SMTP message, the
30823 &%acl_smtp_data%& ACL is not called when this happens.
30824
30825 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30826 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30827 condition to match against the raw MIME part. You can also use the
30828 &%mime_regex%& condition to match against the decoded MIME part (see section
30829 &<<SECTscanregex>>&).
30830
30831 At the start of a MIME ACL, a number of variables are set from the header
30832 information for the relevant MIME part. These are described below. The contents
30833 of the MIME part are not by default decoded into a disk file except for MIME
30834 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30835 part into a disk file, you can use the &%decode%& condition. The general
30836 syntax is:
30837 .display
30838 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30839 .endd
30840 The right hand side is expanded before use. After expansion,
30841 the value can be:
30842
30843 .olist
30844 &"0"& or &"false"&, in which case no decoding is done.
30845 .next
30846 The string &"default"&. In that case, the file is put in the temporary
30847 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30848 a sequential file name consisting of the message id and a sequence number. The
30849 full path and name is available in &$mime_decoded_filename$& after decoding.
30850 .next
30851 A full path name starting with a slash. If the full name is an existing
30852 directory, it is used as a replacement for the default directory. The filename
30853 is then sequentially assigned. If the path does not exist, it is used as
30854 the full path and file name.
30855 .next
30856 If the string does not start with a slash, it is used as the
30857 filename, and the default path is then used.
30858 .endlist
30859 The &%decode%& condition normally succeeds. It is only false for syntax
30860 errors or unusual circumstances such as memory shortages. You can easily decode
30861 a file with its original, proposed filename using
30862 .code
30863 decode = $mime_filename
30864 .endd
30865 However, you should keep in mind that &$mime_filename$& might contain
30866 anything. If you place files outside of the default path, they are not
30867 automatically unlinked.
30868
30869 For RFC822 attachments (these are messages attached to messages, with a
30870 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30871 as for the primary message, only that the &$mime_is_rfc822$& expansion
30872 variable is set (see below). Attached messages are always decoded to disk
30873 before being checked, and the files are unlinked once the check is done.
30874
30875 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30876 used to match regular expressions against raw and decoded MIME parts,
30877 respectively. They are described in section &<<SECTscanregex>>&.
30878
30879 .cindex "MIME content scanning" "returned variables"
30880 The following list describes all expansion variables that are
30881 available in the MIME ACL:
30882
30883 .vlist
30884 .vitem &$mime_boundary$&
30885 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30886 have a boundary string, which is stored in this variable. If the current part
30887 has no boundary parameter in the &'Content-Type:'& header, this variable
30888 contains the empty string.
30889
30890 .vitem &$mime_charset$&
30891 This variable contains the character set identifier, if one was found in the
30892 &'Content-Type:'& header. Examples for charset identifiers are:
30893 .code
30894 us-ascii
30895 gb2312 (Chinese)
30896 iso-8859-1
30897 .endd
30898 Please note that this value is not normalized, so you should do matches
30899 case-insensitively.
30900
30901 .vitem &$mime_content_description$&
30902 This variable contains the normalized content of the &'Content-Description:'&
30903 header. It can contain a human-readable description of the parts content. Some
30904 implementations repeat the filename for attachments here, but they are usually
30905 only used for display purposes.
30906
30907 .vitem &$mime_content_disposition$&
30908 This variable contains the normalized content of the &'Content-Disposition:'&
30909 header. You can expect strings like &"attachment"& or &"inline"& here.
30910
30911 .vitem &$mime_content_id$&
30912 This variable contains the normalized content of the &'Content-ID:'& header.
30913 This is a unique ID that can be used to reference a part from another part.
30914
30915 .vitem &$mime_content_size$&
30916 This variable is set only after the &%decode%& modifier (see above) has been
30917 successfully run. It contains the size of the decoded part in kilobytes. The
30918 size is always rounded up to full kilobytes, so only a completely empty part
30919 has a &$mime_content_size$& of zero.
30920
30921 .vitem &$mime_content_transfer_encoding$&
30922 This variable contains the normalized content of the
30923 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30924 type. Typical values are &"base64"& and &"quoted-printable"&.
30925
30926 .vitem &$mime_content_type$&
30927 If the MIME part has a &'Content-Type:'& header, this variable contains its
30928 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30929 are some examples of popular MIME types, as they may appear in this variable:
30930 .code
30931 text/plain
30932 text/html
30933 application/octet-stream
30934 image/jpeg
30935 audio/midi
30936 .endd
30937 If the MIME part has no &'Content-Type:'& header, this variable contains the
30938 empty string.
30939
30940 .vitem &$mime_decoded_filename$&
30941 This variable is set only after the &%decode%& modifier (see above) has been
30942 successfully run. It contains the full path and file name of the file
30943 containing the decoded data.
30944 .endlist
30945
30946 .cindex "RFC 2047"
30947 .vlist
30948 .vitem &$mime_filename$&
30949 This is perhaps the most important of the MIME variables. It contains a
30950 proposed filename for an attachment, if one was found in either the
30951 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30952 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30953 found, this variable contains the empty string.
30954
30955 .vitem &$mime_is_coverletter$&
30956 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30957 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30958 content in the cover letter, while not restricting attachments at all.
30959
30960 The variable contains 1 (true) for a MIME part believed to be part of the
30961 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30962 follows:
30963
30964 .olist
30965 The outermost MIME part of a message is always a cover letter.
30966
30967 .next
30968 If a multipart/alternative or multipart/related MIME part is a cover letter,
30969 so are all MIME subparts within that multipart.
30970
30971 .next
30972 If any other multipart is a cover letter, the first subpart is a cover letter,
30973 and the rest are attachments.
30974
30975 .next
30976 All parts contained within an attachment multipart are attachments.
30977 .endlist olist
30978
30979 As an example, the following will ban &"HTML mail"& (including that sent with
30980 alternative plain text), while allowing HTML files to be attached. HTML
30981 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30982 .code
30983 deny message = HTML mail is not accepted here
30984 !condition = $mime_is_rfc822
30985 condition = $mime_is_coverletter
30986 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30987 .endd
30988 .vitem &$mime_is_multipart$&
30989 This variable has the value 1 (true) when the current part has the main type
30990 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30991 Since multipart entities only serve as containers for other parts, you may not
30992 want to carry out specific actions on them.
30993
30994 .vitem &$mime_is_rfc822$&
30995 This variable has the value 1 (true) if the current part is not a part of the
30996 checked message itself, but part of an attached message. Attached message
30997 decoding is fully recursive.
30998
30999 .vitem &$mime_part_count$&
31000 This variable is a counter that is raised for each processed MIME part. It
31001 starts at zero for the very first part (which is usually a multipart). The
31002 counter is per-message, so it is reset when processing RFC822 attachments (see
31003 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31004 complete, so you can use it in the DATA ACL to determine the number of MIME
31005 parts of a message. For non-MIME messages, this variable contains the value -1.
31006 .endlist
31007
31008
31009
31010 .section "Scanning with regular expressions" "SECTscanregex"
31011 .cindex "content scanning" "with regular expressions"
31012 .cindex "regular expressions" "content scanning with"
31013 You can specify your own custom regular expression matches on the full body of
31014 the message, or on individual MIME parts.
31015
31016 The &%regex%& condition takes one or more regular expressions as arguments and
31017 matches them against the full message (when called in the DATA ACL) or a raw
31018 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31019 linewise, with a maximum line length of 32K characters. That means you cannot
31020 have multiline matches with the &%regex%& condition.
31021
31022 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31023 to 32K of decoded content (the whole content at once, not linewise). If the
31024 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31025 is decoded automatically when &%mime_regex%& is executed (using default path
31026 and filename values). If the decoded data is larger than  32K, only the first
31027 32K characters are checked.
31028
31029 The regular expressions are passed as a colon-separated list. To include a
31030 literal colon, you must double it. Since the whole right-hand side string is
31031 expanded before being used, you must also escape dollar signs and backslashes
31032 with more backslashes, or use the &`\N`& facility to disable expansion.
31033 Here is a simple example that contains two regular expressions:
31034 .code
31035 deny message = contains blacklisted regex ($regex_match_string)
31036      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31037 .endd
31038 The conditions returns true if any one of the regular expressions matches. The
31039 &$regex_match_string$& expansion variable is then set up and contains the
31040 matching regular expression.
31041
31042 &*Warning*&: With large messages, these conditions can be fairly
31043 CPU-intensive.
31044
31045
31046
31047
31048 .section "The demime condition" "SECTdemimecond"
31049 .cindex "content scanning" "MIME checking"
31050 .cindex "MIME content scanning"
31051 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31052 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31053 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31054 ACL functionality, but provides no additional facilities. Please note that this
31055 condition is deprecated and kept only for backward compatibility. You must set
31056 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31057 use the &%demime%& condition.
31058
31059 The &%demime%& condition unpacks MIME containers in the message. It detects
31060 errors in MIME containers and can match file extensions found in the message
31061 against a list. Using this facility produces files containing the unpacked MIME
31062 parts of the message in the temporary scan directory. If you do antivirus
31063 scanning, it is recommended that you use the &%demime%& condition before the
31064 antivirus (&%malware%&) condition.
31065
31066 On the right-hand side of the &%demime%& condition you can pass a
31067 colon-separated list of file extensions that it should match against. For
31068 example:
31069 .code
31070 deny message = Found blacklisted file attachment
31071      demime  = vbs:com:bat:pif:prf:lnk
31072 .endd
31073 If one of the file extensions is found, the condition is true, otherwise it is
31074 false. If there is a temporary error while demimeing (for example, &"disk
31075 full"&), the condition defers, and the message is temporarily rejected (unless
31076 the condition is on a &%warn%& verb).
31077
31078 The right-hand side is expanded before being treated as a list, so you can have
31079 conditions and lookups there. If it expands to an empty string, &"false"&, or
31080 zero (&"0"&), no demimeing is done and the condition is false.
31081
31082 The &%demime%& condition set the following variables:
31083
31084 .vlist
31085 .vitem &$demime_errorlevel$&
31086 .vindex "&$demime_errorlevel$&"
31087 When an error is detected in a MIME container, this variable contains the
31088 severity of the error, as an integer number. The higher the value, the more
31089 severe the error (the current maximum value is 3). If this variable is unset or
31090 zero, no error occurred.
31091
31092 .vitem &$demime_reason$&
31093 .vindex "&$demime_reason$&"
31094 When &$demime_errorlevel$& is greater than zero, this variable contains a
31095 human-readable text string describing the MIME error that occurred.
31096 .endlist
31097
31098 .vlist
31099 .vitem &$found_extension$&
31100 .vindex "&$found_extension$&"
31101 When the &%demime%& condition is true, this variable contains the file
31102 extension it found.
31103 .endlist
31104
31105 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31106 the &%demime%& condition, and are not changed on subsequent calls.
31107
31108 If you do not want to check for file extensions, but rather use the &%demime%&
31109 condition for unpacking or error checking purposes, pass &"*"& as the
31110 right-hand side value. Here is a more elaborate example of how to use this
31111 facility:
31112 .code
31113 # Reject messages with serious MIME container errors
31114 deny  message = Found MIME error ($demime_reason).
31115       demime = *
31116       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31117
31118 # Reject known virus spreading file extensions.
31119 # Accepting these is pretty much braindead.
31120 deny  message = contains $found_extension file (blacklisted).
31121       demime  = com:vbs:bat:pif:scr
31122
31123 # Freeze .exe and .doc files. Postmaster can
31124 # examine them and eventually thaw them.
31125 deny  log_message = Another $found_extension file.
31126       demime = exe:doc
31127       control = freeze
31128 .endd
31129 .ecindex IIDcosca
31130
31131
31132
31133
31134 . ////////////////////////////////////////////////////////////////////////////
31135 . ////////////////////////////////////////////////////////////////////////////
31136
31137 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31138          "Local scan function"
31139 .scindex IIDlosca "&[local_scan()]& function" "description of"
31140 .cindex "customizing" "input scan using C function"
31141 .cindex "policy control" "by local scan function"
31142 In these days of email worms, viruses, and ever-increasing spam, some sites
31143 want to apply a lot of checking to messages before accepting them.
31144
31145 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31146 passing messages to external virus and spam scanning software. You can also do
31147 a certain amount in Exim itself through string expansions and the &%condition%&
31148 condition in the ACL that runs after the SMTP DATA command or the ACL for
31149 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31150
31151 To allow for further customization to a site's own requirements, there is the
31152 possibility of linking Exim with a private message scanning function, written
31153 in C. If you want to run code that is written in something other than C, you
31154 can of course use a little C stub to call it.
31155
31156 The local scan function is run once for every incoming message, at the point
31157 when Exim is just about to accept the message.
31158 It can therefore be used to control non-SMTP messages from local processes as
31159 well as messages arriving via SMTP.
31160
31161 Exim applies a timeout to calls of the local scan function, and there is an
31162 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31163 Zero means &"no timeout"&.
31164 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31165 before calling the local scan function, so that the most common types of crash
31166 are caught. If the timeout is exceeded or one of those signals is caught, the
31167 incoming message is rejected with a temporary error if it is an SMTP message.
31168 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31169 code. The incident is logged on the main and reject logs.
31170
31171
31172
31173 .section "Building Exim to use a local scan function" "SECID207"
31174 .cindex "&[local_scan()]& function" "building Exim to use"
31175 To make use of the local scan function feature, you must tell Exim where your
31176 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31177 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31178 directory, so you might set
31179 .code
31180 LOCAL_SCAN_SOURCE=Local/local_scan.c
31181 .endd
31182 for example. The function must be called &[local_scan()]&. It is called by
31183 Exim after it has received a message, when the success return code is about to
31184 be sent. This is after all the ACLs have been run. The return code from your
31185 function controls whether the message is actually accepted or not. There is a
31186 commented template function (that just accepts the message) in the file
31187 _src/local_scan.c_.
31188
31189 If you want to make use of Exim's run time configuration file to set options
31190 for your &[local_scan()]& function, you must also set
31191 .code
31192 LOCAL_SCAN_HAS_OPTIONS=yes
31193 .endd
31194 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31195
31196
31197
31198
31199 .section "API for local_scan()" "SECTapiforloc"
31200 .cindex "&[local_scan()]& function" "API description"
31201 You must include this line near the start of your code:
31202 .code
31203 #include "local_scan.h"
31204 .endd
31205 This header file defines a number of variables and other values, and the
31206 prototype for the function itself. Exim is coded to use unsigned char values
31207 almost exclusively, and one of the things this header defines is a shorthand
31208 for &`unsigned char`& called &`uschar`&.
31209 It also contains the following macro definitions, to simplify casting character
31210 strings and pointers to character strings:
31211 .code
31212 #define CS   (char *)
31213 #define CCS  (const char *)
31214 #define CSS  (char **)
31215 #define US   (unsigned char *)
31216 #define CUS  (const unsigned char *)
31217 #define USS  (unsigned char **)
31218 .endd
31219 The function prototype for &[local_scan()]& is:
31220 .code
31221 extern int local_scan(int fd, uschar **return_text);
31222 .endd
31223 The arguments are as follows:
31224
31225 .ilist
31226 &%fd%& is a file descriptor for the file that contains the body of the message
31227 (the -D file). The file is open for reading and writing, but updating it is not
31228 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31229
31230 The descriptor is positioned at character 19 of the file, which is the first
31231 character of the body itself, because the first 19 characters are the message
31232 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31233 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31234 case this changes in some future version.
31235 .next
31236 &%return_text%& is an address which you can use to return a pointer to a text
31237 string at the end of the function. The value it points to on entry is NULL.
31238 .endlist
31239
31240 The function must return an &%int%& value which is one of the following macros:
31241
31242 .vlist
31243 .vitem &`LOCAL_SCAN_ACCEPT`&
31244 .vindex "&$local_scan_data$&"
31245 The message is accepted. If you pass back a string of text, it is saved with
31246 the message, and made available in the variable &$local_scan_data$&. No
31247 newlines are permitted (if there are any, they are turned into spaces) and the
31248 maximum length of text is 1000 characters.
31249
31250 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31251 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31252 queued without immediate delivery, and is frozen.
31253
31254 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31255 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31256 queued without immediate delivery.
31257
31258 .vitem &`LOCAL_SCAN_REJECT`&
31259 The message is rejected; the returned text is used as an error message which is
31260 passed back to the sender and which is also logged. Newlines are permitted &--
31261 they cause a multiline response for SMTP rejections, but are converted to
31262 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31263 used.
31264
31265 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31266 The message is temporarily rejected; the returned text is used as an error
31267 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31268 problem"& is used.
31269
31270 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31271 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31272 message is not written to the reject log. It has the effect of unsetting the
31273 &%rejected_header%& log selector for just this rejection. If
31274 &%rejected_header%& is already unset (see the discussion of the
31275 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31276 same as LOCAL_SCAN_REJECT.
31277
31278 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31279 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31280 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31281 .endlist
31282
31283 If the message is not being received by interactive SMTP, rejections are
31284 reported by writing to &%stderr%& or by sending an email, as configured by the
31285 &%-oe%& command line options.
31286
31287
31288
31289 .section "Configuration options for local_scan()" "SECTconoptloc"
31290 .cindex "&[local_scan()]& function" "configuration options"
31291 It is possible to have option settings in the main configuration file
31292 that set values in static variables in the &[local_scan()]& module. If you
31293 want to do this, you must have the line
31294 .code
31295 LOCAL_SCAN_HAS_OPTIONS=yes
31296 .endd
31297 in your &_Local/Makefile_& when you build Exim. (This line is in
31298 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31299 file, you must define static variables to hold the option values, and a table
31300 to define them.
31301
31302 The table must be a vector called &%local_scan_options%&, of type
31303 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31304 and a pointer to the variable that holds the value. The entries must appear in
31305 alphabetical order. Following &%local_scan_options%& you must also define a
31306 variable called &%local_scan_options_count%& that contains the number of
31307 entries in the table. Here is a short example, showing two kinds of option:
31308 .code
31309 static int my_integer_option = 42;
31310 static uschar *my_string_option = US"a default string";
31311
31312 optionlist local_scan_options[] = {
31313   { "my_integer", opt_int,       &my_integer_option },
31314   { "my_string",  opt_stringptr, &my_string_option }
31315 };
31316
31317 int local_scan_options_count =
31318   sizeof(local_scan_options)/sizeof(optionlist);
31319 .endd
31320 The values of the variables can now be changed from Exim's runtime
31321 configuration file by including a local scan section as in this example:
31322 .code
31323 begin local_scan
31324 my_integer = 99
31325 my_string = some string of text...
31326 .endd
31327 The available types of option data are as follows:
31328
31329 .vlist
31330 .vitem &*opt_bool*&
31331 This specifies a boolean (true/false) option. The address should point to a
31332 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31333 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31334 whether such a variable has been set at all, you can initialize it to
31335 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31336 values.)
31337
31338 .vitem &*opt_fixed*&
31339 This specifies a fixed point number, such as is used for load averages.
31340 The address should point to a variable of type &`int`&. The value is stored
31341 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31342
31343 .vitem &*opt_int*&
31344 This specifies an integer; the address should point to a variable of type
31345 &`int`&. The value may be specified in any of the integer formats accepted by
31346 Exim.
31347
31348 .vitem &*opt_mkint*&
31349 This is the same as &%opt_int%&, except that when such a value is output in a
31350 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31351 printed with the suffix K or M.
31352
31353 .vitem &*opt_octint*&
31354 This also specifies an integer, but the value is always interpreted as an
31355 octal integer, whether or not it starts with the digit zero, and it is
31356 always output in octal.
31357
31358 .vitem &*opt_stringptr*&
31359 This specifies a string value; the address must be a pointer to a
31360 variable that points to a string (for example, of type &`uschar *`&).
31361
31362 .vitem &*opt_time*&
31363 This specifies a time interval value. The address must point to a variable of
31364 type &`int`&. The value that is placed there is a number of seconds.
31365 .endlist
31366
31367 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31368 out the values of all the &[local_scan()]& options.
31369
31370
31371
31372 .section "Available Exim variables" "SECID208"
31373 .cindex "&[local_scan()]& function" "available Exim variables"
31374 The header &_local_scan.h_& gives you access to a number of C variables. These
31375 are the only ones that are guaranteed to be maintained from release to release.
31376 Note, however, that you can obtain the value of any Exim expansion variable,
31377 including &$recipients$&, by calling &'expand_string()'&. The exported
31378 C variables are as follows:
31379
31380 .vlist
31381 .vitem &*int&~body_linecount*&
31382 This variable contains the number of lines in the message's body.
31383
31384 .vitem &*int&~body_zerocount*&
31385 This variable contains the number of binary zero bytes in the message's body.
31386
31387 .vitem &*unsigned&~int&~debug_selector*&
31388 This variable is set to zero when no debugging is taking place. Otherwise, it
31389 is a bitmap of debugging selectors. Two bits are identified for use in
31390 &[local_scan()]&; they are defined as macros:
31391
31392 .ilist
31393 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31394 testing option that is not privileged &-- any caller may set it. All the
31395 other selector bits can be set only by admin users.
31396
31397 .next
31398 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31399 by the &`+local_scan`& debug selector. It is not included in the default set
31400 of debugging bits.
31401 .endlist ilist
31402
31403 Thus, to write to the debugging output only when &`+local_scan`& has been
31404 selected, you should use code like this:
31405 .code
31406 if ((debug_selector & D_local_scan) != 0)
31407   debug_printf("xxx", ...);
31408 .endd
31409 .vitem &*uschar&~*expand_string_message*&
31410 After a failing call to &'expand_string()'& (returned value NULL), the
31411 variable &%expand_string_message%& contains the error message, zero-terminated.
31412
31413 .vitem &*header_line&~*header_list*&
31414 A pointer to a chain of header lines. The &%header_line%& structure is
31415 discussed below.
31416
31417 .vitem &*header_line&~*header_last*&
31418 A pointer to the last of the header lines.
31419
31420 .vitem &*uschar&~*headers_charset*&
31421 The value of the &%headers_charset%& configuration option.
31422
31423 .vitem &*BOOL&~host_checking*&
31424 This variable is TRUE during a host checking session that is initiated by the
31425 &%-bh%& command line option.
31426
31427 .vitem &*uschar&~*interface_address*&
31428 The IP address of the interface that received the message, as a string. This
31429 is NULL for locally submitted messages.
31430
31431 .vitem &*int&~interface_port*&
31432 The port on which this message was received. When testing with the &%-bh%&
31433 command line option, the value of this variable is -1 unless a port has been
31434 specified via the &%-oMi%& option.
31435
31436 .vitem &*uschar&~*message_id*&
31437 This variable contains Exim's message id for the incoming message (the value of
31438 &$message_exim_id$&) as a zero-terminated string.
31439
31440 .vitem &*uschar&~*received_protocol*&
31441 The name of the protocol by which the message was received.
31442
31443 .vitem &*int&~recipients_count*&
31444 The number of accepted recipients.
31445
31446 .vitem &*recipient_item&~*recipients_list*&
31447 .cindex "recipient" "adding in local scan"
31448 .cindex "recipient" "removing in local scan"
31449 The list of accepted recipients, held in a vector of length
31450 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31451 can add additional recipients by calling &'receive_add_recipient()'& (see
31452 below). You can delete recipients by removing them from the vector and
31453 adjusting the value in &%recipients_count%&. In particular, by setting
31454 &%recipients_count%& to zero you remove all recipients. If you then return the
31455 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31456 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31457 and then call &'receive_add_recipient()'& as often as needed.
31458
31459 .vitem &*uschar&~*sender_address*&
31460 The envelope sender address. For bounce messages this is the empty string.
31461
31462 .vitem &*uschar&~*sender_host_address*&
31463 The IP address of the sending host, as a string. This is NULL for
31464 locally-submitted messages.
31465
31466 .vitem &*uschar&~*sender_host_authenticated*&
31467 The name of the authentication mechanism that was used, or NULL if the message
31468 was not received over an authenticated SMTP connection.
31469
31470 .vitem &*uschar&~*sender_host_name*&
31471 The name of the sending host, if known.
31472
31473 .vitem &*int&~sender_host_port*&
31474 The port on the sending host.
31475
31476 .vitem &*BOOL&~smtp_input*&
31477 This variable is TRUE for all SMTP input, including BSMTP.
31478
31479 .vitem &*BOOL&~smtp_batched_input*&
31480 This variable is TRUE for BSMTP input.
31481
31482 .vitem &*int&~store_pool*&
31483 The contents of this variable control which pool of memory is used for new
31484 requests. See section &<<SECTmemhanloc>>& for details.
31485 .endlist
31486
31487
31488 .section "Structure of header lines" "SECID209"
31489 The &%header_line%& structure contains the members listed below.
31490 You can add additional header lines by calling the &'header_add()'& function
31491 (see below). You can cause header lines to be ignored (deleted) by setting
31492 their type to *.
31493
31494
31495 .vlist
31496 .vitem &*struct&~header_line&~*next*&
31497 A pointer to the next header line, or NULL for the last line.
31498
31499 .vitem &*int&~type*&
31500 A code identifying certain headers that Exim recognizes. The codes are printing
31501 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31502 Notice in particular that any header line whose type is * is not transmitted
31503 with the message. This flagging is used for header lines that have been
31504 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31505 lines.) Effectively, * means &"deleted"&.
31506
31507 .vitem &*int&~slen*&
31508 The number of characters in the header line, including the terminating and any
31509 internal newlines.
31510
31511 .vitem &*uschar&~*text*&
31512 A pointer to the text of the header. It always ends with a newline, followed by
31513 a zero byte. Internal newlines are preserved.
31514 .endlist
31515
31516
31517
31518 .section "Structure of recipient items" "SECID210"
31519 The &%recipient_item%& structure contains these members:
31520
31521 .vlist
31522 .vitem &*uschar&~*address*&
31523 This is a pointer to the recipient address as it was received.
31524
31525 .vitem &*int&~pno*&
31526 This is used in later Exim processing when top level addresses are created by
31527 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31528 and must always contain -1 at this stage.
31529
31530 .vitem &*uschar&~*errors_to*&
31531 If this value is not NULL, bounce messages caused by failing to deliver to the
31532 recipient are sent to the address it contains. In other words, it overrides the
31533 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31534 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31535 an unqualified address, Exim qualifies it using the domain from
31536 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31537 is NULL for all recipients.
31538 .endlist
31539
31540
31541
31542 .section "Available Exim functions" "SECID211"
31543 .cindex "&[local_scan()]& function" "available Exim functions"
31544 The header &_local_scan.h_& gives you access to a number of Exim functions.
31545 These are the only ones that are guaranteed to be maintained from release to
31546 release:
31547
31548 .vlist
31549 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31550        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31551
31552 This function creates a child process that runs the command specified by
31553 &%argv%&. The environment for the process is specified by &%envp%&, which can
31554 be NULL if no environment variables are to be passed. A new umask is supplied
31555 for the process in &%newumask%&.
31556
31557 Pipes to the standard input and output of the new process are set up
31558 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31559 standard error is cloned to the standard output. If there are any file
31560 descriptors &"in the way"& in the new process, they are closed. If the final
31561 argument is TRUE, the new process is made into a process group leader.
31562
31563 The function returns the pid of the new process, or -1 if things go wrong.
31564
31565 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31566 This function waits for a child process to terminate, or for a timeout (in
31567 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31568 return value is as follows:
31569
31570 .ilist
31571 >= 0
31572
31573 The process terminated by a normal exit and the value is the process
31574 ending status.
31575
31576 .next
31577 < 0 and > &--256
31578
31579 The process was terminated by a signal and the value is the negation of the
31580 signal number.
31581
31582 .next
31583 &--256
31584
31585 The process timed out.
31586 .next
31587 &--257
31588
31589 The was some other error in wait(); &%errno%& is still set.
31590 .endlist
31591
31592 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31593 This function provide you with a means of submitting a new message to
31594 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31595 want, but this packages it all up for you.) The function creates a pipe,
31596 forks a subprocess that is running
31597 .code
31598 exim -t -oem -oi -f <>
31599 .endd
31600 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31601 that is connected to the standard input. The yield of the function is the PID
31602 of the subprocess. You can then write a message to the file descriptor, with
31603 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31604
31605 When you have finished, call &'child_close()'& to wait for the process to
31606 finish and to collect its ending status. A timeout value of zero is usually
31607 fine in this circumstance. Unless you have made a mistake with the recipient
31608 addresses, you should get a return code of zero.
31609
31610
31611 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31612        *sender_authentication)*&
31613 This function is a more sophisticated version of &'child_open()'&. The command
31614 that it runs is:
31615 .display
31616 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31617 .endd
31618 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31619
31620
31621 .vitem &*void&~debug_printf(char&~*,&~...)*&
31622 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31623 output is written to the standard error stream. If no debugging is selected,
31624 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31625 conditional on the &`local_scan`& debug selector by coding like this:
31626 .code
31627 if ((debug_selector & D_local_scan) != 0)
31628   debug_printf("xxx", ...);
31629 .endd
31630
31631 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31632 This is an interface to Exim's string expansion code. The return value is the
31633 expanded string, or NULL if there was an expansion failure.
31634 The C variable &%expand_string_message%& contains an error message after an
31635 expansion failure. If expansion does not change the string, the return value is
31636 the pointer to the input string. Otherwise, the return value points to a new
31637 block of memory that was obtained by a call to &'store_get()'&. See section
31638 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31639
31640 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31641 This function allows you to an add additional header line at the end of the
31642 existing ones. The first argument is the type, and should normally be a space
31643 character. The second argument is a format string and any number of
31644 substitution arguments as for &[sprintf()]&. You may include internal newlines
31645 if you want, and you must ensure that the string ends with a newline.
31646
31647 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31648         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31649 This function adds a new header line at a specified point in the header
31650 chain. The header itself is specified as for &'header_add()'&.
31651
31652 If &%name%& is NULL, the new header is added at the end of the chain if
31653 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31654 NULL, the header lines are searched for the first non-deleted header that
31655 matches the name. If one is found, the new header is added before it if
31656 &%after%& is false. If &%after%& is true, the new header is added after the
31657 found header and any adjacent subsequent ones with the same name (even if
31658 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31659 option controls where the header is added. If it is true, addition is at the
31660 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31661 headers, or at the top if there are no &'Received:'& headers, you could use
31662 .code
31663 header_add_at_position(TRUE, US"Received", TRUE,
31664   ' ', "X-xxx: ...");
31665 .endd
31666 Normally, there is always at least one non-deleted &'Received:'& header, but
31667 there may not be if &%received_header_text%& expands to an empty string.
31668
31669
31670 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31671 This function removes header lines. If &%occurrence%& is zero or negative, all
31672 occurrences of the header are removed. If occurrence is greater than zero, that
31673 particular instance of the header is removed. If no header(s) can be found that
31674 match the specification, the function does nothing.
31675
31676
31677 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31678         int&~length,&~BOOL&~notdel)*&"
31679 This function tests whether the given header has the given name. It is not just
31680 a string comparison, because white space is permitted between the name and the
31681 colon. If the &%notdel%& argument is true, a false return is forced for all
31682 &"deleted"& headers; otherwise they are not treated specially. For example:
31683 .code
31684 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31685 .endd
31686 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31687 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31688 This function base64-encodes a string, which is passed by address and length.
31689 The text may contain bytes of any value, including zero. The result is passed
31690 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31691 zero-terminated.
31692
31693 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31694 This function decodes a base64-encoded string. Its arguments are a
31695 zero-terminated base64-encoded string and the address of a variable that is set
31696 to point to the result, which is in dynamic memory. The length of the decoded
31697 string is the yield of the function. If the input is invalid base64 data, the
31698 yield is -1. A zero byte is added to the end of the output string to make it
31699 easy to interpret as a C string (assuming it contains no zeros of its own). The
31700 added zero byte is not included in the returned count.
31701
31702 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31703 This function checks for a match in a domain list. Domains are always
31704 matched caselessly. The return value is one of the following:
31705 .display
31706 &`OK     `& match succeeded
31707 &`FAIL   `& match failed
31708 &`DEFER  `& match deferred
31709 .endd
31710 DEFER is usually caused by some kind of lookup defer, such as the
31711 inability to contact a database.
31712
31713 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31714         BOOL&~caseless)*&"
31715 This function checks for a match in a local part list. The third argument
31716 controls case-sensitivity. The return values are as for
31717 &'lss_match_domain()'&.
31718
31719 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31720         BOOL&~caseless)*&"
31721 This function checks for a match in an address list. The third argument
31722 controls the case-sensitivity of the local part match. The domain is always
31723 matched caselessly. The return values are as for &'lss_match_domain()'&.
31724
31725 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31726         uschar&~*list)*&"
31727 This function checks for a match in a host list. The most common usage is
31728 expected to be
31729 .code
31730 lss_match_host(sender_host_name, sender_host_address, ...)
31731 .endd
31732 .vindex "&$sender_host_address$&"
31733 An empty address field matches an empty item in the host list. If the host name
31734 is NULL, the name corresponding to &$sender_host_address$& is automatically
31735 looked up if a host name is required to match an item in the list. The return
31736 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31737 returns ERROR in the case when it had to look up a host name, but the lookup
31738 failed.
31739
31740 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31741         *format,&~...)*&"
31742 This function writes to Exim's log files. The first argument should be zero (it
31743 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31744 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31745 them. It specifies to which log or logs the message is written. The remaining
31746 arguments are a format and relevant insertion arguments. The string should not
31747 contain any newlines, not even at the end.
31748
31749
31750 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31751 This function adds an additional recipient to the message. The first argument
31752 is the recipient address. If it is unqualified (has no domain), it is qualified
31753 with the &%qualify_recipient%& domain. The second argument must always be -1.
31754
31755 This function does not allow you to specify a private &%errors_to%& address (as
31756 described with the structure of &%recipient_item%& above), because it pre-dates
31757 the addition of that field to the structure. However, it is easy to add such a
31758 value afterwards. For example:
31759 .code
31760  receive_add_recipient(US"monitor@mydom.example", -1);
31761  recipients_list[recipients_count-1].errors_to =
31762    US"postmaster@mydom.example";
31763 .endd
31764
31765 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31766 This is a convenience function to remove a named recipient from the list of
31767 recipients. It returns true if a recipient was removed, and false if no
31768 matching recipient could be found. The argument must be a complete email
31769 address.
31770 .endlist
31771
31772
31773 .cindex "RFC 2047"
31774 .vlist
31775 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31776   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31777 This function decodes strings that are encoded according to RFC 2047. Typically
31778 these are the contents of header lines. First, each &"encoded word"& is decoded
31779 from the Q or B encoding into a byte-string. Then, if provided with the name of
31780 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31781 made  to translate the result to the named character set. If this fails, the
31782 binary string is returned with an error message.
31783
31784 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31785 maximum MIME word length is enforced. The third argument is the target
31786 encoding, or NULL if no translation is wanted.
31787
31788 .cindex "binary zero" "in RFC 2047 decoding"
31789 .cindex "RFC 2047" "binary zero in"
31790 If a binary zero is encountered in the decoded string, it is replaced by the
31791 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31792 not be 0 because header lines are handled as zero-terminated strings.
31793
31794 The function returns the result of processing the string, zero-terminated; if
31795 &%lenptr%& is not NULL, the length of the result is set in the variable to
31796 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31797
31798 If an error is encountered, the function returns NULL and uses the &%error%&
31799 argument to return an error message. The variable pointed to by &%error%& is
31800 set to NULL if there is no error; it may be set non-NULL even when the function
31801 returns a non-NULL value if decoding was successful, but there was a problem
31802 with translation.
31803
31804
31805 .vitem &*int&~smtp_fflush(void)*&
31806 This function is used in conjunction with &'smtp_printf()'&, as described
31807 below.
31808
31809 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31810 The arguments of this function are like &[printf()]&; it writes to the SMTP
31811 output stream. You should use this function only when there is an SMTP output
31812 stream, that is, when the incoming message is being received via interactive
31813 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31814 is FALSE. If you want to test for an incoming message from another host (as
31815 opposed to a local process that used the &%-bs%& command line option), you can
31816 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31817 is involved.
31818
31819 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31820 output function, so it can be used for all forms of SMTP connection.
31821
31822 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31823 must start with an appropriate response code: 550 if you are going to return
31824 LOCAL_SCAN_REJECT, 451 if you are going to return
31825 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31826 initial lines of a multi-line response, the code must be followed by a hyphen
31827 to indicate that the line is not the final response line. You must also ensure
31828 that the lines you write terminate with CRLF. For example:
31829 .code
31830 smtp_printf("550-this is some extra info\r\n");
31831 return LOCAL_SCAN_REJECT;
31832 .endd
31833 Note that you can also create multi-line responses by including newlines in
31834 the data returned via the &%return_text%& argument. The added value of using
31835 &'smtp_printf()'& is that, for instance, you could introduce delays between
31836 multiple output lines.
31837
31838 The &'smtp_printf()'& function does not return any error indication, because it
31839 does not automatically flush pending output, and therefore does not test
31840 the state of the stream. (In the main code of Exim, flushing and error
31841 detection is done when Exim is ready for the next SMTP input command.) If
31842 you want to flush the output and check for an error (for example, the
31843 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31844 arguments. It flushes the output stream, and returns a non-zero value if there
31845 is an error.
31846
31847 .vitem &*void&~*store_get(int)*&
31848 This function accesses Exim's internal store (memory) manager. It gets a new
31849 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31850 runs out of memory. See the next section for a discussion of memory handling.
31851
31852 .vitem &*void&~*store_get_perm(int)*&
31853 This function is like &'store_get()'&, but it always gets memory from the
31854 permanent pool. See the next section for a discussion of memory handling.
31855
31856 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31857 See below.
31858
31859 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31860 See below.
31861
31862 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31863 These three functions create strings using Exim's dynamic memory facilities.
31864 The first makes a copy of an entire string. The second copies up to a maximum
31865 number of characters, indicated by the second argument. The third uses a format
31866 and insertion arguments to create a new string. In each case, the result is a
31867 pointer to a new string in the current memory pool. See the next section for
31868 more discussion.
31869 .endlist
31870
31871
31872
31873 .section "More about Exim's memory handling" "SECTmemhanloc"
31874 .cindex "&[local_scan()]& function" "memory handling"
31875 No function is provided for freeing memory, because that is never needed.
31876 The dynamic memory that Exim uses when receiving a message is automatically
31877 recycled if another message is received by the same process (this applies only
31878 to incoming SMTP connections &-- other input methods can supply only one
31879 message at a time). After receiving the last message, a reception process
31880 terminates.
31881
31882 Because it is recycled, the normal dynamic memory cannot be used for holding
31883 data that must be preserved over a number of incoming messages on the same SMTP
31884 connection. However, Exim in fact uses two pools of dynamic memory; the second
31885 one is not recycled, and can be used for this purpose.
31886
31887 If you want to allocate memory that remains available for subsequent messages
31888 in the same SMTP connection, you should set
31889 .code
31890 store_pool = POOL_PERM
31891 .endd
31892 before calling the function that does the allocation. There is no need to
31893 restore the value if you do not need to; however, if you do want to revert to
31894 the normal pool, you can either restore the previous value of &%store_pool%& or
31895 set it explicitly to POOL_MAIN.
31896
31897 The pool setting applies to all functions that get dynamic memory, including
31898 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31899 There is also a convenience function called &'store_get_perm()'& that gets a
31900 block of memory from the permanent pool while preserving the value of
31901 &%store_pool%&.
31902 .ecindex IIDlosca
31903
31904
31905
31906
31907 . ////////////////////////////////////////////////////////////////////////////
31908 . ////////////////////////////////////////////////////////////////////////////
31909
31910 .chapter "System-wide message filtering" "CHAPsystemfilter"
31911 .scindex IIDsysfil1 "filter" "system filter"
31912 .scindex IIDsysfil2 "filtering all mail"
31913 .scindex IIDsysfil3 "system filter"
31914 The previous chapters (on ACLs and the local scan function) describe checks
31915 that can be applied to messages before they are accepted by a host. There is
31916 also a mechanism for checking messages once they have been received, but before
31917 they are delivered. This is called the &'system filter'&.
31918
31919 The system filter operates in a similar manner to users' filter files, but it
31920 is run just once per message (however many recipients the message has).
31921 It should not normally be used as a substitute for routing, because &%deliver%&
31922 commands in a system router provide new envelope recipient addresses.
31923 The system filter must be an Exim filter. It cannot be a Sieve filter.
31924
31925 The system filter is run at the start of a delivery attempt, before any routing
31926 is done. If a message fails to be completely delivered at the first attempt,
31927 the system filter is run again at the start of every retry.
31928 If you want your filter to do something only once per message, you can make use
31929 of the &%first_delivery%& condition in an &%if%& command in the filter to
31930 prevent it happening on retries.
31931
31932 .vindex "&$domain$&"
31933 .vindex "&$local_part$&"
31934 &*Warning*&: Because the system filter runs just once, variables that are
31935 specific to individual recipient addresses, such as &$local_part$& and
31936 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31937 you want to run a centrally-specified filter for each recipient address
31938 independently, you can do so by setting up a suitable &(redirect)& router, as
31939 described in section &<<SECTperaddfil>>& below.
31940
31941
31942 .section "Specifying a system filter" "SECID212"
31943 .cindex "uid (user id)" "system filter"
31944 .cindex "gid (group id)" "system filter"
31945 The name of the file that contains the system filter must be specified by
31946 setting &%system_filter%&. If you want the filter to run under a uid and gid
31947 other than root, you must also set &%system_filter_user%& and
31948 &%system_filter_group%& as appropriate. For example:
31949 .code
31950 system_filter = /etc/mail/exim.filter
31951 system_filter_user = exim
31952 .endd
31953 If a system filter generates any deliveries directly to files or pipes (via the
31954 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31955 specified by setting &%system_filter_file_transport%& and
31956 &%system_filter_pipe_transport%&, respectively. Similarly,
31957 &%system_filter_reply_transport%& must be set to handle any messages generated
31958 by the &%reply%& command.
31959
31960
31961 .section "Testing a system filter" "SECID213"
31962 You can run simple tests of a system filter in the same way as for a user
31963 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31964 are permitted only in system filters are recognized.
31965
31966 If you want to test the combined effect of a system filter and a user filter,
31967 you can use both &%-bF%& and &%-bf%& on the same command line.
31968
31969
31970
31971 .section "Contents of a system filter" "SECID214"
31972 The language used to specify system filters is the same as for users' filter
31973 files. It is described in the separate end-user document &'Exim's interface to
31974 mail filtering'&. However, there are some additional features that are
31975 available only in system filters; these are described in subsequent sections.
31976 If they are encountered in a user's filter file or when testing with &%-bf%&,
31977 they cause errors.
31978
31979 .cindex "frozen messages" "manual thaw; testing in filter"
31980 There are two special conditions which, though available in users' filter
31981 files, are designed for use in system filters. The condition &%first_delivery%&
31982 is true only for the first attempt at delivering a message, and
31983 &%manually_thawed%& is true only if the message has been frozen, and
31984 subsequently thawed by an admin user. An explicit forced delivery counts as a
31985 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31986
31987 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31988 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31989 succeed, it will not be tried again.
31990 If you want Exim to retry an unseen delivery until it succeeds, you should
31991 arrange to set it up every time the filter runs.
31992
31993 When a system filter finishes running, the values of the variables &$n0$& &--
31994 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31995 users' filter files. Thus a system filter can, for example, set up &"scores"&
31996 to which users' filter files can refer.
31997
31998
31999
32000 .section "Additional variable for system filters" "SECID215"
32001 .vindex "&$recipients$&"
32002 The expansion variable &$recipients$&, containing a list of all the recipients
32003 of the message (separated by commas and white space), is available in system
32004 filters. It is not available in users' filters for privacy reasons.
32005
32006
32007
32008 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32009 .cindex "freezing messages"
32010 .cindex "message" "freezing"
32011 .cindex "message" "forced failure"
32012 .cindex "&%fail%&" "in system filter"
32013 .cindex "&%freeze%& in system filter"
32014 .cindex "&%defer%& in system filter"
32015 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32016 always available in system filters, but are not normally enabled in users'
32017 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32018 for the &(redirect)& router.) These commands can optionally be followed by the
32019 word &%text%& and a string containing an error message, for example:
32020 .code
32021 fail text "this message looks like spam to me"
32022 .endd
32023 The keyword &%text%& is optional if the next character is a double quote.
32024
32025 The &%defer%& command defers delivery of the original recipients of the
32026 message. The &%fail%& command causes all the original recipients to be failed,
32027 and a bounce message to be created. The &%freeze%& command suspends all
32028 delivery attempts for the original recipients. In all cases, any new deliveries
32029 that are specified by the filter are attempted as normal after the filter has
32030 run.
32031
32032 The &%freeze%& command is ignored if the message has been manually unfrozen and
32033 not manually frozen since. This means that automatic freezing by a system
32034 filter can be used as a way of checking out suspicious messages. If a message
32035 is found to be all right, manually unfreezing it allows it to be delivered.
32036
32037 .cindex "log" "&%fail%& command log line"
32038 .cindex "&%fail%&" "log line; reducing"
32039 The text given with a fail command is used as part of the bounce message as
32040 well as being written to the log. If the message is quite long, this can fill
32041 up a lot of log space when such failures are common. To reduce the size of the
32042 log message, Exim interprets the text in a special way if it starts with the
32043 two characters &`<<`& and contains &`>>`& later. The text between these two
32044 strings is written to the log, and the rest of the text is used in the bounce
32045 message. For example:
32046 .code
32047 fail "<<filter test 1>>Your message is rejected \
32048      because it contains attachments that we are \
32049      not prepared to receive."
32050 .endd
32051
32052 .cindex "loop" "caused by &%fail%&"
32053 Take great care with the &%fail%& command when basing the decision to fail on
32054 the contents of the message, because the bounce message will of course include
32055 the contents of the original message and will therefore trigger the &%fail%&
32056 command again (causing a mail loop) unless steps are taken to prevent this.
32057 Testing the &%error_message%& condition is one way to prevent this. You could
32058 use, for example
32059 .code
32060 if $message_body contains "this is spam" and not error_message
32061 then fail text "spam is not wanted here" endif
32062 .endd
32063 though of course that might let through unwanted bounce messages. The
32064 alternative is clever checking of the body and/or headers to detect bounces
32065 generated by the filter.
32066
32067 The interpretation of a system filter file ceases after a
32068 &%defer%&,
32069 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32070 set up earlier in the filter file are honoured, so you can use a sequence such
32071 as
32072 .code
32073 mail ...
32074 freeze
32075 .endd
32076 to send a specified message when the system filter is freezing (or deferring or
32077 failing) a message. The normal deliveries for the message do not, of course,
32078 take place.
32079
32080
32081
32082 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32083 .cindex "header lines" "adding; in system filter"
32084 .cindex "header lines" "removing; in system filter"
32085 .cindex "filter" "header lines; adding/removing"
32086 Two filter commands that are available only in system filters are:
32087 .code
32088 headers add <string>
32089 headers remove <string>
32090 .endd
32091 The argument for the &%headers add%& is a string that is expanded and then
32092 added to the end of the message's headers. It is the responsibility of the
32093 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32094 space is ignored, and if the string is otherwise empty, or if the expansion is
32095 forced to fail, the command has no effect.
32096
32097 You can use &"\n"& within the string, followed by white space, to specify
32098 continued header lines. More than one header may be added in one command by
32099 including &"\n"& within the string without any following white space. For
32100 example:
32101 .code
32102 headers add "X-header-1: ....\n  \
32103              continuation of X-header-1 ...\n\
32104              X-header-2: ...."
32105 .endd
32106 Note that the header line continuation white space after the first newline must
32107 be placed before the backslash that continues the input string, because white
32108 space after input continuations is ignored.
32109
32110 The argument for &%headers remove%& is a colon-separated list of header names.
32111 This command applies only to those headers that are stored with the message;
32112 those that are added at delivery time (such as &'Envelope-To:'& and
32113 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32114 header with the same name, they are all removed.
32115
32116 The &%headers%& command in a system filter makes an immediate change to the set
32117 of header lines that was received with the message (with possible additions
32118 from ACL processing). Subsequent commands in the system filter operate on the
32119 modified set, which also forms the basis for subsequent message delivery.
32120 Unless further modified during routing or transporting, this set of headers is
32121 used for all recipients of the message.
32122
32123 During routing and transporting, the variables that refer to the contents of
32124 header lines refer only to those lines that are in this set. Thus, header lines
32125 that are added by a system filter are visible to users' filter files and to all
32126 routers and transports. This contrasts with the manipulation of header lines by
32127 routers and transports, which is not immediate, but which instead is saved up
32128 until the message is actually being written (see section
32129 &<<SECTheadersaddrem>>&).
32130
32131 If the message is not delivered at the first attempt, header lines that were
32132 added by the system filter are stored with the message, and so are still
32133 present at the next delivery attempt. Header lines that were removed are still
32134 present, but marked &"deleted"& so that they are not transported with the
32135 message. For this reason, it is usual to make the &%headers%& command
32136 conditional on &%first_delivery%& so that the set of header lines is not
32137 modified more than once.
32138
32139 Because header modification in a system filter acts immediately, you have to
32140 use an indirect approach if you want to modify the contents of a header line.
32141 For example:
32142 .code
32143 headers add "Old-Subject: $h_subject:"
32144 headers remove "Subject"
32145 headers add "Subject: new subject (was: $h_old-subject:)"
32146 headers remove "Old-Subject"
32147 .endd
32148
32149
32150
32151 .section "Setting an errors address in a system filter" "SECID217"
32152 .cindex "envelope sender"
32153 In a system filter, if a &%deliver%& command is followed by
32154 .code
32155 errors_to <some address>
32156 .endd
32157 in order to change the envelope sender (and hence the error reporting) for that
32158 delivery, any address may be specified. (In a user filter, only the current
32159 user's address can be set.) For example, if some mail is being monitored, you
32160 might use
32161 .code
32162 unseen deliver monitor@spying.example errors_to root@local.example
32163 .endd
32164 to take a copy which would not be sent back to the normal error reporting
32165 address if its delivery failed.
32166
32167
32168
32169 .section "Per-address filtering" "SECTperaddfil"
32170 .vindex "&$domain$&"
32171 .vindex "&$local_part$&"
32172 In contrast to the system filter, which is run just once per message for each
32173 delivery attempt, it is also possible to set up a system-wide filtering
32174 operation that runs once for each recipient address. In this case, variables
32175 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32176 filter file could be made dependent on them. This is an example of a router
32177 which implements such a filter:
32178 .code
32179 central_filter:
32180   check_local_user
32181   driver = redirect
32182   domains = +local_domains
32183   file = /central/filters/$local_part
32184   no_verify
32185   allow_filter
32186   allow_freeze
32187 .endd
32188 The filter is run in a separate process under its own uid. Therefore, either
32189 &%check_local_user%& must be set (as above), in which case the filter is run as
32190 the local user, or the &%user%& option must be used to specify which user to
32191 use. If both are set, &%user%& overrides.
32192
32193 Care should be taken to ensure that none of the commands in the filter file
32194 specify a significant delivery if the message is to go on to be delivered to
32195 its intended recipient. The router will not then claim to have dealt with the
32196 address, so it will be passed on to subsequent routers to be delivered in the
32197 normal way.
32198 .ecindex IIDsysfil1
32199 .ecindex IIDsysfil2
32200 .ecindex IIDsysfil3
32201
32202
32203
32204
32205
32206
32207 . ////////////////////////////////////////////////////////////////////////////
32208 . ////////////////////////////////////////////////////////////////////////////
32209
32210 .chapter "Message processing" "CHAPmsgproc"
32211 .scindex IIDmesproc "message" "general processing"
32212 Exim performs various transformations on the sender and recipient addresses of
32213 all messages that it handles, and also on the messages' header lines. Some of
32214 these are optional and configurable, while others always take place. All of
32215 this processing, except rewriting as a result of routing, and the addition or
32216 removal of header lines while delivering, happens when a message is received,
32217 before it is placed on Exim's queue.
32218
32219 Some of the automatic processing takes place by default only for
32220 &"locally-originated"& messages. This adjective is used to describe messages
32221 that are not received over TCP/IP, but instead are passed to an Exim process on
32222 its standard input. This includes the interactive &"local SMTP"& case that is
32223 set up by the &%-bs%& command line option.
32224
32225 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32226 or ::1) are not considered to be locally-originated. Exim does not treat the
32227 loopback interface specially in any way.
32228
32229 If you want the loopback interface to be treated specially, you must ensure
32230 that there are appropriate entries in your ACLs.
32231
32232
32233
32234
32235 .section "Submission mode for non-local messages" "SECTsubmodnon"
32236 .cindex "message" "submission"
32237 .cindex "submission mode"
32238 Processing that happens automatically for locally-originated messages (unless
32239 &%suppress_local_fixups%& is set) can also be requested for messages that are
32240 received over TCP/IP. The term &"submission mode"& is used to describe this
32241 state. Submission mode is set by the modifier
32242 .code
32243 control = submission
32244 .endd
32245 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32246 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32247 a local submission, and is normally used when the source of the message is
32248 known to be an MUA running on a client host (as opposed to an MTA). For
32249 example, to set submission mode for messages originating on the IPv4 loopback
32250 interface, you could include the following in the MAIL ACL:
32251 .code
32252 warn  hosts = 127.0.0.1
32253       control = submission
32254 .endd
32255 .cindex "&%sender_retain%& submission option"
32256 There are some options that can be used when setting submission mode. A slash
32257 is used to separate options. For example:
32258 .code
32259 control = submission/sender_retain
32260 .endd
32261 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32262 true and &%local_from_check%& false for the current incoming message. The first
32263 of these allows an existing &'Sender:'& header in the message to remain, and
32264 the second suppresses the check to ensure that &'From:'& matches the
32265 authenticated sender. With this setting, Exim still fixes up messages by adding
32266 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32267 attempt to check sender authenticity in header lines.
32268
32269 When &%sender_retain%& is not set, a submission mode setting may specify a
32270 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32271 example:
32272 .code
32273 control = submission/domain=some.domain
32274 .endd
32275 The domain may be empty. How this value is used is described in sections
32276 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32277 that allows you to specify the user's full name for inclusion in a created
32278 &'Sender:'& or &'From:'& header line. For example:
32279 .code
32280 accept authenticated = *
32281        control = submission/domain=wonderland.example/\
32282                             name=${lookup {$authenticated_id} \
32283                                    lsearch {/etc/exim/namelist}}
32284 .endd
32285 Because the name may contain any characters, including slashes, the &%name%&
32286 option must be given last. The remainder of the string is used as the name. For
32287 the example above, if &_/etc/exim/namelist_& contains:
32288 .code
32289 bigegg:  Humpty Dumpty
32290 .endd
32291 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32292 line would be:
32293 .code
32294 Sender: Humpty Dumpty <bigegg@wonderland.example>
32295 .endd
32296 .cindex "return path" "in submission mode"
32297 By default, submission mode forces the return path to the same address as is
32298 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32299 specified, the return path is also left unchanged.
32300
32301 &*Note*&: The changes caused by submission mode take effect after the predata
32302 ACL. This means that any sender checks performed before the fix-ups use the
32303 untrusted sender address specified by the user, not the trusted sender address
32304 specified by submission mode. Although this might be slightly unexpected, it
32305 does mean that you can configure ACL checks to spot that a user is trying to
32306 spoof another's address.
32307
32308 .section "Line endings" "SECTlineendings"
32309 .cindex "line endings"
32310 .cindex "carriage return"
32311 .cindex "linefeed"
32312 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32313 linefeed) is the line ending for messages transmitted over the Internet using
32314 SMTP over TCP/IP. However, within individual operating systems, different
32315 conventions are used. For example, Unix-like systems use just LF, but others
32316 use CRLF or just CR.
32317
32318 Exim was designed for Unix-like systems, and internally, it stores messages
32319 using the system's convention of a single LF as a line terminator. When
32320 receiving a message, all line endings are translated to this standard format.
32321 Originally, it was thought that programs that passed messages directly to an
32322 MTA within an operating system would use that system's convention. Experience
32323 has shown that this is not the case; for example, there are Unix applications
32324 that use CRLF in this circumstance. For this reason, and for compatibility with
32325 other MTAs, the way Exim handles line endings for all messages is now as
32326 follows:
32327
32328 .ilist
32329 LF not preceded by CR is treated as a line ending.
32330 .next
32331 CR is treated as a line ending; if it is immediately followed by LF, the LF
32332 is ignored.
32333 .next
32334 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32335 nor a local message in the state where a line containing only a dot is a
32336 terminator.
32337 .next
32338 If a bare CR is encountered within a header line, an extra space is added after
32339 the line terminator so as not to end the header line. The reasoning behind this
32340 is that bare CRs in header lines are most likely either to be mistakes, or
32341 people trying to play silly games.
32342 .next
32343 If the first header line received in a message ends with CRLF, a subsequent
32344 bare LF in a header line is treated in the same way as a bare CR in a header
32345 line.
32346 .endlist
32347
32348
32349
32350
32351
32352 .section "Unqualified addresses" "SECID218"
32353 .cindex "unqualified addresses"
32354 .cindex "address" "qualification"
32355 By default, Exim expects every envelope address it receives from an external
32356 host to be fully qualified. Unqualified addresses cause negative responses to
32357 SMTP commands. However, because SMTP is used as a means of transporting
32358 messages from MUAs running on personal workstations, there is sometimes a
32359 requirement to accept unqualified addresses from specific hosts or IP networks.
32360
32361 Exim has two options that separately control which hosts may send unqualified
32362 sender or recipient addresses in SMTP commands, namely
32363 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32364 cases, if an unqualified address is accepted, it is qualified by adding the
32365 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32366
32367 .oindex "&%qualify_domain%&"
32368 .oindex "&%qualify_recipient%&"
32369 Unqualified addresses in header lines are automatically qualified for messages
32370 that are locally originated, unless the &%-bnq%& option is given on the command
32371 line. For messages received over SMTP, unqualified addresses in header lines
32372 are qualified only if unqualified addresses are permitted in SMTP commands. In
32373 other words, such qualification is also controlled by
32374 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32375
32376
32377
32378
32379 .section "The UUCP From line" "SECID219"
32380 .cindex "&""From""& line"
32381 .cindex "UUCP" "&""From""& line"
32382 .cindex "sender" "address"
32383 .oindex "&%uucp_from_pattern%&"
32384 .oindex "&%uucp_from_sender%&"
32385 .cindex "envelope sender"
32386 .cindex "Sendmail compatibility" "&""From""& line"
32387 Messages that have come from UUCP (and some other applications) often begin
32388 with a line containing the envelope sender and a timestamp, following the word
32389 &"From"&. Examples of two common formats are:
32390 .code
32391 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32392 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32393 .endd
32394 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32395 Exim recognizes such lines at the start of messages that are submitted to it
32396 via the command line (that is, on the standard input). It does not recognize
32397 such lines in incoming SMTP messages, unless the sending host matches
32398 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32399 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32400 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32401 default value matches the two common cases shown above and puts the address
32402 that follows &"From"& into &$1$&.
32403
32404 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32405 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32406 a trusted user, the message's sender address is constructed by expanding the
32407 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32408 then parsed as an RFC 2822 address. If there is no domain, the local part is
32409 qualified with &%qualify_domain%& unless it is the empty string. However, if
32410 the command line &%-f%& option is used, it overrides the &"From"& line.
32411
32412 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32413 sender address is not changed. This is also the case for incoming SMTP messages
32414 that are permitted to contain &"From"& lines.
32415
32416 Only one &"From"& line is recognized. If there is more than one, the second is
32417 treated as a data line that starts the body of the message, as it is not valid
32418 as a header line. This also happens if a &"From"& line is present in an
32419 incoming SMTP message from a source that is not permitted to send them.
32420
32421
32422
32423 .section "Resent- header lines" "SECID220"
32424 .cindex "&%Resent-%& header lines"
32425 RFC 2822 makes provision for sets of header lines starting with the string
32426 &`Resent-`& to be added to a message when it is resent by the original
32427 recipient to somebody else. These headers are &'Resent-Date:'&,
32428 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32429 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32430
32431 .blockquote
32432 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32433 processing of replies or other such automatic actions on messages.'&
32434 .endblockquote
32435
32436 This leaves things a bit vague as far as other processing actions such as
32437 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32438 follows:
32439
32440 .ilist
32441 A &'Resent-From:'& line that just contains the login id of the submitting user
32442 is automatically rewritten in the same way as &'From:'& (see below).
32443 .next
32444 If there's a rewriting rule for a particular header line, it is also applied to
32445 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32446 &'From:'& also rewrites &'Resent-From:'&.
32447 .next
32448 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32449 also removed.
32450 .next
32451 For a locally-submitted message,
32452 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32453 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32454 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32455 included in log lines in this case.
32456 .next
32457 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32458 &%Resent-%& header lines are present.
32459 .endlist
32460
32461
32462
32463
32464 .section "The Auto-Submitted: header line" "SECID221"
32465 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32466 includes the header line:
32467 .code
32468 Auto-Submitted: auto-replied
32469 .endd
32470
32471 .section "The Bcc: header line" "SECID222"
32472 .cindex "&'Bcc:'& header line"
32473 If Exim is called with the &%-t%& option, to take recipient addresses from a
32474 message's header, it removes any &'Bcc:'& header line that may exist (after
32475 extracting its addresses). If &%-t%& is not present on the command line, any
32476 existing &'Bcc:'& is not removed.
32477
32478
32479 .section "The Date: header line" "SECID223"
32480 .cindex "&'Date:'& header line"
32481 If a locally-generated or submission-mode message has no &'Date:'& header line,
32482 Exim adds one, using the current date and time, unless the
32483 &%suppress_local_fixups%& control has been specified.
32484
32485 .section "The Delivery-date: header line" "SECID224"
32486 .cindex "&'Delivery-date:'& header line"
32487 .oindex "&%delivery_date_remove%&"
32488 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32489 set. Exim can be configured to add them to the final delivery of messages. (See
32490 the generic &%delivery_date_add%& transport option.) They should not be present
32491 in messages in transit. If the &%delivery_date_remove%& configuration option is
32492 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32493 messages.
32494
32495
32496 .section "The Envelope-to: header line" "SECID225"
32497 .cindex "&'Envelope-to:'& header line"
32498 .oindex "&%envelope_to_remove%&"
32499 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32500 Exim can be configured to add them to the final delivery of messages. (See the
32501 generic &%envelope_to_add%& transport option.) They should not be present in
32502 messages in transit. If the &%envelope_to_remove%& configuration option is set
32503 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32504 messages.
32505
32506
32507 .section "The From: header line" "SECTthefrohea"
32508 .cindex "&'From:'& header line"
32509 .cindex "Sendmail compatibility" "&""From""& line"
32510 .cindex "message" "submission"
32511 .cindex "submission mode"
32512 If a submission-mode message does not contain a &'From:'& header line, Exim
32513 adds one if either of the following conditions is true:
32514
32515 .ilist
32516 The envelope sender address is not empty (that is, this is not a bounce
32517 message). The added header line copies the envelope sender address.
32518 .next
32519 .vindex "&$authenticated_id$&"
32520 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32521 .olist
32522 .vindex "&$qualify_domain$&"
32523 If no domain is specified by the submission control, the local part is
32524 &$authenticated_id$& and the domain is &$qualify_domain$&.
32525 .next
32526 If a non-empty domain is specified by the submission control, the local
32527 part is &$authenticated_id$&, and the domain is the specified domain.
32528 .next
32529 If an empty domain is specified by the submission control,
32530 &$authenticated_id$& is assumed to be the complete address.
32531 .endlist
32532 .endlist
32533
32534 A non-empty envelope sender takes precedence.
32535
32536 If a locally-generated incoming message does not contain a &'From:'& header
32537 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32538 containing the sender's address. The calling user's login name and full name
32539 are used to construct the address, as described in section &<<SECTconstr>>&.
32540 They are obtained from the password data by calling &[getpwuid()]& (but see the
32541 &%unknown_login%& configuration option). The address is qualified with
32542 &%qualify_domain%&.
32543
32544 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32545 &'From:'& header line containing just the unqualified login name of the calling
32546 user, this is replaced by an address containing the user's login name and full
32547 name as described in section &<<SECTconstr>>&.
32548
32549
32550 .section "The Message-ID: header line" "SECID226"
32551 .cindex "&'Message-ID:'& header line"
32552 .cindex "message" "submission"
32553 .oindex "&%message_id_header_text%&"
32554 If a locally-generated or submission-mode incoming message does not contain a
32555 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32556 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32557 to the message. If there are any &'Resent-:'& headers in the message, it
32558 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32559 message id, preceded by the letter E to ensure it starts with a letter, and
32560 followed by @ and the primary host name. Additional information can be included
32561 in this header line by setting the &%message_id_header_text%& and/or
32562 &%message_id_header_domain%& options.
32563
32564
32565 .section "The Received: header line" "SECID227"
32566 .cindex "&'Received:'& header line"
32567 A &'Received:'& header line is added at the start of every message. The
32568 contents are defined by the &%received_header_text%& configuration option, and
32569 Exim automatically adds a semicolon and a timestamp to the configured string.
32570
32571 The &'Received:'& header is generated as soon as the message's header lines
32572 have been received. At this stage, the timestamp in the &'Received:'& header
32573 line is the time that the message started to be received. This is the value
32574 that is seen by the DATA ACL and by the &[local_scan()]& function.
32575
32576 Once a message is accepted, the timestamp in the &'Received:'& header line is
32577 changed to the time of acceptance, which is (apart from a small delay while the
32578 -H spool file is written) the earliest time at which delivery could start.
32579
32580
32581 .section "The References: header line" "SECID228"
32582 .cindex "&'References:'& header line"
32583 Messages created by the &(autoreply)& transport include a &'References:'&
32584 header line. This is constructed according to the rules that are described in
32585 section 3.64 of RFC 2822 (which states that replies should contain such a
32586 header line), and section 3.14 of RFC 3834 (which states that automatic
32587 responses are not different in this respect). However, because some mail
32588 processing software does not cope well with very long header lines, no more
32589 than 12 message IDs are copied from the &'References:'& header line in the
32590 incoming message. If there are more than 12, the first one and then the final
32591 11 are copied, before adding the message ID of the incoming message.
32592
32593
32594
32595 .section "The Return-path: header line" "SECID229"
32596 .cindex "&'Return-path:'& header line"
32597 .oindex "&%return_path_remove%&"
32598 &'Return-path:'& header lines are defined as something an MTA may insert when
32599 it does the final delivery of messages. (See the generic &%return_path_add%&
32600 transport option.) Therefore, they should not be present in messages in
32601 transit. If the &%return_path_remove%& configuration option is set (the
32602 default), Exim removes &'Return-path:'& header lines from incoming messages.
32603
32604
32605
32606 .section "The Sender: header line" "SECTthesenhea"
32607 .cindex "&'Sender:'& header line"
32608 .cindex "message" "submission"
32609 For a locally-originated message from an untrusted user, Exim may remove an
32610 existing &'Sender:'& header line, and it may add a new one. You can modify
32611 these actions by setting the &%local_sender_retain%& option true, the
32612 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32613 control setting.
32614
32615 When a local message is received from an untrusted user and
32616 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32617 control has not been set, a check is made to see if the address given in the
32618 &'From:'& header line is the correct (local) sender of the message. The address
32619 that is expected has the login name as the local part and the value of
32620 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32621 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32622 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32623 line is added to the message.
32624
32625 If you set &%local_from_check%& false, this checking does not occur. However,
32626 the removal of an existing &'Sender:'& line still happens, unless you also set
32627 &%local_sender_retain%& to be true. It is not possible to set both of these
32628 options true at the same time.
32629
32630 .cindex "submission mode"
32631 By default, no processing of &'Sender:'& header lines is done for messages
32632 received over TCP/IP or for messages submitted by trusted users. However, when
32633 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32634 not specified on the submission control, the following processing takes place:
32635
32636 .vindex "&$authenticated_id$&"
32637 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32638 authenticated, and &$authenticated_id$& is not empty, a sender address is
32639 created as follows:
32640
32641 .ilist
32642 .vindex "&$qualify_domain$&"
32643 If no domain is specified by the submission control, the local part is
32644 &$authenticated_id$& and the domain is &$qualify_domain$&.
32645 .next
32646 If a non-empty domain is specified by the submission control, the local part
32647 is &$authenticated_id$&, and the domain is the specified domain.
32648 .next
32649 If an empty domain is specified by the submission control,
32650 &$authenticated_id$& is assumed to be the complete address.
32651 .endlist
32652
32653 This address is compared with the address in the &'From:'& header line. If they
32654 are different, a &'Sender:'& header line containing the created address is
32655 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32656 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32657
32658 .cindex "return path" "created from &'Sender:'&"
32659 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32660 the message (the envelope sender address) is changed to be the same address,
32661 except in the case of submission mode when &%sender_retain%& is specified.
32662
32663
32664
32665 .section "Adding and removing header lines in routers and transports" &&&
32666          "SECTheadersaddrem"
32667 .cindex "header lines" "adding; in router or transport"
32668 .cindex "header lines" "removing; in router or transport"
32669 When a message is delivered, the addition and removal of header lines can be
32670 specified in a system filter, or on any of the routers and transports that
32671 process the message. Section &<<SECTaddremheasys>>& contains details about
32672 modifying headers in a system filter. Header lines can also be added in an ACL
32673 as a message is received (see section &<<SECTaddheadacl>>&).
32674
32675 In contrast to what happens in a system filter, header modifications that are
32676 specified on routers and transports apply only to the particular recipient
32677 addresses that are being processed by those routers and transports. These
32678 changes do not actually take place until a copy of the message is being
32679 transported. Therefore, they do not affect the basic set of header lines, and
32680 they do not affect the values of the variables that refer to header lines.
32681
32682 &*Note*&: In particular, this means that any expansions in the configuration of
32683 the transport cannot refer to the modified header lines, because such
32684 expansions all occur before the message is actually transported.
32685
32686 For both routers and transports, the argument of a &%headers_add%&
32687 option must be in the form of one or more RFC 2822 header lines, separated by
32688 newlines (coded as &"\n"&). For example:
32689 .code
32690 headers_add = X-added-header: added by $primary_hostname\n\
32691               X-added-second: another added header line
32692 .endd
32693 Exim does not check the syntax of these added header lines.
32694
32695 Multiple &%headers_add%& options for a single router or transport can be
32696 specified; the values will append to a single list of header lines.
32697 Each header-line is separately expanded.
32698
32699 The argument of a &%headers_remove%& option must consist of a colon-separated
32700 list of header names. This is confusing, because header names themselves are
32701 often terminated by colons. In this case, the colons are the list separators,
32702 not part of the names. For example:
32703 .code
32704 headers_remove = return-receipt-to:acknowledge-to
32705 .endd
32706
32707 Multiple &%headers_remove%& options for a single router or transport can be
32708 specified; the arguments will append to a single header-names list.
32709 Each item is separately expanded.
32710 Note that colons in complex expansions which are used to
32711 form all or part of a &%headers_remove%& list
32712 will act as list separators.
32713
32714 When &%headers_add%& or &%headers_remove%& is specified on a router,
32715 items are expanded at routing time,
32716 and then associated with all addresses that are
32717 accepted by that router, and also with any new addresses that it generates. If
32718 an address passes through several routers as a result of aliasing or
32719 forwarding, the changes are cumulative.
32720
32721 .oindex "&%unseen%&"
32722 However, this does not apply to multiple routers that result from the use of
32723 the &%unseen%& option. Any header modifications that were specified by the
32724 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32725
32726 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32727 settings cannot be delivered together in a batch, so a transport is always
32728 dealing with a set of addresses that have the same header-processing
32729 requirements.
32730
32731 The transport starts by writing the original set of header lines that arrived
32732 with the message, possibly modified by the system filter. As it writes out
32733 these lines, it consults the list of header names that were attached to the
32734 recipient address(es) by &%headers_remove%& options in routers, and it also
32735 consults the transport's own &%headers_remove%& option. Header lines whose
32736 names are on either of these lists are not written out. If there are multiple
32737 instances of any listed header, they are all skipped.
32738
32739 After the remaining original header lines have been written, new header
32740 lines that were specified by routers' &%headers_add%& options are written, in
32741 the order in which they were attached to the address. These are followed by any
32742 header lines specified by the transport's &%headers_add%& option.
32743
32744 This way of handling header line modifications in routers and transports has
32745 the following consequences:
32746
32747 .ilist
32748 The original set of header lines, possibly modified by the system filter,
32749 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32750 to it, at all times.
32751 .next
32752 Header lines that are added by a router's
32753 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32754 expansion syntax in subsequent routers or the transport.
32755 .next
32756 Conversely, header lines that are specified for removal by &%headers_remove%&
32757 in a router remain visible to subsequent routers and the transport.
32758 .next
32759 Headers added to an address by &%headers_add%& in a router cannot be removed by
32760 a later router or by a transport.
32761 .next
32762 An added header can refer to the contents of an original header that is to be
32763 removed, even it has the same name as the added header. For example:
32764 .code
32765 headers_remove = subject
32766 headers_add = Subject: new subject (was: $h_subject:)
32767 .endd
32768 .endlist
32769
32770 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32771 for a &(redirect)& router that has the &%one_time%& option set.
32772
32773
32774
32775
32776
32777 .section "Constructed addresses" "SECTconstr"
32778 .cindex "address" "constructed"
32779 .cindex "constructed address"
32780 When Exim constructs a sender address for a locally-generated message, it uses
32781 the form
32782 .display
32783 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32784 .endd
32785 For example:
32786 .code
32787 Zaphod Beeblebrox <zaphod@end.univ.example>
32788 .endd
32789 The user name is obtained from the &%-F%& command line option if set, or
32790 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32791 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32792 ampersand character, this is replaced by the login name with the first letter
32793 upper cased, as is conventional in a number of operating systems. See the
32794 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32795 The &%unknown_username%& option can be used to specify user names in cases when
32796 there is no password file entry.
32797
32798 .cindex "RFC 2047"
32799 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32800 parts of it if necessary. In addition, if it contains any non-printing
32801 characters, it is encoded as described in RFC 2047, which defines a way of
32802 including non-ASCII characters in header lines. The value of the
32803 &%headers_charset%& option specifies the name of the encoding that is used (the
32804 characters are assumed to be in this encoding). The setting of
32805 &%print_topbitchars%& controls whether characters with the top bit set (that
32806 is, with codes greater than 127) count as printing characters or not.
32807
32808
32809
32810 .section "Case of local parts" "SECID230"
32811 .cindex "case of local parts"
32812 .cindex "local part" "case of"
32813 RFC 2822 states that the case of letters in the local parts of addresses cannot
32814 be assumed to be non-significant. Exim preserves the case of local parts of
32815 addresses, but by default it uses a lower-cased form when it is routing,
32816 because on most Unix systems, usernames are in lower case and case-insensitive
32817 routing is required. However, any particular router can be made to use the
32818 original case for local parts by setting the &%caseful_local_part%& generic
32819 router option.
32820
32821 .cindex "mixed-case login names"
32822 If you must have mixed-case user names on your system, the best way to proceed,
32823 assuming you want case-independent handling of incoming email, is to set up
32824 your first router to convert incoming local parts in your domains to the
32825 correct case by means of a file lookup. For example:
32826 .code
32827 correct_case:
32828   driver = redirect
32829   domains = +local_domains
32830   data = ${lookup{$local_part}cdb\
32831               {/etc/usercased.cdb}{$value}fail}\
32832               @$domain
32833 .endd
32834 For this router, the local part is forced to lower case by the default action
32835 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32836 up a new local part in the correct case. If you then set &%caseful_local_part%&
32837 on any subsequent routers which process your domains, they will operate on
32838 local parts with the correct case in a case-sensitive manner.
32839
32840
32841
32842 .section "Dots in local parts" "SECID231"
32843 .cindex "dot" "in local part"
32844 .cindex "local part" "dots in"
32845 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32846 part may not begin or end with a dot, nor have two consecutive dots in the
32847 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32848 empty components for compatibility.
32849
32850
32851
32852 .section "Rewriting addresses" "SECID232"
32853 .cindex "rewriting" "addresses"
32854 Rewriting of sender and recipient addresses, and addresses in headers, can
32855 happen automatically, or as the result of configuration options, as described
32856 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32857 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32858
32859 Automatic rewriting includes qualification, as mentioned above. The other case
32860 in which it can happen is when an incomplete non-local domain is given. The
32861 routing process may cause this to be expanded into the full domain name. For
32862 example, a header such as
32863 .code
32864 To: hare@teaparty
32865 .endd
32866 might get rewritten as
32867 .code
32868 To: hare@teaparty.wonderland.fict.example
32869 .endd
32870 Rewriting as a result of routing is the one kind of message processing that
32871 does not happen at input time, as it cannot be done until the address has
32872 been routed.
32873
32874 Strictly, one should not do &'any'& deliveries of a message until all its
32875 addresses have been routed, in case any of the headers get changed as a
32876 result of routing. However, doing this in practice would hold up many
32877 deliveries for unreasonable amounts of time, just because one address could not
32878 immediately be routed. Exim therefore does not delay other deliveries when
32879 routing of one or more addresses is deferred.
32880 .ecindex IIDmesproc
32881
32882
32883
32884 . ////////////////////////////////////////////////////////////////////////////
32885 . ////////////////////////////////////////////////////////////////////////////
32886
32887 .chapter "SMTP processing" "CHAPSMTP"
32888 .scindex IIDsmtpproc1 "SMTP" "processing details"
32889 .scindex IIDsmtpproc2 "LMTP" "processing details"
32890 Exim supports a number of different ways of using the SMTP protocol, and its
32891 LMTP variant, which is an interactive protocol for transferring messages into a
32892 closed mail store application. This chapter contains details of how SMTP is
32893 processed. For incoming mail, the following are available:
32894
32895 .ilist
32896 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32897 .next
32898 SMTP over the standard input and output (the &%-bs%& option);
32899 .next
32900 Batched SMTP on the standard input (the &%-bS%& option).
32901 .endlist
32902
32903 For mail delivery, the following are available:
32904
32905 .ilist
32906 SMTP over TCP/IP (the &(smtp)& transport);
32907 .next
32908 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32909 &"lmtp"&);
32910 .next
32911 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32912 transport);
32913 .next
32914 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32915 the &%use_bsmtp%& option set).
32916 .endlist
32917
32918 &'Batched SMTP'& is the name for a process in which batches of messages are
32919 stored in or read from files (or pipes), in a format in which SMTP commands are
32920 used to contain the envelope information.
32921
32922
32923
32924 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32925 .cindex "SMTP" "outgoing over TCP/IP"
32926 .cindex "outgoing SMTP over TCP/IP"
32927 .cindex "LMTP" "over TCP/IP"
32928 .cindex "outgoing LMTP over TCP/IP"
32929 .cindex "EHLO"
32930 .cindex "HELO"
32931 .cindex "SIZE option on MAIL command"
32932 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32933 The &%protocol%& option selects which protocol is to be used, but the actual
32934 processing is the same in both cases.
32935
32936 If, in response to its EHLO command, Exim is told that the SIZE
32937 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32938 command. The value of <&'n'&> is the message size plus the value of the
32939 &%size_addition%& option (default 1024) to allow for additions to the message
32940 such as per-transport header lines, or changes made in a
32941 .cindex "transport" "filter"
32942 .cindex "filter" "transport filter"
32943 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32944 suppressed.
32945
32946 If the remote server advertises support for PIPELINING, Exim uses the
32947 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32948 required for the transaction.
32949
32950 If the remote server advertises support for the STARTTLS command, and Exim
32951 was built to support TLS encryption, it tries to start a TLS session unless the
32952 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32953 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32954 is called for verification.
32955
32956 If the remote server advertises support for the AUTH command, Exim scans
32957 the authenticators configuration for any suitable client settings, as described
32958 in chapter &<<CHAPSMTPAUTH>>&.
32959
32960 .cindex "carriage return"
32961 .cindex "linefeed"
32962 Responses from the remote host are supposed to be terminated by CR followed by
32963 LF. However, there are known to be hosts that do not send CR characters, so in
32964 order to be able to interwork with such hosts, Exim treats LF on its own as a
32965 line terminator.
32966
32967 If a message contains a number of different addresses, all those with the same
32968 characteristics (for example, the same envelope sender) that resolve to the
32969 same set of hosts, in the same order, are sent in a single SMTP transaction,
32970 even if they are for different domains, unless there are more than the setting
32971 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32972 they are split into groups containing no more than &%max_rcpt%&s addresses
32973 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32974 in parallel sessions. The order of hosts with identical MX values is not
32975 significant when checking whether addresses can be batched in this way.
32976
32977 When the &(smtp)& transport suffers a temporary failure that is not
32978 message-related, Exim updates its transport-specific database, which contains
32979 records indexed by host name that remember which messages are waiting for each
32980 particular host. It also updates the retry database with new retry times.
32981
32982 .cindex "hints database" "retry keys"
32983 Exim's retry hints are based on host name plus IP address, so if one address of
32984 a multi-homed host is broken, it will soon be skipped most of the time.
32985 See the next section for more detail about error handling.
32986
32987 .cindex "SMTP" "passed connection"
32988 .cindex "SMTP" "batching over TCP/IP"
32989 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32990 looks in the hints database for the transport to see if there are any queued
32991 messages waiting for the host to which it is connected. If it finds one, it
32992 creates a new Exim process using the &%-MC%& option (which can only be used by
32993 a process running as root or the Exim user) and passes the TCP/IP socket to it
32994 so that it can deliver another message using the same socket. The new process
32995 does only those deliveries that are routed to the connected host, and may in
32996 turn pass the socket on to a third process, and so on.
32997
32998 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32999 limit the number of messages sent down a single TCP/IP connection.
33000
33001 .cindex "asterisk" "after IP address"
33002 The second and subsequent messages delivered down an existing connection are
33003 identified in the main log by the addition of an asterisk after the closing
33004 square bracket of the IP address.
33005
33006
33007
33008
33009 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33010 .cindex "error" "in outgoing SMTP"
33011 .cindex "SMTP" "errors in outgoing"
33012 .cindex "host" "error"
33013 Three different kinds of error are recognized for outgoing SMTP: host errors,
33014 message errors, and recipient errors.
33015
33016 .vlist
33017 .vitem "&*Host errors*&"
33018 A host error is not associated with a particular message or with a
33019 particular recipient of a message. The host errors are:
33020
33021 .ilist
33022 Connection refused or timed out,
33023 .next
33024 Any error response code on connection,
33025 .next
33026 Any error response code to EHLO or HELO,
33027 .next
33028 Loss of connection at any time, except after &"."&,
33029 .next
33030 I/O errors at any time,
33031 .next
33032 Timeouts during the session, other than in response to MAIL, RCPT or
33033 the &"."& at the end of the data.
33034 .endlist ilist
33035
33036 For a host error, a permanent error response on connection, or in response to
33037 EHLO, causes all addresses routed to the host to be failed. Any other host
33038 error causes all addresses to be deferred, and retry data to be created for the
33039 host. It is not tried again, for any message, until its retry time arrives. If
33040 the current set of addresses are not all delivered in this run (to some
33041 alternative host), the message is added to the list of those waiting for this
33042 host, so if it is still undelivered when a subsequent successful delivery is
33043 made to the host, it will be sent down the same SMTP connection.
33044
33045 .vitem "&*Message errors*&"
33046 .cindex "message" "error"
33047 A message error is associated with a particular message when sent to a
33048 particular host, but not with a particular recipient of the message. The
33049 message errors are:
33050
33051 .ilist
33052 Any error response code to MAIL, DATA, or the &"."& that terminates
33053 the data,
33054 .next
33055 Timeout after MAIL,
33056 .next
33057 Timeout or loss of connection after the &"."& that terminates the data. A
33058 timeout after the DATA command itself is treated as a host error, as is loss of
33059 connection at any other time.
33060 .endlist ilist
33061
33062 For a message error, a permanent error response (5&'xx'&) causes all addresses
33063 to be failed, and a delivery error report to be returned to the sender. A
33064 temporary error response (4&'xx'&), or one of the timeouts, causes all
33065 addresses to be deferred. Retry data is not created for the host, but instead,
33066 a retry record for the combination of host plus message id is created. The
33067 message is not added to the list of those waiting for this host. This ensures
33068 that the failing message will not be sent to this host again until the retry
33069 time arrives. However, other messages that are routed to the host are not
33070 affected, so if it is some property of the message that is causing the error,
33071 it will not stop the delivery of other mail.
33072
33073 If the remote host specified support for the SIZE parameter in its response
33074 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33075 over-large message will cause a message error because the error arrives as a
33076 response to MAIL.
33077
33078 .vitem "&*Recipient errors*&"
33079 .cindex "recipient" "error"
33080 A recipient error is associated with a particular recipient of a message. The
33081 recipient errors are:
33082
33083 .ilist
33084 Any error response to RCPT,
33085 .next
33086 Timeout after RCPT.
33087 .endlist
33088
33089 For a recipient error, a permanent error response (5&'xx'&) causes the
33090 recipient address to be failed, and a bounce message to be returned to the
33091 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33092 address to be deferred, and routing retry data to be created for it. This is
33093 used to delay processing of the address in subsequent queue runs, until its
33094 routing retry time arrives. This applies to all messages, but because it
33095 operates only in queue runs, one attempt will be made to deliver a new message
33096 to the failing address before the delay starts to operate. This ensures that,
33097 if the failure is really related to the message rather than the recipient
33098 (&"message too big for this recipient"& is a possible example), other messages
33099 have a chance of getting delivered. If a delivery to the address does succeed,
33100 the retry information gets cleared, so all stuck messages get tried again, and
33101 the retry clock is reset.
33102
33103 The message is not added to the list of those waiting for this host. Use of the
33104 host for other messages is unaffected, and except in the case of a timeout,
33105 other recipients are processed independently, and may be successfully delivered
33106 in the current SMTP session. After a timeout it is of course impossible to
33107 proceed with the session, so all addresses get deferred. However, those other
33108 than the one that failed do not suffer any subsequent retry delays. Therefore,
33109 if one recipient is causing trouble, the others have a chance of getting
33110 through when a subsequent delivery attempt occurs before the failing
33111 recipient's retry time.
33112 .endlist
33113
33114 In all cases, if there are other hosts (or IP addresses) available for the
33115 current set of addresses (for example, from multiple MX records), they are
33116 tried in this run for any undelivered addresses, subject of course to their
33117 own retry data. In other words, recipient error retry data does not take effect
33118 until the next delivery attempt.
33119
33120 Some hosts have been observed to give temporary error responses to every
33121 MAIL command at certain times (&"insufficient space"& has been seen). It
33122 would be nice if such circumstances could be recognized, and defer data for the
33123 host itself created, but this is not possible within the current Exim design.
33124 What actually happens is that retry data for every (host, message) combination
33125 is created.
33126
33127 The reason that timeouts after MAIL and RCPT are treated specially is that
33128 these can sometimes arise as a result of the remote host's verification
33129 procedures. Exim makes this assumption, and treats them as if a temporary error
33130 response had been received. A timeout after &"."& is treated specially because
33131 it is known that some broken implementations fail to recognize the end of the
33132 message if the last character of the last line is a binary zero. Thus, it is
33133 helpful to treat this case as a message error.
33134
33135 Timeouts at other times are treated as host errors, assuming a problem with the
33136 host, or the connection to it. If a timeout after MAIL, RCPT,
33137 or &"."& is really a connection problem, the assumption is that at the next try
33138 the timeout is likely to occur at some other point in the dialogue, causing it
33139 then to be treated as a host error.
33140
33141 There is experimental evidence that some MTAs drop the connection after the
33142 terminating &"."& if they do not like the contents of the message for some
33143 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33144 should be given. That is why Exim treats this case as a message rather than a
33145 host error, in order not to delay other messages to the same host.
33146
33147
33148
33149
33150 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33151 .cindex "SMTP" "incoming over TCP/IP"
33152 .cindex "incoming SMTP over TCP/IP"
33153 .cindex "inetd"
33154 .cindex "daemon"
33155 Incoming SMTP messages can be accepted in one of two ways: by running a
33156 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33157 &_/etc/inetd.conf_& should be like this:
33158 .code
33159 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33160 .endd
33161 Exim distinguishes between this case and the case of a locally running user
33162 agent using the &%-bs%& option by checking whether or not the standard input is
33163 a socket. When it is, either the port must be privileged (less than 1024), or
33164 the caller must be root or the Exim user. If any other user passes a socket
33165 with an unprivileged port number, Exim prints a message on the standard error
33166 stream and exits with an error code.
33167
33168 By default, Exim does not make a log entry when a remote host connects or
33169 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33170 unexpected. It can be made to write such log entries by setting the
33171 &%smtp_connection%& log selector.
33172
33173 .cindex "carriage return"
33174 .cindex "linefeed"
33175 Commands from the remote host are supposed to be terminated by CR followed by
33176 LF. However, there are known to be hosts that do not send CR characters. In
33177 order to be able to interwork with such hosts, Exim treats LF on its own as a
33178 line terminator.
33179 Furthermore, because common code is used for receiving messages from all
33180 sources, a CR on its own is also interpreted as a line terminator. However, the
33181 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33182
33183 .cindex "EHLO" "invalid data"
33184 .cindex "HELO" "invalid data"
33185 One area that sometimes gives rise to problems concerns the EHLO or
33186 HELO commands. Some clients send syntactically invalid versions of these
33187 commands, which Exim rejects by default. (This is nothing to do with verifying
33188 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33189 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33190 match the broken hosts that send invalid commands.
33191
33192 .cindex "SIZE option on MAIL command"
33193 .cindex "MAIL" "SIZE option"
33194 The amount of disk space available is checked whenever SIZE is received on
33195 a MAIL command, independently of whether &%message_size_limit%& or
33196 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33197 false. A temporary error is given if there is not enough space. If
33198 &%check_spool_space%& is set, the check is for that amount of space plus the
33199 value given with SIZE, that is, it checks that the addition of the incoming
33200 message will not reduce the space below the threshold.
33201
33202 When a message is successfully received, Exim includes the local message id in
33203 its response to the final &"."& that terminates the data. If the remote host
33204 logs this text it can help with tracing what has happened to a message.
33205
33206 The Exim daemon can limit the number of simultaneous incoming connections it is
33207 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33208 number of simultaneous incoming connections from a single remote host (see the
33209 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33210 rejected using the SMTP temporary error code 421.
33211
33212 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33213 subprocess has finished, as this can get lost at busy times. Instead, it looks
33214 for completed subprocesses every time it wakes up. Provided there are other
33215 things happening (new incoming calls, starts of queue runs), completed
33216 processes will be noticed and tidied away. On very quiet systems you may
33217 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33218 it will be noticed when the daemon next wakes up.
33219
33220 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33221 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33222 high system load &-- for details see the &%smtp_accept_reserve%&,
33223 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33224 applies in both the daemon and &'inetd'& cases.
33225
33226 Exim normally starts a delivery process for each message received, though this
33227 can be varied by means of the &%-odq%& command line option and the
33228 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33229 number of simultaneously running delivery processes started in this way from
33230 SMTP input can be limited by the &%smtp_accept_queue%& and
33231 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33232 subsequently received messages are just put on the input queue without starting
33233 a delivery process.
33234
33235 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33236 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33237 started up from the &'inetd'& daemon, because in that case each connection is
33238 handled by an entirely independent Exim process. Control by load average is,
33239 however, available with &'inetd'&.
33240
33241 Exim can be configured to verify addresses in incoming SMTP commands as they
33242 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33243 to rewrite addresses at this time &-- before any syntax checking is done. See
33244 section &<<SECTrewriteS>>&.
33245
33246 Exim can also be configured to limit the rate at which a client host submits
33247 MAIL and RCPT commands in a single SMTP session. See the
33248 &%smtp_ratelimit_hosts%& option.
33249
33250
33251
33252 .section "Unrecognized SMTP commands" "SECID234"
33253 .cindex "SMTP" "unrecognized commands"
33254 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33255 commands during a single SMTP connection, it drops the connection after sending
33256 the error response to the last command. The default value for
33257 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33258 abuse that subvert web servers into making connections to SMTP ports; in these
33259 circumstances, a number of non-SMTP lines are sent first.
33260
33261
33262 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33263 .cindex "SMTP" "syntax errors"
33264 .cindex "SMTP" "protocol errors"
33265 A syntax error is detected if an SMTP command is recognized, but there is
33266 something syntactically wrong with its data, for example, a malformed email
33267 address in a RCPT command. Protocol errors include invalid command
33268 sequencing such as RCPT before MAIL. If Exim receives more than
33269 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33270 drops the connection after sending the error response to the last command. The
33271 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33272 broken clients that loop sending bad commands (yes, it has been seen).
33273
33274
33275
33276 .section "Use of non-mail SMTP commands" "SECID236"
33277 .cindex "SMTP" "non-mail commands"
33278 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33279 DATA. Exim counts such commands, and drops the connection if there are too
33280 many of them in a single SMTP session. This action catches some
33281 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33282 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33283 defines what &"too many"& means. Its default value is 10.
33284
33285 When a new message is expected, one occurrence of RSET is not counted. This
33286 allows a client to send one RSET between messages (this is not necessary,
33287 but some clients do it). Exim also allows one uncounted occurrence of HELO
33288 or EHLO, and one occurrence of STARTTLS between messages. After
33289 starting up a TLS session, another EHLO is expected, and so it too is not
33290 counted.
33291
33292 The first occurrence of AUTH in a connection, or immediately following
33293 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33294 RCPT, DATA, and QUIT are counted.
33295
33296 You can control which hosts are subject to the limit set by
33297 &%smtp_accept_max_nonmail%& by setting
33298 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33299 the limit apply to all hosts. This option means that you can exclude any
33300 specific badly-behaved hosts that you have to live with.
33301
33302
33303
33304
33305 .section "The VRFY and EXPN commands" "SECID237"
33306 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33307 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33308 appropriate) in order to decide whether the command should be accepted or not.
33309 If no ACL is defined, the command is rejected.
33310
33311 .cindex "VRFY" "processing"
33312 When VRFY is accepted, it runs exactly the same code as when Exim is
33313 called with the &%-bv%& option.
33314
33315 .cindex "EXPN" "processing"
33316 When EXPN is accepted, a single-level expansion of the address is done.
33317 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33318 than a verification (the &%-bv%& option). If an unqualified local part is given
33319 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33320 of VRFY and EXPN commands are logged on the main and reject logs, and
33321 VRFY verification failures are logged on the main log for consistency with
33322 RCPT failures.
33323
33324
33325
33326 .section "The ETRN command" "SECTETRN"
33327 .cindex "ETRN" "processing"
33328 RFC 1985 describes an SMTP command called ETRN that is designed to
33329 overcome the security problems of the TURN command (which has fallen into
33330 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33331 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33332 should be accepted or not. If no ACL is defined, the command is rejected.
33333
33334 The ETRN command is concerned with &"releasing"& messages that are awaiting
33335 delivery to certain hosts. As Exim does not organize its message queue by host,
33336 the only form of ETRN that is supported by default is the one where the
33337 text starts with the &"#"& prefix, in which case the remainder of the text is
33338 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33339 the &%-R%& option to happen, with the remainder of the ETRN text as its
33340 argument. For example,
33341 .code
33342 ETRN #brigadoon
33343 .endd
33344 runs the command
33345 .code
33346 exim -R brigadoon
33347 .endd
33348 which causes a delivery attempt on all messages with undelivered addresses
33349 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33350 default), Exim prevents the simultaneous execution of more than one queue run
33351 for the same argument string as a result of an ETRN command. This stops
33352 a misbehaving client from starting more than one queue runner at once.
33353
33354 .cindex "hints database" "ETRN serialization"
33355 Exim implements the serialization by means of a hints database in which a
33356 record is written whenever a process is started by ETRN, and deleted when
33357 the process completes. However, Exim does not keep the SMTP session waiting for
33358 the ETRN process to complete. Once ETRN is accepted, the client is sent
33359 a &"success"& return code. Obviously there is scope for hints records to get
33360 left lying around if there is a system or program crash. To guard against this,
33361 Exim ignores any records that are more than six hours old.
33362
33363 .oindex "&%smtp_etrn_command%&"
33364 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33365 used. This specifies a command that is run whenever ETRN is received,
33366 whatever the form of its argument. For
33367 example:
33368 .code
33369 smtp_etrn_command = /etc/etrn_command $domain \
33370                     $sender_host_address
33371 .endd
33372 .vindex "&$domain$&"
33373 The string is split up into arguments which are independently expanded. The
33374 expansion variable &$domain$& is set to the argument of the ETRN command,
33375 and no syntax checking is done on the contents of this argument. Exim does not
33376 wait for the command to complete, so its status code is not checked. Exim runs
33377 under its own uid and gid when receiving incoming SMTP, so it is not possible
33378 for it to change them before running the command.
33379
33380
33381
33382 .section "Incoming local SMTP" "SECID238"
33383 .cindex "SMTP" "local incoming"
33384 Some user agents use SMTP to pass messages to their local MTA using the
33385 standard input and output, as opposed to passing the envelope on the command
33386 line and writing the message to the standard input. This is supported by the
33387 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33388 messages over TCP/IP (including the use of ACLs), except that the envelope
33389 sender given in a MAIL command is ignored unless the caller is trusted. In
33390 an ACL you can detect this form of SMTP input by testing for an empty host
33391 identification. It is common to have this as the first line in the ACL that
33392 runs for RCPT commands:
33393 .code
33394 accept hosts = :
33395 .endd
33396 This accepts SMTP messages from local processes without doing any other tests.
33397
33398
33399
33400 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33401 .cindex "SMTP" "batched outgoing"
33402 .cindex "batched SMTP output"
33403 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33404 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33405 be output in BSMTP format. No SMTP responses are possible for this form of
33406 delivery. All it is doing is using SMTP commands as a way of transmitting the
33407 envelope along with the message.
33408
33409 The message is written to the file or pipe preceded by the SMTP commands
33410 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33411 the message that start with a dot have an extra dot added. The SMTP command
33412 HELO is not normally used. If it is required, the &%message_prefix%& option
33413 can be used to specify it.
33414
33415 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33416 one recipient address at a time by default. However, you can arrange for them
33417 to handle several addresses at once by setting the &%batch_max%& option. When
33418 this is done for BSMTP, messages may contain multiple RCPT commands. See
33419 chapter &<<CHAPbatching>>& for more details.
33420
33421 .vindex "&$host$&"
33422 When one or more addresses are routed to a BSMTP transport by a router that
33423 sets up a host list, the name of the first host on the list is available to the
33424 transport in the variable &$host$&. Here is an example of such a transport and
33425 router:
33426 .code
33427 begin routers
33428 route_append:
33429   driver = manualroute
33430   transport = smtp_appendfile
33431   route_list = domain.example  batch.host.example
33432
33433 begin transports
33434 smtp_appendfile:
33435   driver = appendfile
33436   directory = /var/bsmtp/$host
33437   batch_max = 1000
33438   use_bsmtp
33439   user = exim
33440 .endd
33441 This causes messages addressed to &'domain.example'& to be written in BSMTP
33442 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33443 message (unless there are more than 1000 recipients).
33444
33445
33446
33447 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33448 .cindex "SMTP" "batched incoming"
33449 .cindex "batched SMTP input"
33450 The &%-bS%& command line option causes Exim to accept one or more messages by
33451 reading SMTP on the standard input, but to generate no responses. If the caller
33452 is trusted, the senders in the MAIL commands are believed; otherwise the
33453 sender is always the caller of Exim. Unqualified senders and receivers are not
33454 rejected (there seems little point) but instead just get qualified. HELO
33455 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33456 as NOOP; QUIT quits.
33457
33458 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33459 ACL is run in the same way as for non-SMTP local input.
33460
33461 If an error is detected while reading a message, including a missing &"."& at
33462 the end, Exim gives up immediately. It writes details of the error to the
33463 standard output in a stylized way that the calling program should be able to
33464 make some use of automatically, for example:
33465 .code
33466 554 Unexpected end of file
33467 Transaction started in line 10
33468 Error detected in line 14
33469 .endd
33470 It writes a more verbose version, for human consumption, to the standard error
33471 file, for example:
33472 .code
33473 An error was detected while processing a file of BSMTP input.
33474 The error message was:
33475
33476 501 '>' missing at end of address
33477
33478 The SMTP transaction started in line 10.
33479 The error was detected in line 12.
33480 The SMTP command at fault was:
33481
33482 rcpt to:<malformed@in.com.plete
33483
33484 1 previous message was successfully processed.
33485 The rest of the batch was abandoned.
33486 .endd
33487 The return code from Exim is zero only if there were no errors. It is 1 if some
33488 messages were accepted before an error was detected, and 2 if no messages were
33489 accepted.
33490 .ecindex IIDsmtpproc1
33491 .ecindex IIDsmtpproc2
33492
33493
33494
33495 . ////////////////////////////////////////////////////////////////////////////
33496 . ////////////////////////////////////////////////////////////////////////////
33497
33498 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33499          "Customizing messages"
33500 When a message fails to be delivered, or remains on the queue for more than a
33501 configured amount of time, Exim sends a message to the original sender, or
33502 to an alternative configured address. The text of these messages is built into
33503 the code of Exim, but it is possible to change it, either by adding a single
33504 string, or by replacing each of the paragraphs by text supplied in a file.
33505
33506 The &'From:'& and &'To:'& header lines are automatically generated; you can
33507 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33508 option. Exim also adds the line
33509 .code
33510 Auto-Submitted: auto-generated
33511 .endd
33512 to all warning and bounce messages,
33513
33514
33515 .section "Customizing bounce messages" "SECID239"
33516 .cindex "customizing" "bounce message"
33517 .cindex "bounce message" "customizing"
33518 If &%bounce_message_text%& is set, its contents are included in the default
33519 message immediately after &"This message was created automatically by mail
33520 delivery software."& The string is not expanded. It is not used if
33521 &%bounce_message_file%& is set.
33522
33523 When &%bounce_message_file%& is set, it must point to a template file for
33524 constructing error messages. The file consists of a series of text items,
33525 separated by lines consisting of exactly four asterisks. If the file cannot be
33526 opened, default text is used and a message is written to the main and panic
33527 logs. If any text item in the file is empty, default text is used for that
33528 item.
33529
33530 .vindex "&$bounce_recipient$&"
33531 .vindex "&$bounce_return_size_limit$&"
33532 Each item of text that is read from the file is expanded, and there are two
33533 expansion variables which can be of use here: &$bounce_recipient$& is set to
33534 the recipient of an error message while it is being created, and
33535 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33536 option, rounded to a whole number.
33537
33538 The items must appear in the file in the following order:
33539
33540 .ilist
33541 The first item is included in the headers, and should include at least a
33542 &'Subject:'& header. Exim does not check the syntax of these headers.
33543 .next
33544 The second item forms the start of the error message. After it, Exim lists the
33545 failing addresses with their error messages.
33546 .next
33547 The third item is used to introduce any text from pipe transports that is to be
33548 returned to the sender. It is omitted if there is no such text.
33549 .next
33550 The fourth, fifth and sixth items will be ignored and may be empty.
33551 The fields exist for back-compatibility
33552 .endlist
33553
33554 The default state (&%bounce_message_file%& unset) is equivalent to the
33555 following file, in which the sixth item is empty. The &'Subject:'& and some
33556 other lines have been split in order to fit them on the page:
33557 .code
33558 Subject: Mail delivery failed
33559   ${if eq{$sender_address}{$bounce_recipient}
33560   {: returning message to sender}}
33561 ****
33562 This message was created automatically by mail delivery software.
33563
33564 A message ${if eq{$sender_address}{$bounce_recipient}
33565   {that you sent }{sent by
33566
33567 <$sender_address>
33568
33569 }}could not be delivered to all of its recipients.
33570 This is a permanent error. The following address(es) failed:
33571 ****
33572 The following text was generated during the delivery attempt(s):
33573 ****
33574 ------ This is a copy of the message, including all the headers.
33575   ------
33576 ****
33577 ------ The body of the message is $message_size characters long;
33578   only the first
33579 ------ $bounce_return_size_limit or so are included here.
33580 ****
33581 .endd
33582 .section "Customizing warning messages" "SECTcustwarn"
33583 .cindex "customizing" "warning message"
33584 .cindex "warning of delay" "customizing the message"
33585 The option &%warn_message_file%& can be pointed at a template file for use when
33586 warnings about message delays are created. In this case there are only three
33587 text sections:
33588
33589 .ilist
33590 The first item is included in the headers, and should include at least a
33591 &'Subject:'& header. Exim does not check the syntax of these headers.
33592 .next
33593 The second item forms the start of the warning message. After it, Exim lists
33594 the delayed addresses.
33595 .next
33596 The third item then ends the message.
33597 .endlist
33598
33599 The default state is equivalent to the following file, except that some lines
33600 have been split here, in order to fit them on the page:
33601 .code
33602 Subject: Warning: message $message_exim_id delayed
33603   $warn_message_delay
33604 ****
33605 This message was created automatically by mail delivery software.
33606
33607 A message ${if eq{$sender_address}{$warn_message_recipients}
33608 {that you sent }{sent by
33609
33610 <$sender_address>
33611
33612 }}has not been delivered to all of its recipients after
33613 more than $warn_message_delay on the queue on $primary_hostname.
33614
33615 The message identifier is:     $message_exim_id
33616 The subject of the message is: $h_subject
33617 The date of the message is:    $h_date
33618
33619 The following address(es) have not yet been delivered:
33620 ****
33621 No action is required on your part. Delivery attempts will
33622 continue for some time, and this warning may be repeated at
33623 intervals if the message remains undelivered. Eventually the
33624 mail delivery software will give up, and when that happens,
33625 the message will be returned to you.
33626 .endd
33627 .vindex "&$warn_message_delay$&"
33628 .vindex "&$warn_message_recipients$&"
33629 However, in the default state the subject and date lines are omitted if no
33630 appropriate headers exist. During the expansion of this file,
33631 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33632 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33633 of recipients for the warning message. There may be more than one if there are
33634 multiple addresses with different &%errors_to%& settings on the routers that
33635 handled them.
33636
33637
33638
33639
33640 . ////////////////////////////////////////////////////////////////////////////
33641 . ////////////////////////////////////////////////////////////////////////////
33642
33643 .chapter "Some common configuration settings" "CHAPcomconreq"
33644 This chapter discusses some configuration settings that seem to be fairly
33645 common. More examples and discussion can be found in the Exim book.
33646
33647
33648
33649 .section "Sending mail to a smart host" "SECID240"
33650 .cindex "smart host" "example router"
33651 If you want to send all mail for non-local domains to a &"smart host"&, you
33652 should replace the default &(dnslookup)& router with a router which does the
33653 routing explicitly:
33654 .code
33655 send_to_smart_host:
33656   driver = manualroute
33657   route_list = !+local_domains smart.host.name
33658   transport = remote_smtp
33659 .endd
33660 You can use the smart host's IP address instead of the name if you wish.
33661 If you are using Exim only to submit messages to a smart host, and not for
33662 receiving incoming messages, you can arrange for it to do the submission
33663 synchronously by setting the &%mua_wrapper%& option (see chapter
33664 &<<CHAPnonqueueing>>&).
33665
33666
33667
33668
33669 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33670 .cindex "mailing lists"
33671 Exim can be used to run simple mailing lists, but for large and/or complicated
33672 requirements, the use of additional specialized mailing list software such as
33673 Majordomo or Mailman is recommended.
33674
33675 The &(redirect)& router can be used to handle mailing lists where each list
33676 is maintained in a separate file, which can therefore be managed by an
33677 independent manager. The &%domains%& router option can be used to run these
33678 lists in a separate domain from normal mail. For example:
33679 .code
33680 lists:
33681   driver = redirect
33682   domains = lists.example
33683   file = /usr/lists/$local_part
33684   forbid_pipe
33685   forbid_file
33686   errors_to = $local_part-request@lists.example
33687   no_more
33688 .endd
33689 This router is skipped for domains other than &'lists.example'&. For addresses
33690 in that domain, it looks for a file that matches the local part. If there is no
33691 such file, the router declines, but because &%no_more%& is set, no subsequent
33692 routers are tried, and so the whole delivery fails.
33693
33694 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33695 expanded into a file name or a pipe delivery, which is usually inappropriate in
33696 a mailing list.
33697
33698 .oindex "&%errors_to%&"
33699 The &%errors_to%& option specifies that any delivery errors caused by addresses
33700 taken from a mailing list are to be sent to the given address rather than the
33701 original sender of the message. However, before acting on this, Exim verifies
33702 the error address, and ignores it if verification fails.
33703
33704 For example, using the configuration above, mail sent to
33705 &'dicts@lists.example'& is passed on to those addresses contained in
33706 &_/usr/lists/dicts_&, with error reports directed to
33707 &'dicts-request@lists.example'&, provided that this address can be verified.
33708 There could be a file called &_/usr/lists/dicts-request_& containing
33709 the address(es) of this particular list's manager(s), but other approaches,
33710 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33711 or &%local_part_suffix%& options) to handle addresses of the form
33712 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33713
33714
33715
33716 .section "Syntax errors in mailing lists" "SECID241"
33717 .cindex "mailing lists" "syntax errors in"
33718 If an entry in redirection data contains a syntax error, Exim normally defers
33719 delivery of the original address. That means that a syntax error in a mailing
33720 list holds up all deliveries to the list. This may not be appropriate when a
33721 list is being maintained automatically from data supplied by users, and the
33722 addresses are not rigorously checked.
33723
33724 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33725 entries that fail to parse, noting the incident in the log. If in addition
33726 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33727 whenever a broken address is skipped. It is usually appropriate to set
33728 &%syntax_errors_to%& to the same address as &%errors_to%&.
33729
33730
33731
33732 .section "Re-expansion of mailing lists" "SECID242"
33733 .cindex "mailing lists" "re-expansion of"
33734 Exim remembers every individual address to which a message has been delivered,
33735 in order to avoid duplication, but it normally stores only the original
33736 recipient addresses with a message. If all the deliveries to a mailing list
33737 cannot be done at the first attempt, the mailing list is re-expanded when the
33738 delivery is next tried. This means that alterations to the list are taken into
33739 account at each delivery attempt, so addresses that have been added to
33740 the list since the message arrived will therefore receive a copy of the
33741 message, even though it pre-dates their subscription.
33742
33743 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33744 on the &(redirect)& router. If this is done, any addresses generated by the
33745 router that fail to deliver at the first attempt are added to the message as
33746 &"top level"& addresses, and the parent address that generated them is marked
33747 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33748 subsequent delivery attempts. The disadvantage of this is that if any of the
33749 failing addresses are incorrect, correcting them in the file has no effect on
33750 pre-existing messages.
33751
33752 The original top-level address is remembered with each of the generated
33753 addresses, and is output in any log messages. However, any intermediate parent
33754 addresses are not recorded. This makes a difference to the log only if the
33755 &%all_parents%& selector is set, but for mailing lists there is normally only
33756 one level of expansion anyway.
33757
33758
33759
33760 .section "Closed mailing lists" "SECID243"
33761 .cindex "mailing lists" "closed"
33762 The examples so far have assumed open mailing lists, to which anybody may
33763 send mail. It is also possible to set up closed lists, where mail is accepted
33764 from specified senders only. This is done by making use of the generic
33765 &%senders%& option to restrict the router that handles the list.
33766
33767 The following example uses the same file as a list of recipients and as a list
33768 of permitted senders. It requires three routers:
33769 .code
33770 lists_request:
33771   driver = redirect
33772   domains = lists.example
33773   local_part_suffix = -request
33774   file = /usr/lists/$local_part$local_part_suffix
33775   no_more
33776
33777 lists_post:
33778   driver = redirect
33779   domains = lists.example
33780   senders = ${if exists {/usr/lists/$local_part}\
33781              {lsearch;/usr/lists/$local_part}{*}}
33782   file = /usr/lists/$local_part
33783   forbid_pipe
33784   forbid_file
33785   errors_to = $local_part-request@lists.example
33786   no_more
33787
33788 lists_closed:
33789   driver = redirect
33790   domains = lists.example
33791   allow_fail
33792   data = :fail: $local_part@lists.example is a closed mailing list
33793 .endd
33794 All three routers have the same &%domains%& setting, so for any other domains,
33795 they are all skipped. The first router runs only if the local part ends in
33796 &%-request%&. It handles messages to the list manager(s) by means of an open
33797 mailing list.
33798
33799 The second router runs only if the &%senders%& precondition is satisfied. It
33800 checks for the existence of a list that corresponds to the local part, and then
33801 checks that the sender is on the list by means of a linear search. It is
33802 necessary to check for the existence of the file before trying to search it,
33803 because otherwise Exim thinks there is a configuration error. If the file does
33804 not exist, the expansion of &%senders%& is *, which matches all senders. This
33805 means that the router runs, but because there is no list, declines, and
33806 &%no_more%& ensures that no further routers are run. The address fails with an
33807 &"unrouteable address"& error.
33808
33809 The third router runs only if the second router is skipped, which happens when
33810 a mailing list exists, but the sender is not on it. This router forcibly fails
33811 the address, giving a suitable error message.
33812
33813
33814
33815
33816 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33817 .cindex "VERP"
33818 .cindex "Variable Envelope Return Paths"
33819 .cindex "envelope sender"
33820 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33821 are a way of helping mailing list administrators discover which subscription
33822 address is the cause of a particular delivery failure. The idea is to encode
33823 the original recipient address in the outgoing envelope sender address, so that
33824 if the message is forwarded by another host and then subsequently bounces, the
33825 original recipient can be extracted from the recipient address of the bounce.
33826
33827 .oindex &%errors_to%&
33828 .oindex &%return_path%&
33829 Envelope sender addresses can be modified by Exim using two different
33830 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33831 list examples), or the &%return_path%& option on a transport. The second of
33832 these is effective only if the message is successfully delivered to another
33833 host; it is not used for errors detected on the local host (see the description
33834 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33835 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33836 .code
33837 verp_smtp:
33838   driver = smtp
33839   max_rcpt = 1
33840   return_path = \
33841     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33842       {$1-request+$local_part=$domain@your.dom.example}fail}
33843 .endd
33844 This has the effect of rewriting the return path (envelope sender) on outgoing
33845 SMTP messages, if the local part of the original return path ends in
33846 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33847 local part and domain of the recipient into the return path. Suppose, for
33848 example, that a message whose return path has been set to
33849 &'somelist-request@your.dom.example'& is sent to
33850 &'subscriber@other.dom.example'&. In the transport, the return path is
33851 rewritten as
33852 .code
33853 somelist-request+subscriber=other.dom.example@your.dom.example
33854 .endd
33855 .vindex "&$local_part$&"
33856 For this to work, you must tell Exim to send multiple copies of messages that
33857 have more than one recipient, so that each copy has just one recipient. This is
33858 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33859 might be sent to several different recipients in the same domain, in which case
33860 &$local_part$& is not available in the transport, because it is not unique.
33861
33862 Unless your host is doing nothing but mailing list deliveries, you should
33863 probably use a separate transport for the VERP deliveries, so as not to use
33864 extra resources in making one-per-recipient copies for other deliveries. This
33865 can easily be done by expanding the &%transport%& option in the router:
33866 .code
33867 dnslookup:
33868   driver = dnslookup
33869   domains = ! +local_domains
33870   transport = \
33871     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33872       {verp_smtp}{remote_smtp}}
33873   no_more
33874 .endd
33875 If you want to change the return path using &%errors_to%& in a router instead
33876 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33877 routers that handle mailing list addresses. This will ensure that all delivery
33878 errors, including those detected on the local host, are sent to the VERP
33879 address.
33880
33881 On a host that does no local deliveries and has no manual routing, only the
33882 &(dnslookup)& router needs to be changed. A special transport is not needed for
33883 SMTP deliveries. Every mailing list recipient has its own return path value,
33884 and so Exim must hand them to the transport one at a time. Here is an example
33885 of a &(dnslookup)& router that implements VERP:
33886 .code
33887 verp_dnslookup:
33888   driver = dnslookup
33889   domains = ! +local_domains
33890   transport = remote_smtp
33891   errors_to = \
33892     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33893      {$1-request+$local_part=$domain@your.dom.example}fail}
33894   no_more
33895 .endd
33896 Before you start sending out messages with VERPed return paths, you must also
33897 configure Exim to accept the bounce messages that come back to those paths.
33898 Typically this is done by setting a &%local_part_suffix%& option for a
33899 router, and using this to route the messages to wherever you want to handle
33900 them.
33901
33902 The overhead incurred in using VERP depends very much on the size of the
33903 message, the number of recipient addresses that resolve to the same remote
33904 host, and the speed of the connection over which the message is being sent. If
33905 a lot of addresses resolve to the same host and the connection is slow, sending
33906 a separate copy of the message for each address may take substantially longer
33907 than sending a single copy with many recipients (for which VERP cannot be
33908 used).
33909
33910
33911
33912
33913
33914
33915 .section "Virtual domains" "SECTvirtualdomains"
33916 .cindex "virtual domains"
33917 .cindex "domain" "virtual"
33918 The phrase &'virtual domain'& is unfortunately used with two rather different
33919 meanings:
33920
33921 .ilist
33922 A domain for which there are no real mailboxes; all valid local parts are
33923 aliases for other email addresses. Common examples are organizational
33924 top-level domains and &"vanity"& domains.
33925 .next
33926 One of a number of independent domains that are all handled by the same host,
33927 with mailboxes on that host, but where the mailbox owners do not necessarily
33928 have login accounts on that host.
33929 .endlist
33930
33931 The first usage is probably more common, and does seem more &"virtual"& than
33932 the second. This kind of domain can be handled in Exim with a straightforward
33933 aliasing router. One approach is to create a separate alias file for each
33934 virtual domain. Exim can test for the existence of the alias file to determine
33935 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33936 to a router of this form:
33937 .code
33938 virtual:
33939   driver = redirect
33940   domains = dsearch;/etc/mail/virtual
33941   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33942   no_more
33943 .endd
33944 The &%domains%& option specifies that the router is to be skipped, unless there
33945 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33946 domain that is being processed. When the router runs, it looks up the local
33947 part in the file to find a new address (or list of addresses). The &%no_more%&
33948 setting ensures that if the lookup fails (leading to &%data%& being an empty
33949 string), Exim gives up on the address without trying any subsequent routers.
33950
33951 This one router can handle all the virtual domains because the alias file names
33952 follow a fixed pattern. Permissions can be arranged so that appropriate people
33953 can edit the different alias files. A successful aliasing operation results in
33954 a new envelope recipient address, which is then routed from scratch.
33955
33956 The other kind of &"virtual"& domain can also be handled in a straightforward
33957 way. One approach is to create a file for each domain containing a list of
33958 valid local parts, and use it in a router like this:
33959 .code
33960 my_domains:
33961   driver = accept
33962   domains = dsearch;/etc/mail/domains
33963   local_parts = lsearch;/etc/mail/domains/$domain
33964   transport = my_mailboxes
33965 .endd
33966 The address is accepted if there is a file for the domain, and the local part
33967 can be found in the file. The &%domains%& option is used to check for the
33968 file's existence because &%domains%& is tested before the &%local_parts%&
33969 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33970 because that option is tested after &%local_parts%&. The transport is as
33971 follows:
33972 .code
33973 my_mailboxes:
33974   driver = appendfile
33975   file = /var/mail/$domain/$local_part
33976   user = mail
33977 .endd
33978 This uses a directory of mailboxes for each domain. The &%user%& setting is
33979 required, to specify which uid is to be used for writing to the mailboxes.
33980
33981 The configuration shown here is just one example of how you might support this
33982 requirement. There are many other ways this kind of configuration can be set
33983 up, for example, by using a database instead of separate files to hold all the
33984 information about the domains.
33985
33986
33987
33988 .section "Multiple user mailboxes" "SECTmulbox"
33989 .cindex "multiple mailboxes"
33990 .cindex "mailbox" "multiple"
33991 .cindex "local part" "prefix"
33992 .cindex "local part" "suffix"
33993 Heavy email users often want to operate with multiple mailboxes, into which
33994 incoming mail is automatically sorted. A popular way of handling this is to
33995 allow users to use multiple sender addresses, so that replies can easily be
33996 identified. Users are permitted to add prefixes or suffixes to their local
33997 parts for this purpose. The wildcard facility of the generic router options
33998 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33999 example, consider this router:
34000 .code
34001 userforward:
34002   driver = redirect
34003   check_local_user
34004   file = $home/.forward
34005   local_part_suffix = -*
34006   local_part_suffix_optional
34007   allow_filter
34008 .endd
34009 .vindex "&$local_part_suffix$&"
34010 It runs a user's &_.forward_& file for all local parts of the form
34011 &'username-*'&. Within the filter file the user can distinguish different
34012 cases by testing the variable &$local_part_suffix$&. For example:
34013 .code
34014 if $local_part_suffix contains -special then
34015 save /home/$local_part/Mail/special
34016 endif
34017 .endd
34018 If the filter file does not exist, or does not deal with such addresses, they
34019 fall through to subsequent routers, and, assuming no subsequent use of the
34020 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34021 control over which suffixes are valid.
34022
34023 Alternatively, a suffix can be used to trigger the use of a different
34024 &_.forward_& file &-- which is the way a similar facility is implemented in
34025 another MTA:
34026 .code
34027 userforward:
34028   driver = redirect
34029   check_local_user
34030   file = $home/.forward$local_part_suffix
34031   local_part_suffix = -*
34032   local_part_suffix_optional
34033   allow_filter
34034 .endd
34035 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34036 example, &_.forward-special_& is used. Once again, if the appropriate file
34037 does not exist, or does not deal with the address, it is passed on to
34038 subsequent routers, which could, if required, look for an unqualified
34039 &_.forward_& file to use as a default.
34040
34041
34042
34043 .section "Simplified vacation processing" "SECID244"
34044 .cindex "vacation processing"
34045 The traditional way of running the &'vacation'& program is for a user to set up
34046 a pipe command in a &_.forward_& file
34047 (see section &<<SECTspecitredli>>& for syntax details).
34048 This is prone to error by inexperienced users. There are two features of Exim
34049 that can be used to make this process simpler for users:
34050
34051 .ilist
34052 A local part prefix such as &"vacation-"& can be specified on a router which
34053 can cause the message to be delivered directly to the &'vacation'& program, or
34054 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34055 &_.forward_& file are then much simpler. For example:
34056 .code
34057 spqr, vacation-spqr
34058 .endd
34059 .next
34060 The &%require_files%& generic router option can be used to trigger a
34061 vacation delivery by checking for the existence of a certain file in the
34062 user's home directory. The &%unseen%& generic option should also be used, to
34063 ensure that the original delivery also proceeds. In this case, all the user has
34064 to do is to create a file called, say, &_.vacation_&, containing a vacation
34065 message.
34066 .endlist
34067
34068 Another advantage of both these methods is that they both work even when the
34069 use of arbitrary pipes by users is locked out.
34070
34071
34072
34073 .section "Taking copies of mail" "SECID245"
34074 .cindex "message" "copying every"
34075 Some installations have policies that require archive copies of all messages to
34076 be made. A single copy of each message can easily be taken by an appropriate
34077 command in a system filter, which could, for example, use a different file for
34078 each day's messages.
34079
34080 There is also a shadow transport mechanism that can be used to take copies of
34081 messages that are successfully delivered by local transports, one copy per
34082 delivery. This could be used, &'inter alia'&, to implement automatic
34083 notification of delivery by sites that insist on doing such things.
34084
34085
34086
34087 .section "Intermittently connected hosts" "SECID246"
34088 .cindex "intermittently connected hosts"
34089 It has become quite common (because it is cheaper) for hosts to connect to the
34090 Internet periodically rather than remain connected all the time. The normal
34091 arrangement is that mail for such hosts accumulates on a system that is
34092 permanently connected.
34093
34094 Exim was designed for use on permanently connected hosts, and so it is not
34095 particularly well-suited to use in an intermittently connected environment.
34096 Nevertheless there are some features that can be used.
34097
34098
34099 .section "Exim on the upstream server host" "SECID247"
34100 It is tempting to arrange for incoming mail for the intermittently connected
34101 host to remain on Exim's queue until the client connects. However, this
34102 approach does not scale very well. Two different kinds of waiting message are
34103 being mixed up in the same queue &-- those that cannot be delivered because of
34104 some temporary problem, and those that are waiting for their destination host
34105 to connect. This makes it hard to manage the queue, as well as wasting
34106 resources, because each queue runner scans the entire queue.
34107
34108 A better approach is to separate off those messages that are waiting for an
34109 intermittently connected host. This can be done by delivering these messages
34110 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34111 format, from where they are transmitted by other software when their
34112 destination connects. This makes it easy to collect all the mail for one host
34113 in a single directory, and to apply local timeout rules on a per-message basis
34114 if required.
34115
34116 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34117 you are doing this, you should configure Exim with a long retry period for the
34118 intermittent host. For example:
34119 .code
34120 cheshire.wonderland.fict.example    *   F,5d,24h
34121 .endd
34122 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34123 which messages it has queued up for that host. Once the intermittent host comes
34124 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34125 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34126 causes all the queued up messages to be delivered, often down a single SMTP
34127 connection. While the host remains connected, any new messages get delivered
34128 immediately.
34129
34130 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34131 issued with a different IP address each time it connects, Exim's retry
34132 mechanisms on the holding host get confused, because the IP address is normally
34133 used as part of the key string for holding retry information. This can be
34134 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34135 Since this has disadvantages for permanently connected hosts, it is best to
34136 arrange a separate transport for the intermittently connected ones.
34137
34138
34139
34140 .section "Exim on the intermittently connected client host" "SECID248"
34141 The value of &%smtp_accept_queue_per_connection%& should probably be
34142 increased, or even set to zero (that is, disabled) on the intermittently
34143 connected host, so that all incoming messages down a single connection get
34144 delivered immediately.
34145
34146 .cindex "SMTP" "passed connection"
34147 .cindex "SMTP" "multiple deliveries"
34148 .cindex "multiple SMTP deliveries"
34149 Mail waiting to be sent from an intermittently connected host will probably
34150 not have been routed, because without a connection DNS lookups are not
34151 possible. This means that if a normal queue run is done at connection time,
34152 each message is likely to be sent in a separate SMTP session. This can be
34153 avoided by starting the queue run with a command line option beginning with
34154 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34155 first pass, routing is done but no deliveries take place. The second pass is a
34156 normal queue run; since all the messages have been previously routed, those
34157 destined for the same host are likely to get sent as multiple deliveries in a
34158 single SMTP connection.
34159
34160
34161
34162 . ////////////////////////////////////////////////////////////////////////////
34163 . ////////////////////////////////////////////////////////////////////////////
34164
34165 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34166          "Exim as a non-queueing client"
34167 .cindex "client, non-queueing"
34168 .cindex "smart host" "suppressing queueing"
34169 On a personal computer, it is a common requirement for all
34170 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34171 configured to operate that way, for all the popular operating systems.
34172 However, there are some MUAs for Unix-like systems that cannot be so
34173 configured: they submit messages using the command line interface of
34174 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34175 messages this way.
34176
34177 If the personal computer runs continuously, there is no problem, because it can
34178 run a conventional MTA that handles delivery to the smart host, and deal with
34179 any delays via its queueing mechanism. However, if the computer does not run
34180 continuously or runs different operating systems at different times, queueing
34181 email is not desirable.
34182
34183 There is therefore a requirement for something that can provide the
34184 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34185 any queueing or retrying facilities. Furthermore, the delivery to the smart
34186 host should be synchronous, so that if it fails, the sending MUA is immediately
34187 informed. In other words, we want something that extends an MUA that submits
34188 to a local MTA via the command line so that it behaves like one that submits
34189 to a remote smart host using TCP/SMTP.
34190
34191 There are a number of applications (for example, there is one called &'ssmtp'&)
34192 that do this job. However, people have found them to be lacking in various
34193 ways. For instance, you might want to allow aliasing and forwarding to be done
34194 before sending a message to the smart host.
34195
34196 Exim already had the necessary infrastructure for doing this job. Just a few
34197 tweaks were needed to make it behave as required, though it is somewhat of an
34198 overkill to use a fully-featured MTA for this purpose.
34199
34200 .oindex "&%mua_wrapper%&"
34201 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34202 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34203 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34204 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34205 compatible router and transport configuration. Typically there will be just one
34206 router and one transport, sending everything to a smart host.
34207
34208 When run in MUA wrapping mode, the behaviour of Exim changes in the
34209 following ways:
34210
34211 .ilist
34212 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34213 In other words, the only way to submit messages is via the command line.
34214 .next
34215 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34216 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34217 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34218 does not finish until the delivery attempt is complete. If the delivery is
34219 successful, a zero return code is given.
34220 .next
34221 Address redirection is permitted, but the final routing for all addresses must
34222 be to the same remote transport, and to the same list of hosts. Furthermore,
34223 the return address (envelope sender) must be the same for all recipients, as
34224 must any added or deleted header lines. In other words, it must be possible to
34225 deliver the message in a single SMTP transaction, however many recipients there
34226 are.
34227 .next
34228 If these conditions are not met, or if routing any address results in a
34229 failure or defer status, or if Exim is unable to deliver all the recipients
34230 successfully to one of the smart hosts, delivery of the entire message fails.
34231 .next
34232 Because no queueing is allowed, all failures are treated as permanent; there
34233 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34234 smart host. Furthermore, because only a single yes/no response can be given to
34235 the caller, it is not possible to deliver to some recipients and not others. If
34236 there is an error (temporary or permanent) for any recipient, all are failed.
34237 .next
34238 If more than one smart host is listed, Exim will try another host after a
34239 connection failure or a timeout, in the normal way. However, if this kind of
34240 failure happens for all the hosts, the delivery fails.
34241 .next
34242 When delivery fails, an error message is written to the standard error stream
34243 (as well as to Exim's log), and Exim exits to the caller with a return code
34244 value 1. The message is expunged from Exim's spool files. No bounce messages
34245 are ever generated.
34246 .next
34247 No retry data is maintained, and any retry rules are ignored.
34248 .next
34249 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34250 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34251 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34252 .endlist
34253
34254 The overall effect is that Exim makes a single synchronous attempt to deliver
34255 the message, failing if there is any kind of problem. Because no local
34256 deliveries are done and no daemon can be run, Exim does not need root
34257 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34258 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34259 the advantages and disadvantages of running without root privilege.
34260
34261
34262
34263
34264 . ////////////////////////////////////////////////////////////////////////////
34265 . ////////////////////////////////////////////////////////////////////////////
34266
34267 .chapter "Log files" "CHAPlog"
34268 .scindex IIDloggen "log" "general description"
34269 .cindex "log" "types of"
34270 Exim writes three different logs, referred to as the main log, the reject log,
34271 and the panic log:
34272
34273 .ilist
34274 .cindex "main log"
34275 The main log records the arrival of each message and each delivery in a single
34276 line in each case. The format is as compact as possible, in an attempt to keep
34277 down the size of log files. Two-character flag sequences make it easy to pick
34278 out these lines. A number of other events are recorded in the main log. Some of
34279 them are optional, in which case the &%log_selector%& option controls whether
34280 they are included or not. A Perl script called &'eximstats'&, which does simple
34281 analysis of main log files, is provided in the Exim distribution (see section
34282 &<<SECTmailstat>>&).
34283 .next
34284 .cindex "reject log"
34285 The reject log records information from messages that are rejected as a result
34286 of a configuration option (that is, for policy reasons).
34287 The first line of each rejection is a copy of the line that is also written to
34288 the main log. Then, if the message's header has been read at the time the log
34289 is written, its contents are written to this log. Only the original header
34290 lines are available; header lines added by ACLs are not logged. You can use the
34291 reject log to check that your policy controls are working correctly; on a busy
34292 host this may be easier than scanning the main log for rejection messages. You
34293 can suppress the writing of the reject log by setting &%write_rejectlog%&
34294 false.
34295 .next
34296 .cindex "panic log"
34297 .cindex "system log"
34298 When certain serious errors occur, Exim writes entries to its panic log. If the
34299 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34300 are usually written to the main log as well, but can get lost amid the mass of
34301 other entries. The panic log should be empty under normal circumstances. It is
34302 therefore a good idea to check it (or to have a &'cron'& script check it)
34303 regularly, in order to become aware of any problems. When Exim cannot open its
34304 panic log, it tries as a last resort to write to the system log (syslog). This
34305 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34306 message itself is written at priority LOG_CRIT.
34307 .endlist
34308
34309 Every log line starts with a timestamp, in the format shown in the following
34310 example. Note that many of the examples shown in this chapter are line-wrapped.
34311 In the log file, this would be all on one line:
34312 .code
34313 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34314   by QUIT
34315 .endd
34316 By default, the timestamps are in the local timezone. There are two
34317 ways of changing this:
34318
34319 .ilist
34320 You can set the &%timezone%& option to a different time zone; in particular, if
34321 you set
34322 .code
34323 timezone = UTC
34324 .endd
34325 the timestamps will be in UTC (aka GMT).
34326 .next
34327 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34328 example:
34329 .code
34330 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34331 .endd
34332 .endlist
34333
34334 .cindex "log" "process ids in"
34335 .cindex "pid (process id)" "in log lines"
34336 Exim does not include its process id in log lines by default, but you can
34337 request that it does so by specifying the &`pid`& log selector (see section
34338 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34339 brackets, immediately after the time and date.
34340
34341
34342
34343
34344 .section "Where the logs are written" "SECTwhelogwri"
34345 .cindex "log" "destination"
34346 .cindex "log" "to file"
34347 .cindex "log" "to syslog"
34348 .cindex "syslog"
34349 The logs may be written to local files, or to syslog, or both. However, it
34350 should be noted that many syslog implementations use UDP as a transport, and
34351 are therefore unreliable in the sense that messages are not guaranteed to
34352 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34353 It has also been reported that on large log files (tens of megabytes) you may
34354 need to tweak syslog to prevent it syncing the file with each write &-- on
34355 Linux this has been seen to make syslog take 90% plus of CPU time.
34356
34357 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34358 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34359 configuration. This latter string is expanded, so it can contain, for example,
34360 references to the host name:
34361 .code
34362 log_file_path = /var/log/$primary_hostname/exim_%slog
34363 .endd
34364 It is generally advisable, however, to set the string in &_Local/Makefile_&
34365 rather than at run time, because then the setting is available right from the
34366 start of Exim's execution. Otherwise, if there's something it wants to log
34367 before it has read the configuration file (for example, an error in the
34368 configuration file) it will not use the path you want, and may not be able to
34369 log at all.
34370
34371 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34372 list, currently limited to at most two items. This is one option where the
34373 facility for changing a list separator may not be used. The list must always be
34374 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34375 otherwise the item must either be an absolute path, containing &`%s`& at the
34376 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34377 implying the use of a default path.
34378
34379 When Exim encounters an empty item in the list, it searches the list defined by
34380 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34381 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34382 mean &"use the path specified at build time"&. It no such item exists, log
34383 files are written in the &_log_& subdirectory of the spool directory. This is
34384 equivalent to the setting:
34385 .code
34386 log_file_path = $spool_directory/log/%slog
34387 .endd
34388 If you do not specify anything at build time or run time, that is where the
34389 logs are written.
34390
34391 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34392 are in use &-- see section &<<SECTdatlogfil>>& below.
34393
34394 Here are some examples of possible settings:
34395 .display
34396 &`LOG_FILE_PATH=syslog                    `& syslog only
34397 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34398 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34399 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34400 .endd
34401 If there are more than two paths in the list, the first is used and a panic
34402 error is logged.
34403
34404
34405
34406 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34407 .cindex "log" "cycling local files"
34408 .cindex "cycling logs"
34409 .cindex "&'exicyclog'&"
34410 .cindex "log" "local files; writing to"
34411 Some operating systems provide centralized and standardized methods for cycling
34412 log files. For those that do not, a utility script called &'exicyclog'& is
34413 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34414 main and reject logs each time it is called. The maximum number of old logs to
34415 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34416
34417 An Exim delivery process opens the main log when it first needs to write to it,
34418 and it keeps the file open in case subsequent entries are required &-- for
34419 example, if a number of different deliveries are being done for the same
34420 message. However, remote SMTP deliveries can take a long time, and this means
34421 that the file may be kept open long after it is renamed if &'exicyclog'& or
34422 something similar is being used to rename log files on a regular basis. To
34423 ensure that a switch of log files is noticed as soon as possible, Exim calls
34424 &[stat()]& on the main log's name before reusing an open file, and if the file
34425 does not exist, or its inode has changed, the old file is closed and Exim
34426 tries to open the main log from scratch. Thus, an old log file may remain open
34427 for quite some time, but no Exim processes should write to it once it has been
34428 renamed.
34429
34430
34431
34432 .section "Datestamped log files" "SECTdatlogfil"
34433 .cindex "log" "datestamped files"
34434 Instead of cycling the main and reject log files by renaming them
34435 periodically, some sites like to use files whose names contain a datestamp,
34436 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34437 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34438 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34439 point where the datestamp is required. For example:
34440 .code
34441 log_file_path = /var/spool/exim/log/%slog-%D
34442 log_file_path = /var/log/exim-%s-%D.log
34443 log_file_path = /var/spool/exim/log/%D-%slog
34444 log_file_path = /var/log/exim/%s.%M
34445 .endd
34446 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34447 examples of names generated by the above examples:
34448 .code
34449 /var/spool/exim/log/mainlog-20021225
34450 /var/log/exim-reject-20021225.log
34451 /var/spool/exim/log/20021225-mainlog
34452 /var/log/exim/main.200212
34453 .endd
34454 When this form of log file is specified, Exim automatically switches to new
34455 files at midnight. It does not make any attempt to compress old logs; you
34456 will need to write your own script if you require this. You should not
34457 run &'exicyclog'& with this form of logging.
34458
34459 The location of the panic log is also determined by &%log_file_path%&, but it
34460 is not datestamped, because rotation of the panic log does not make sense.
34461 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34462 the string. In addition, if it immediately follows a slash, a following
34463 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34464 character is removed. Thus, the four examples above would give these panic
34465 log names:
34466 .code
34467 /var/spool/exim/log/paniclog
34468 /var/log/exim-panic.log
34469 /var/spool/exim/log/paniclog
34470 /var/log/exim/panic
34471 .endd
34472
34473
34474 .section "Logging to syslog" "SECID249"
34475 .cindex "log" "syslog; writing to"
34476 The use of syslog does not change what Exim logs or the format of its messages,
34477 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34478 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34479 that, the same strings are written to syslog as to log files. The syslog
34480 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34481 by default, but you can change these by setting the &%syslog_facility%& and
34482 &%syslog_processname%& options, respectively. If Exim was compiled with
34483 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34484 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34485 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34486 the time and host name to each line.
34487 The three log streams are mapped onto syslog priorities as follows:
34488
34489 .ilist
34490 &'mainlog'& is mapped to LOG_INFO
34491 .next
34492 &'rejectlog'& is mapped to LOG_NOTICE
34493 .next
34494 &'paniclog'& is mapped to LOG_ALERT
34495 .endlist
34496
34497 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34498 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34499 these are routed by syslog to the same place. You can suppress this duplication
34500 by setting &%syslog_duplication%& false.
34501
34502 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34503 entries contain multiple lines when headers are included. To cope with both
34504 these cases, entries written to syslog are split into separate &[syslog()]&
34505 calls at each internal newline, and also after a maximum of
34506 870 data characters. (This allows for a total syslog line length of 1024, when
34507 additions such as timestamps are added.) If you are running a syslog
34508 replacement that can handle lines longer than the 1024 characters allowed by
34509 RFC 3164, you should set
34510 .code
34511 SYSLOG_LONG_LINES=yes
34512 .endd
34513 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34514 lines, but it still splits at internal newlines in &'reject'& log entries.
34515
34516 To make it easy to re-assemble split lines later, each component of a split
34517 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34518 where <&'n'&> is the component number and <&'m'&> is the total number of
34519 components in the entry. The / delimiter is used when the line was split
34520 because it was too long; if it was split because of an internal newline, the \
34521 delimiter is used. For example, supposing the length limit to be 50 instead of
34522 870, the following would be the result of a typical rejection message to
34523 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34524 name, and pid as added by syslog:
34525 .code
34526 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34527 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34528 [3/5]  when scanning for sender: missing or malformed lo
34529 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34530 [5/5] mple>)
34531 .endd
34532 The same error might cause the following lines to be written to &"rejectlog"&
34533 (LOG_NOTICE):
34534 .code
34535 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34536 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34537 [3/18] er when scanning for sender: missing or malformed
34538 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34539 [5\18] .example>)
34540 [6\18] Recipients: ph10@some.domain.cam.example
34541 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34542 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34543 [9\18]        id 16RdAL-0006pc-00
34544 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34545 [11\18] 09:43 +0100
34546 [12\18] F From: <>
34547 [13\18]   Subject: this is a test header
34548 [18\18]   X-something: this is another header
34549 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34550 [16\18] le>
34551 [17\18] B Bcc:
34552 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34553 .endd
34554 Log lines that are neither too long nor contain newlines are written to syslog
34555 without modification.
34556
34557 If only syslog is being used, the Exim monitor is unable to provide a log tail
34558 display, unless syslog is routing &'mainlog'& to a file on the local host and
34559 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34560 where it is.
34561
34562
34563
34564 .section "Log line flags" "SECID250"
34565 One line is written to the main log for each message received, and for each
34566 successful, unsuccessful, and delayed delivery. These lines can readily be
34567 picked out by the distinctive two-character flags that immediately follow the
34568 timestamp. The flags are:
34569 .display
34570 &`<=`&     message arrival
34571 &`=>`&     normal message delivery
34572 &`->`&     additional address in same delivery
34573 &`>>`&     cutthrough message delivery
34574 &`*>`&     delivery suppressed by &%-N%&
34575 &`**`&     delivery failed; address bounced
34576 &`==`&     delivery deferred; temporary problem
34577 .endd
34578
34579
34580 .section "Logging message reception" "SECID251"
34581 .cindex "log" "reception line"
34582 The format of the single-line entry in the main log that is written for every
34583 message received is shown in the basic example below, which is split over
34584 several lines in order to fit it on the page:
34585 .code
34586 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34587   H=mailer.fict.example [192.168.123.123] U=exim
34588   P=smtp S=5678 id=<incoming message id>
34589 .endd
34590 The address immediately following &"<="& is the envelope sender address. A
34591 bounce message is shown with the sender address &"<>"&, and if it is locally
34592 generated, this is followed by an item of the form
34593 .code
34594 R=<message id>
34595 .endd
34596 which is a reference to the message that caused the bounce to be sent.
34597
34598 .cindex "HELO"
34599 .cindex "EHLO"
34600 For messages from other hosts, the H and U fields identify the remote host and
34601 record the RFC 1413 identity of the user that sent the message, if one was
34602 received. The number given in square brackets is the IP address of the sending
34603 host. If there is a single, unparenthesized  host name in the H field, as
34604 above, it has been verified to correspond to the IP address (see the
34605 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34606 by the remote host in the SMTP HELO or EHLO command, and has not been
34607 verified. If verification yields a different name to that given for HELO or
34608 EHLO, the verified name appears first, followed by the HELO or EHLO
34609 name in parentheses.
34610
34611 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34612 without brackets, in the HELO or EHLO command, leading to entries in
34613 the log containing text like these examples:
34614 .code
34615 H=(10.21.32.43) [192.168.8.34]
34616 H=([10.21.32.43]) [192.168.8.34]
34617 .endd
34618 This can be confusing. Only the final address in square brackets can be relied
34619 on.
34620
34621 For locally generated messages (that is, messages not received over TCP/IP),
34622 the H field is omitted, and the U field contains the login name of the caller
34623 of Exim.
34624
34625 .cindex "authentication" "logging"
34626 .cindex "AUTH" "logging"
34627 For all messages, the P field specifies the protocol used to receive the
34628 message. This is the value that is stored in &$received_protocol$&. In the case
34629 of incoming SMTP messages, the value indicates whether or not any SMTP
34630 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34631 session was encrypted, there is an additional X field that records the cipher
34632 suite that was used.
34633
34634 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34635 hosts that have authenticated themselves using the SMTP AUTH command. The first
34636 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34637 there is an additional item A= followed by the name of the authenticator that
34638 was used. If an authenticated identification was set up by the authenticator's
34639 &%server_set_id%& option, this is logged too, separated by a colon from the
34640 authenticator name.
34641
34642 .cindex "size" "of message"
34643 The id field records the existing message id, if present. The size of the
34644 received message is given by the S field. When the message is delivered,
34645 headers may be removed or added, so that the size of delivered copies of the
34646 message may not correspond with this value (and indeed may be different to each
34647 other).
34648
34649 The &%log_selector%& option can be used to request the logging of additional
34650 data when a message is received. See section &<<SECTlogselector>>& below.
34651
34652
34653
34654 .section "Logging deliveries" "SECID252"
34655 .cindex "log" "delivery line"
34656 The format of the single-line entry in the main log that is written for every
34657 delivery is shown in one of the examples below, for local and remote
34658 deliveries, respectively. Each example has been split into two lines in order
34659 to fit it on the page:
34660 .code
34661 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34662   <marv@hitch.fict.example> R=localuser T=local_delivery
34663 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34664   monk@holistic.fict.example R=dnslookup T=remote_smtp
34665   H=holistic.fict.example [192.168.234.234]
34666 .endd
34667 For ordinary local deliveries, the original address is given in angle brackets
34668 after the final delivery address, which might be a pipe or a file. If
34669 intermediate address(es) exist between the original and the final address, the
34670 last of these is given in parentheses after the final address. The R and T
34671 fields record the router and transport that were used to process the address.
34672
34673 If SMTP AUTH was used for the delivery there is an additional item A=
34674 followed by the name of the authenticator that was used.
34675 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34676 option, this is logged too, separated by a colon from the authenticator name.
34677
34678 If a shadow transport was run after a successful local delivery, the log line
34679 for the successful delivery has an item added on the end, of the form
34680 .display
34681 &`ST=<`&&'shadow transport name'&&`>`&
34682 .endd
34683 If the shadow transport did not succeed, the error message is put in
34684 parentheses afterwards.
34685
34686 .cindex "asterisk" "after IP address"
34687 When more than one address is included in a single delivery (for example, two
34688 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34689 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34690 down a single SMTP connection, an asterisk follows the IP address in the log
34691 lines for the second and subsequent messages.
34692
34693 .cindex "delivery" "cutthrough; logging"
34694 .cindex "cutthrough" "logging"
34695 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34696 line precedes the reception line, since cutthrough waits for a possible
34697 rejection from the destination in case it can reject the sourced item.
34698
34699 The generation of a reply message by a filter file gets logged as a
34700 &"delivery"& to the addressee, preceded by &">"&.
34701
34702 The &%log_selector%& option can be used to request the logging of additional
34703 data when a message is delivered. See section &<<SECTlogselector>>& below.
34704
34705
34706 .section "Discarded deliveries" "SECID253"
34707 .cindex "discarded messages"
34708 .cindex "message" "discarded"
34709 .cindex "delivery" "discarded; logging"
34710 When a message is discarded as a result of the command &"seen finish"& being
34711 obeyed in a filter file which generates no deliveries, a log entry of the form
34712 .code
34713 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34714   <low.club@bridge.example> R=userforward
34715 .endd
34716 is written, to record why no deliveries are logged. When a message is discarded
34717 because it is aliased to &":blackhole:"& the log line is like this:
34718 .code
34719 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34720   <hole@nowhere.example> R=blackhole_router
34721 .endd
34722
34723
34724 .section "Deferred deliveries" "SECID254"
34725 When a delivery is deferred, a line of the following form is logged:
34726 .code
34727 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34728   R=dnslookup T=smtp defer (146): Connection refused
34729 .endd
34730 In the case of remote deliveries, the error is the one that was given for the
34731 last IP address that was tried. Details of individual SMTP failures are also
34732 written to the log, so the above line would be preceded by something like
34733 .code
34734 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34735   mail1.endrest.example [192.168.239.239]: Connection refused
34736 .endd
34737 When a deferred address is skipped because its retry time has not been reached,
34738 a message is written to the log, but this can be suppressed by setting an
34739 appropriate value in &%log_selector%&.
34740
34741
34742
34743 .section "Delivery failures" "SECID255"
34744 .cindex "delivery" "failure; logging"
34745 If a delivery fails because an address cannot be routed, a line of the
34746 following form is logged:
34747 .code
34748 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34749   <jim@trek99.example>: unknown mail domain
34750 .endd
34751 If a delivery fails at transport time, the router and transport are shown, and
34752 the response from the remote host is included, as in this example:
34753 .code
34754 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34755   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34756   after pipelined RCPT TO:<ace400@pb.example>: host
34757   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34758   <ace400@pb.example>...Addressee unknown
34759 .endd
34760 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34761 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34762 disabling PIPELINING. The log lines for all forms of delivery failure are
34763 flagged with &`**`&.
34764
34765
34766
34767 .section "Fake deliveries" "SECID256"
34768 .cindex "delivery" "fake; logging"
34769 If a delivery does not actually take place because the &%-N%& option has been
34770 used to suppress it, a normal delivery line is written to the log, except that
34771 &"=>"& is replaced by &"*>"&.
34772
34773
34774
34775 .section "Completion" "SECID257"
34776 A line of the form
34777 .code
34778 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34779 .endd
34780 is written to the main log when a message is about to be removed from the spool
34781 at the end of its processing.
34782
34783
34784
34785
34786 .section "Summary of Fields in Log Lines" "SECID258"
34787 .cindex "log" "summary of fields"
34788 A summary of the field identifiers that are used in log lines is shown in
34789 the following table:
34790 .display
34791 &`A   `&        authenticator name (and optional id and sender)
34792 &`C   `&        SMTP confirmation on delivery
34793 &`    `&        command list for &"no mail in SMTP session"&
34794 &`CV  `&        certificate verification status
34795 &`D   `&        duration of &"no mail in SMTP session"&
34796 &`DN  `&        distinguished name from peer certificate
34797 &`DT  `&        on &`=>`& lines: time taken for a delivery
34798 &`F   `&        sender address (on delivery lines)
34799 &`H   `&        host name and IP address
34800 &`I   `&        local interface used
34801 &`id  `&        message id for incoming message
34802 &`P   `&        on &`<=`& lines: protocol used
34803 &`    `&        on &`=>`& and &`**`& lines: return path
34804 &`QT  `&        on &`=>`& lines: time spent on queue so far
34805 &`    `&        on &"Completed"& lines: time spent on queue
34806 &`R   `&        on &`<=`& lines: reference for local bounce
34807 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34808 &`S   `&        size of message
34809 &`SNI `&        server name indication from TLS client hello
34810 &`ST  `&        shadow transport name
34811 &`T   `&        on &`<=`& lines: message subject (topic)
34812 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34813 &`U   `&        local user or RFC 1413 identity
34814 &`X   `&        TLS cipher suite
34815 .endd
34816
34817
34818 .section "Other log entries" "SECID259"
34819 Various other types of log entry are written from time to time. Most should be
34820 self-explanatory. Among the more common are:
34821
34822 .ilist
34823 .cindex "retry" "time not reached"
34824 &'retry time not reached'&&~&~An address previously suffered a temporary error
34825 during routing or local delivery, and the time to retry has not yet arrived.
34826 This message is not written to an individual message log file unless it happens
34827 during the first delivery attempt.
34828 .next
34829 &'retry time not reached for any host'&&~&~An address previously suffered
34830 temporary errors during remote delivery, and the retry time has not yet arrived
34831 for any of the hosts to which it is routed.
34832 .next
34833 .cindex "spool directory" "file locked"
34834 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34835 some other Exim process is already working on the message. This can be quite
34836 common if queue running processes are started at frequent intervals. The
34837 &'exiwhat'& utility script can be used to find out what Exim processes are
34838 doing.
34839 .next
34840 .cindex "error" "ignored"
34841 &'error ignored'&&~&~There are several circumstances that give rise to this
34842 message:
34843 .olist
34844 Exim failed to deliver a bounce message whose age was greater than
34845 &%ignore_bounce_errors_after%&. The bounce was discarded.
34846 .next
34847 A filter file set up a delivery using the &"noerror"& option, and the delivery
34848 failed. The delivery was discarded.
34849 .next
34850 A delivery set up by a router configured with
34851 . ==== As this is a nested list, any displays it contains must be indented
34852 . ==== as otherwise they are too far to the left.
34853 .code
34854     errors_to = <>
34855 .endd
34856 failed. The delivery was discarded.
34857 .endlist olist
34858 .endlist ilist
34859
34860
34861
34862
34863
34864 .section "Reducing or increasing what is logged" "SECTlogselector"
34865 .cindex "log" "selectors"
34866 By setting the &%log_selector%& global option, you can disable some of Exim's
34867 default logging, or you can request additional logging. The value of
34868 &%log_selector%& is made up of names preceded by plus or minus characters. For
34869 example:
34870 .code
34871 log_selector = +arguments -retry_defer
34872 .endd
34873 The list of optional log items is in the following table, with the default
34874 selection marked by asterisks:
34875 .display
34876 &` 8bitmime                   `&  received 8BITMIME status
34877 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34878 &` address_rewrite            `&  address rewriting
34879 &` all_parents                `&  all parents in => lines
34880 &` arguments                  `&  command line arguments
34881 &`*connection_reject          `&  connection rejections
34882 &`*delay_delivery             `&  immediate delivery delayed
34883 &` deliver_time               `&  time taken to perform delivery
34884 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34885 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34886 &`*etrn                       `&  ETRN commands
34887 &`*host_lookup_failed         `&  as it says
34888 &` ident_timeout              `&  timeout for ident connection
34889 &` incoming_interface         `&  incoming interface on <= lines
34890 &` incoming_port              `&  incoming port on <= lines
34891 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34892 &` outgoing_port              `&  add remote port to => lines
34893 &`*queue_run                  `&  start and end queue runs
34894 &` queue_time                 `&  time on queue for one recipient
34895 &` queue_time_overall         `&  time on queue for whole message
34896 &` pid                        `&  Exim process id
34897 &` received_recipients        `&  recipients on <= lines
34898 &` received_sender            `&  sender on <= lines
34899 &`*rejected_header            `&  header contents on reject log
34900 &`*retry_defer                `&  &"retry time not reached"&
34901 &` return_path_on_delivery    `&  put return path on => and ** lines
34902 &` sender_on_delivery         `&  add sender to => lines
34903 &`*sender_verify_fail         `&  sender verification failures
34904 &`*size_reject                `&  rejection because too big
34905 &`*skip_delivery              `&  delivery skipped in a queue run
34906 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34907 &` smtp_connection            `&  SMTP connections
34908 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34909 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34910 &` smtp_no_mail               `&  session with no MAIL commands
34911 &` smtp_protocol_error        `&  SMTP protocol errors
34912 &` smtp_syntax_error          `&  SMTP syntax errors
34913 &` subject                    `&  contents of &'Subject:'& on <= lines
34914 &`*tls_certificate_verified   `&  certificate verification status
34915 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34916 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34917 &` tls_sni                    `&  TLS SNI on <= lines
34918 &` unknown_in_list            `&  DNS lookup failed in list match
34919
34920 &` all                        `&  all of the above
34921 .endd
34922 More details on each of these items follows:
34923
34924 .ilist
34925 .cindex "8BITMIME"
34926 .cindex "log" "8BITMIME"
34927 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34928 which may help in tracking down interoperability issues with ancient MTAs
34929 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34930 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34931 &`7BIT`& and &`8BITMIME`& respectively.
34932 .next
34933 .cindex "&%warn%& ACL verb" "log when skipping"
34934 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34935 its conditions cannot be evaluated, a log line to this effect is written if
34936 this log selector is set.
34937 .next
34938 .cindex "log" "rewriting"
34939 .cindex "rewriting" "logging"
34940 &%address_rewrite%&: This applies both to global rewrites and per-transport
34941 rewrites, but not to rewrites in filters run as an unprivileged user (because
34942 such users cannot access the log).
34943 .next
34944 .cindex "log" "full parentage"
34945 &%all_parents%&: Normally only the original and final addresses are logged on
34946 delivery lines; with this selector, intermediate parents are given in
34947 parentheses between them.
34948 .next
34949 .cindex "log" "Exim arguments"
34950 .cindex "Exim arguments, logging"
34951 &%arguments%&: This causes Exim to write the arguments with which it was called
34952 to the main log, preceded by the current working directory. This is a debugging
34953 feature, added to make it easier to find out how certain MUAs call
34954 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34955 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34956 that are empty or that contain white space are quoted. Non-printing characters
34957 are shown as escape sequences. This facility cannot log unrecognized arguments,
34958 because the arguments are checked before the configuration file is read. The
34959 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34960 between the caller and Exim.
34961 .next
34962 .cindex "log" "connection rejections"
34963 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34964 connection is rejected, for whatever reason.
34965 .next
34966 .cindex "log" "delayed delivery"
34967 .cindex "delayed delivery, logging"
34968 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34969 started for an incoming message because the load is too high or too many
34970 messages were received on one connection. Logging does not occur if no delivery
34971 process is started because &%queue_only%& is set or &%-odq%& was used.
34972 .next
34973 .cindex "log" "delivery duration"
34974 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34975 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34976 .next
34977 .cindex "log" "message size on delivery"
34978 .cindex "size" "of message"
34979 &%delivery_size%&: For each delivery, the size of message delivered is added to
34980 the &"=>"& line, tagged with S=.
34981 .next
34982 .cindex "log" "dnslist defer"
34983 .cindex "DNS list" "logging defer"
34984 .cindex "black list (DNS)"
34985 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34986 DNS black list suffers a temporary error.
34987 .next
34988 .cindex "log" "ETRN commands"
34989 .cindex "ETRN" "logging"
34990 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34991 is run to determine whether or not it is actually accepted. An invalid ETRN
34992 command, or one received within a message transaction is not logged by this
34993 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34994 .next
34995 .cindex "log" "host lookup failure"
34996 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34997 any addresses, or when a lookup of an IP address fails to find a host name, a
34998 log line is written. This logging does not apply to direct DNS lookups when
34999 routing email addresses, but it does apply to &"byname"& lookups.
35000 .next
35001 .cindex "log" "ident timeout"
35002 .cindex "RFC 1413" "logging timeout"
35003 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35004 client's ident port times out.
35005 .next
35006 .cindex "log" "incoming interface"
35007 .cindex "interface" "logging"
35008 &%incoming_interface%&: The interface on which a message was received is added
35009 to the &"<="& line as an IP address in square brackets, tagged by I= and
35010 followed by a colon and the port number. The local interface and port are also
35011 added to other SMTP log lines, for example &"SMTP connection from"&, and to
35012 rejection lines.
35013 .next
35014 .cindex "log" "incoming remote port"
35015 .cindex "port" "logging remote"
35016 .cindex "TCP/IP" "logging incoming remote port"
35017 .vindex "&$sender_fullhost$&"
35018 .vindex "&$sender_rcvhost$&"
35019 &%incoming_port%&: The remote port number from which a message was received is
35020 added to log entries and &'Received:'& header lines, following the IP address
35021 in square brackets, and separated from it by a colon. This is implemented by
35022 changing the value that is put in the &$sender_fullhost$& and
35023 &$sender_rcvhost$& variables. Recording the remote port number has become more
35024 important with the widening use of NAT (see RFC 2505).
35025 .next
35026 .cindex "log" "dropped connection"
35027 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35028 connection is unexpectedly dropped.
35029 .next
35030 .cindex "log" "outgoing remote port"
35031 .cindex "port" "logging outgoint remote"
35032 .cindex "TCP/IP" "logging ougtoing remote port"
35033 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35034 containing => tags) following the IP address. This option is not included in
35035 the default setting, because for most ordinary configurations, the remote port
35036 number is always 25 (the SMTP port).
35037 .next
35038 .cindex "log" "process ids in"
35039 .cindex "pid (process id)" "in log lines"
35040 &%pid%&: The current process id is added to every log line, in square brackets,
35041 immediately after the time and date.
35042 .next
35043 .cindex "log" "queue run"
35044 .cindex "queue runner" "logging"
35045 &%queue_run%&: The start and end of every queue run are logged.
35046 .next
35047 .cindex "log" "queue time"
35048 &%queue_time%&: The amount of time the message has been in the queue on the
35049 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35050 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35051 includes reception time as well as the delivery time for the current address.
35052 This means that it may be longer than the difference between the arrival and
35053 delivery log line times, because the arrival log line is not written until the
35054 message has been successfully received.
35055 .next
35056 &%queue_time_overall%&: The amount of time the message has been in the queue on
35057 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35058 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35059 message, so it includes reception time as well as the total delivery time.
35060 .next
35061 .cindex "log" "recipients"
35062 &%received_recipients%&: The recipients of a message are listed in the main log
35063 as soon as the message is received. The list appears at the end of the log line
35064 that is written when a message is received, preceded by the word &"for"&. The
35065 addresses are listed after they have been qualified, but before any rewriting
35066 has taken place.
35067 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35068 in the list.
35069 .next
35070 .cindex "log" "sender reception"
35071 &%received_sender%&: The unrewritten original sender of a message is added to
35072 the end of the log line that records the message's arrival, after the word
35073 &"from"& (before the recipients if &%received_recipients%& is also set).
35074 .next
35075 .cindex "log" "header lines for rejection"
35076 &%rejected_header%&: If a message's header has been received at the time a
35077 rejection is written to the reject log, the complete header is added to the
35078 log. Header logging can be turned off individually for messages that are
35079 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35080 .next
35081 .cindex "log" "retry defer"
35082 &%retry_defer%&: A log line is written if a delivery is deferred because a
35083 retry time has not yet been reached. However, this &"retry time not reached"&
35084 message is always omitted from individual message logs after the first delivery
35085 attempt.
35086 .next
35087 .cindex "log" "return path"
35088 &%return_path_on_delivery%&: The return path that is being transmitted with
35089 the message is included in delivery and bounce lines, using the tag P=.
35090 This is omitted if no delivery actually happens, for example, if routing fails,
35091 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35092 .next
35093 .cindex "log" "sender on delivery"
35094 &%sender_on_delivery%&: The message's sender address is added to every delivery
35095 and bounce line, tagged by F= (for &"from"&).
35096 This is the original sender that was received with the message; it is not
35097 necessarily the same as the outgoing return path.
35098 .next
35099 .cindex "log" "sender verify failure"
35100 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35101 gives details of a sender verification failure is not written. Log lines for
35102 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35103 detail is lost.
35104 .next
35105 .cindex "log" "size rejection"
35106 &%size_reject%&: A log line is written whenever a message is rejected because
35107 it is too big.
35108 .next
35109 .cindex "log" "frozen messages; skipped"
35110 .cindex "frozen messages" "logging skipping"
35111 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35112 queue run because it is frozen or because another process is already delivering
35113 it.
35114 .cindex "&""spool file is locked""&"
35115 The message that is written is &"spool file is locked"&.
35116 .next
35117 .cindex "log" "smtp confirmation"
35118 .cindex "SMTP" "logging confirmation"
35119 .cindex "LMTP" "logging confirmation"
35120 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35121 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35122 A number of MTAs (including Exim) return an identifying string in this
35123 response.
35124 .next
35125 .cindex "log" "SMTP connections"
35126 .cindex "SMTP" "logging connections"
35127 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35128 established or closed, unless the connection is from a host that matches
35129 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35130 only when the closure is unexpected.) This applies to connections from local
35131 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35132 dropped in the middle of a message, a log line is always written, whether or
35133 not this selector is set, but otherwise nothing is written at the start and end
35134 of connections unless this selector is enabled.
35135
35136 For TCP/IP connections to an Exim daemon, the current number of connections is
35137 included in the log message for each new connection, but note that the count is
35138 reset if the daemon is restarted.
35139 Also, because connections are closed (and the closure is logged) in
35140 subprocesses, the count may not include connections that have been closed but
35141 whose termination the daemon has not yet noticed. Thus, while it is possible to
35142 match up the opening and closing of connections in the log, the value of the
35143 logged counts may not be entirely accurate.
35144 .next
35145 .cindex "log" "SMTP transaction; incomplete"
35146 .cindex "SMTP" "logging incomplete transactions"
35147 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35148 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35149 and the message sender plus any accepted recipients are included in the log
35150 line. This can provide evidence of dictionary attacks.
35151 .next
35152 .cindex "log" "non-MAIL SMTP sessions"
35153 .cindex "MAIL" "logging session without"
35154 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35155 connection terminates without having issued a MAIL command. This includes both
35156 the case when the connection is dropped, and the case when QUIT is used. It
35157 does not include cases where the connection is rejected right at the start (by
35158 an ACL, or because there are too many connections, or whatever). These cases
35159 already have their own log lines.
35160
35161 The log line that is written contains the identity of the client in the usual
35162 way, followed by D= and a time, which records the duration of the connection.
35163 If the connection was authenticated, this fact is logged exactly as it is for
35164 an incoming message, with an A= item. If the connection was encrypted, CV=,
35165 DN=, and X= items may appear as they do for an incoming message, controlled by
35166 the same logging options.
35167
35168 Finally, if any SMTP commands were issued during the connection, a C= item
35169 is added to the line, listing the commands that were used. For example,
35170 .code
35171 C=EHLO,QUIT
35172 .endd
35173 shows that the client issued QUIT straight after EHLO. If there were fewer
35174 than 20 commands, they are all listed. If there were more than 20 commands,
35175 the last 20 are listed, preceded by &"..."&. However, with the default
35176 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35177 have been aborted before 20 non-mail commands are processed.
35178 .next
35179 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35180 colon-separated, is appended to the A= item for a message arrival or delivery
35181 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35182 was accepted or used.
35183 .next
35184 .cindex "log" "SMTP protocol error"
35185 .cindex "SMTP" "logging protocol error"
35186 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35187 encountered. Exim does not have perfect detection of all protocol errors
35188 because of transmission delays and the use of pipelining. If PIPELINING has
35189 been advertised to a client, an Exim server assumes that the client will use
35190 it, and therefore it does not count &"expected"& errors (for example, RCPT
35191 received after rejecting MAIL) as protocol errors.
35192 .next
35193 .cindex "SMTP" "logging syntax errors"
35194 .cindex "SMTP" "syntax errors; logging"
35195 .cindex "SMTP" "unknown command; logging"
35196 .cindex "log" "unknown SMTP command"
35197 .cindex "log" "SMTP syntax error"
35198 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35199 encountered. An unrecognized command is treated as a syntax error. For an
35200 external connection, the host identity is given; for an internal connection
35201 using &%-bs%& the sender identification (normally the calling user) is given.
35202 .next
35203 .cindex "log" "subject"
35204 .cindex "subject, logging"
35205 &%subject%&: The subject of the message is added to the arrival log line,
35206 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35207 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35208 specifies whether characters with values greater than 127 should be logged
35209 unchanged, or whether they should be rendered as escape sequences.
35210 .next
35211 .cindex "log" "certificate verification"
35212 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35213 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35214 verified, and &`CV=no`& if not.
35215 .next
35216 .cindex "log" "TLS cipher"
35217 .cindex "TLS" "logging cipher"
35218 &%tls_cipher%&: When a message is sent or received over an encrypted
35219 connection, the cipher suite used is added to the log line, preceded by X=.
35220 .next
35221 .cindex "log" "TLS peer DN"
35222 .cindex "TLS" "logging peer DN"
35223 &%tls_peerdn%&: When a message is sent or received over an encrypted
35224 connection, and a certificate is supplied by the remote host, the peer DN is
35225 added to the log line, preceded by DN=.
35226 .next
35227 .cindex "log" "TLS SNI"
35228 .cindex "TLS" "logging SNI"
35229 &%tls_sni%&: When a message is received over an encrypted connection, and
35230 the remote host provided the Server Name Indication extension, the SNI is
35231 added to the log line, preceded by SNI=.
35232 .next
35233 .cindex "log" "DNS failure in list"
35234 &%unknown_in_list%&: This setting causes a log entry to be written when the
35235 result of a list match is failure because a DNS lookup failed.
35236 .endlist
35237
35238
35239 .section "Message log" "SECID260"
35240 .cindex "message" "log file for"
35241 .cindex "log" "message log; description of"
35242 .cindex "&_msglog_& directory"
35243 .oindex "&%preserve_message_logs%&"
35244 In addition to the general log files, Exim writes a log file for each message
35245 that it handles. The names of these per-message logs are the message ids, and
35246 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35247 message log contains copies of the log lines that apply to the message. This
35248 makes it easier to inspect the status of an individual message without having
35249 to search the main log. A message log is deleted when processing of the message
35250 is complete, unless &%preserve_message_logs%& is set, but this should be used
35251 only with great care because they can fill up your disk very quickly.
35252
35253 On a heavily loaded system, it may be desirable to disable the use of
35254 per-message logs, in order to reduce disk I/O. This can be done by setting the
35255 &%message_logs%& option false.
35256 .ecindex IIDloggen
35257
35258
35259
35260
35261 . ////////////////////////////////////////////////////////////////////////////
35262 . ////////////////////////////////////////////////////////////////////////////
35263
35264 .chapter "Exim utilities" "CHAPutils"
35265 .scindex IIDutils "utilities"
35266 A number of utility scripts and programs are supplied with Exim and are
35267 described in this chapter. There is also the Exim Monitor, which is covered in
35268 the next chapter. The utilities described here are:
35269
35270 .itable none 0 0 3  7* left  15* left  40* left
35271 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35272   "list what Exim processes are doing"
35273 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35274 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35275 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35276 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35277                                                 various criteria"
35278 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35279 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35280   "extract statistics from the log"
35281 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35282   "check address acceptance from given IP"
35283 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35284 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35285 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35286 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35287 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35288 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35289 .endtable
35290
35291 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35292 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35293 &url(http://duncanthrax.net/exilog/) for details.
35294
35295
35296
35297
35298 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35299 .cindex "&'exiwhat'&"
35300 .cindex "process, querying"
35301 .cindex "SIGUSR1"
35302 On operating systems that can restart a system call after receiving a signal
35303 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35304 a line describing what it is doing to the file &_exim-process.info_& in the
35305 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35306 processes it can find, having first emptied the file. It then waits for one
35307 second to allow the Exim processes to react before displaying the results. In
35308 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35309 send the signal to the Exim processes, so it is normally run as root.
35310
35311 &*Warning*&: This is not an efficient process. It is intended for occasional
35312 use by system administrators. It is not sensible, for example, to set up a
35313 script that sends SIGUSR1 signals to Exim processes at short intervals.
35314
35315
35316 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35317 varies in different operating systems. Not only are different options used,
35318 but the format of the output is different. For this reason, there are some
35319 system configuration options that configure exactly how &'exiwhat'& works. If
35320 it doesn't seem to be working for you, check the following compile-time
35321 options:
35322 .display
35323 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35324 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35325 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35326 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35327 .endd
35328 An example of typical output from &'exiwhat'& is
35329 .code
35330 164 daemon: -q1h, listening on port 25
35331 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35332 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35333   [10.19.42.42] (editor@ref.example)
35334 10592 handling incoming call from [192.168.243.242]
35335 10628 accepting a local non-SMTP message
35336 .endd
35337 The first number in the output line is the process number. The third line has
35338 been split here, in order to fit it on the page.
35339
35340
35341
35342 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35343 .cindex "&'exiqgrep'&"
35344 .cindex "queue" "grepping"
35345 This utility is a Perl script contributed by Matt Hubbard. It runs
35346 .code
35347 exim -bpu
35348 .endd
35349 or (in case &*-a*& switch is specified)
35350 .code
35351 exim -bp
35352 .endd
35353 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35354 contain alternate exim configuration the queue management might be using.
35355
35356 to obtain a queue listing, and then greps the output to select messages 
35357 that match given criteria. The following selection options are available:
35358
35359 .vlist
35360 .vitem &*-f*&&~<&'regex'&>
35361 Match the sender address using a case-insensitive search. The field that is
35362 tested is enclosed in angle brackets, so you can test for bounce messages with
35363 .code
35364 exiqgrep -f '^<>$'
35365 .endd
35366 .vitem &*-r*&&~<&'regex'&>
35367 Match a recipient address using a case-insensitve search. The field that is
35368 tested is not enclosed in angle brackets.
35369
35370 .vitem &*-s*&&~<&'regex'&>
35371 Match against the size field.
35372
35373 .vitem &*-y*&&~<&'seconds'&>
35374 Match messages that are younger than the given time.
35375
35376 .vitem &*-o*&&~<&'seconds'&>
35377 Match messages that are older than the given time.
35378
35379 .vitem &*-z*&
35380 Match only frozen messages.
35381
35382 .vitem &*-x*&
35383 Match only non-frozen messages.
35384 .endlist
35385
35386 The following options control the format of the output:
35387
35388 .vlist
35389 .vitem &*-c*&
35390 Display only the count of matching messages.
35391
35392 .vitem &*-l*&
35393 Long format &-- display the full message information as output by Exim. This is
35394 the default.
35395
35396 .vitem &*-i*&
35397 Display message ids only.
35398
35399 .vitem &*-b*&
35400 Brief format &-- one line per message.
35401
35402 .vitem &*-R*&
35403 Display messages in reverse order.
35404
35405 .vitem &*-a*&
35406 Include delivered recipients in queue listing.
35407 .endlist
35408
35409 There is one more option, &%-h%&, which outputs a list of options.
35410
35411
35412
35413 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35414 .cindex "&'exiqsumm'&"
35415 .cindex "queue" "summary"
35416 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35417 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35418 running a command such as
35419 .code
35420 exim -bp | exiqsumm
35421 .endd
35422 The output consists of one line for each domain that has messages waiting for
35423 it, as in the following example:
35424 .code
35425 3   2322   74m   66m  msn.com.example
35426 .endd
35427 Each line lists the number of pending deliveries for a domain, their total
35428 volume, and the length of time that the oldest and the newest messages have
35429 been waiting. Note that the number of pending deliveries is greater than the
35430 number of messages when messages have more than one recipient.
35431
35432 A summary line is output at the end. By default the output is sorted on the
35433 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35434 the output to be sorted by oldest message and by count of messages,
35435 respectively. There are also three options that split the messages for each
35436 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35437 separates frozen messages, and &%-s%& separates messages according to their
35438 sender.
35439
35440 The output of &'exim -bp'& contains the original addresses in the message, so
35441 this also applies to the output from &'exiqsumm'&. No domains from addresses
35442 generated by aliasing or forwarding are included (unless the &%one_time%&
35443 option of the &(redirect)& router has been used to convert them into &"top
35444 level"& addresses).
35445
35446
35447
35448
35449 .section "Extracting specific information from the log (exigrep)" &&&
35450          "SECTextspeinf"
35451 .cindex "&'exigrep'&"
35452 .cindex "log" "extracts; grepping for"
35453 The &'exigrep'& utility is a Perl script that searches one or more main log
35454 files for entries that match a given pattern. When it finds a match, it
35455 extracts all the log entries for the relevant message, not just those that
35456 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35457 given message, or all mail for a given user, or for a given host, for example.
35458 The input files can be in Exim log format or syslog format.
35459 If a matching log line is not associated with a specific message, it is
35460 included in &'exigrep'&'s output without any additional lines. The usage is:
35461 .new
35462 .display
35463 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35464 .endd
35465 .wen
35466 If no log file names are given on the command line, the standard input is read.
35467
35468 The &%-t%& argument specifies a number of seconds. It adds an additional
35469 condition for message selection. Messages that are complete are shown only if
35470 they spent more than <&'n'&> seconds on the queue.
35471
35472 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35473 makes it case-sensitive. This may give a performance improvement when searching
35474 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35475 option; with &%-I%& they do not. In both cases it is possible to change the
35476 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35477
35478 The &%-l%& option means &"literal"&, that is, treat all characters in the
35479 pattern as standing for themselves. Otherwise the pattern must be a Perl
35480 regular expression.
35481
35482 The &%-v%& option inverts the matching condition. That is, a line is selected
35483 if it does &'not'& match the pattern.
35484
35485 .new
35486 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35487 that are generated as a result/response to a message that &'exigrep'& matched
35488 normally.
35489
35490 Example of &%-M%&:
35491 user_a sends a message to user_b, which generates a bounce back to user_b. If
35492 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35493 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35494 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35495 when searching for &"user_a"& will show both messages since the bounce is
35496 &"related"& to or a &"result"& of the first message that was found by the
35497 search term.
35498 .wen
35499
35500 If the location of a &'zcat'& command is known from the definition of
35501 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35502 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35503
35504
35505 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35506 .cindex "&'exipick'&"
35507 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35508 lists messages from the queue according to a variety of criteria. For details
35509 of &'exipick'&'s facilities, visit the web page at
35510 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35511 the &%--help%& option.
35512
35513
35514 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35515 .cindex "log" "cycling local files"
35516 .cindex "cycling logs"
35517 .cindex "&'exicyclog'&"
35518 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35519 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35520 you are using log files with datestamps in their names (see section
35521 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35522 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35523 There are two command line options for &'exicyclog'&:
35524 .ilist
35525 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35526 default that is set when Exim is built. The default default is 10.
35527 .next
35528 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35529 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35530 overriding the script's default, which is to find the setting from Exim's
35531 configuration.
35532 .endlist
35533
35534 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35535 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35536 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35537 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35538 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35539 logs are handled similarly.
35540
35541 If the limit is greater than 99, the script uses 3-digit numbers such as
35542 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35543 to one that is greater, or &'vice versa'&, you will have to fix the names of
35544 any existing log files.
35545
35546 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35547 the end are deleted. All files with numbers greater than 01 are compressed,
35548 using a compression command which is configured by the COMPRESS_COMMAND
35549 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35550 root &%crontab%& entry of the form
35551 .code
35552 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35553 .endd
35554 assuming you have used the name &"exim"& for the Exim user. You can run
35555 &'exicyclog'& as root if you wish, but there is no need.
35556
35557
35558
35559 .section "Mail statistics (eximstats)" "SECTmailstat"
35560 .cindex "statistics"
35561 .cindex "&'eximstats'&"
35562 A Perl script called &'eximstats'& is provided for extracting statistical
35563 information from log files. The output is either plain text, or HTML.
35564 Exim log files are also supported by the &'Lire'& system produced by the
35565 LogReport Foundation &url(http://www.logreport.org).
35566
35567 The &'eximstats'& script has been hacked about quite a bit over time. The
35568 latest version is the result of some extensive revision by Steve Campbell. A
35569 lot of information is given by default, but there are options for suppressing
35570 various parts of it. Following any options, the arguments to the script are a
35571 list of files, which should be main log files. For example:
35572 .code
35573 eximstats -nr /var/spool/exim/log/mainlog.01
35574 .endd
35575 By default, &'eximstats'& extracts information about the number and volume of
35576 messages received from or delivered to various hosts. The information is sorted
35577 both by message count and by volume, and the top fifty hosts in each category
35578 are listed on the standard output. Similar information, based on email
35579 addresses or domains instead of hosts can be requested by means of various
35580 options. For messages delivered and received locally, similar statistics are
35581 also produced per user.
35582
35583 The output also includes total counts and statistics about delivery errors, and
35584 histograms showing the number of messages received and deliveries made in each
35585 hour of the day. A delivery with more than one address in its envelope (for
35586 example, an SMTP transaction with more than one RCPT command) is counted
35587 as a single delivery by &'eximstats'&.
35588
35589 Though normally more deliveries than receipts are reported (as messages may
35590 have multiple recipients), it is possible for &'eximstats'& to report more
35591 messages received than delivered, even though the queue is empty at the start
35592 and end of the period in question. If an incoming message contains no valid
35593 recipients, no deliveries are recorded for it. A bounce message is handled as
35594 an entirely separate message.
35595
35596 &'eximstats'& always outputs a grand total summary giving the volume and number
35597 of messages received and deliveries made, and the number of hosts involved in
35598 each case. It also outputs the number of messages that were delayed (that is,
35599 not completely delivered at the first attempt), and the number that had at
35600 least one address that failed.
35601
35602 The remainder of the output is in sections that can be independently disabled
35603 or modified by various options. It consists of a summary of deliveries by
35604 transport, histograms of messages received and delivered per time interval
35605 (default per hour), information about the time messages spent on the queue,
35606 a list of relayed messages, lists of the top fifty sending hosts, local
35607 senders, destination hosts, and destination local users by count and by volume,
35608 and a list of delivery errors that occurred.
35609
35610 The relay information lists messages that were actually relayed, that is, they
35611 came from a remote host and were directly delivered to some other remote host,
35612 without being processed (for example, for aliasing or forwarding) locally.
35613
35614 There are quite a few options for &'eximstats'& to control exactly what it
35615 outputs. These are documented in the Perl script itself, and can be extracted
35616 by running the command &(perldoc)& on the script. For example:
35617 .code
35618 perldoc /usr/exim/bin/eximstats
35619 .endd
35620
35621 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35622 .cindex "&'exim_checkaccess'&"
35623 .cindex "policy control" "checking access"
35624 .cindex "checking access"
35625 The &%-bh%& command line argument allows you to run a fake SMTP session with
35626 debugging output, in order to check what Exim is doing when it is applying
35627 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35628 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35629 sometimes you just want to answer the question &"Does this address have
35630 access?"& without bothering with any further details.
35631
35632 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35633 two arguments, an IP address and an email address:
35634 .code
35635 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35636 .endd
35637 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35638 given email address would be accepted in a RCPT command in a TCP/IP
35639 connection from the host with the given IP address. The output of the utility
35640 is either the word &"accepted"&, or the SMTP error response, for example:
35641 .code
35642 Rejected:
35643 550 Relay not permitted
35644 .endd
35645 When running this test, the utility uses &`<>`& as the envelope sender address
35646 for the MAIL command, but you can change this by providing additional
35647 options. These are passed directly to the Exim command. For example, to specify
35648 that the test is to be run with the sender address &'himself@there.example'&
35649 you can use:
35650 .code
35651 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35652                  -f himself@there.example
35653 .endd
35654 Note that these additional Exim command line items must be given after the two
35655 mandatory arguments.
35656
35657 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35658 while running its checks. You can run checks that include callouts by using
35659 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35660
35661
35662
35663 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35664 .cindex "DBM" "building dbm files"
35665 .cindex "building DBM files"
35666 .cindex "&'exim_dbmbuild'&"
35667 .cindex "lower casing"
35668 .cindex "binary zero" "in lookup key"
35669 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35670 the format used by the &(lsearch)& lookup (see section
35671 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35672 names as keys and the remainder of the information as data. The lower-casing
35673 can be prevented by calling the program with the &%-nolc%& option.
35674
35675 A terminating zero is included as part of the key string. This is expected by
35676 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35677 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35678 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35679 files.
35680
35681 The program requires two arguments: the name of the input file (which can be a
35682 single hyphen to indicate the standard input), and the name of the output file.
35683 It creates the output under a temporary name, and then renames it if all went
35684 well.
35685
35686 .cindex "USE_DB"
35687 If the native DB interface is in use (USE_DB is set in a compile-time
35688 configuration file &-- this is common in free versions of Unix) the two file
35689 names must be different, because in this mode the Berkeley DB functions create
35690 a single output file using exactly the name given. For example,
35691 .code
35692 exim_dbmbuild /etc/aliases /etc/aliases.db
35693 .endd
35694 reads the system alias file and creates a DBM version of it in
35695 &_/etc/aliases.db_&.
35696
35697 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35698 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35699 environment, the suffixes are added to the second argument of
35700 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35701 when the Berkeley functions are used in compatibility mode (though this is not
35702 recommended), because in that case it adds a &_.db_& suffix to the file name.
35703
35704 If a duplicate key is encountered, the program outputs a warning, and when it
35705 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35706 option is used. By default, only the first of a set of duplicates is used &--
35707 this makes it compatible with &(lsearch)& lookups. There is an option
35708 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35709 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35710 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35711 return code is 2.
35712
35713
35714
35715
35716 .section "Finding individual retry times (exinext)" "SECTfinindret"
35717 .cindex "retry" "times"
35718 .cindex "&'exinext'&"
35719 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35720 fish specific information out of the retry database. Given a mail domain (or a
35721 complete address), it looks up the hosts for that domain, and outputs any retry
35722 information for the hosts or for the domain. At present, the retry information
35723 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35724 output. For example:
35725 .code
35726 $ exinext piglet@milne.fict.example
35727 kanga.milne.example:192.168.8.1 error 146: Connection refused
35728   first failed: 21-Feb-1996 14:57:34
35729   last tried:   21-Feb-1996 14:57:34
35730   next try at:  21-Feb-1996 15:02:34
35731 roo.milne.example:192.168.8.3 error 146: Connection refused
35732   first failed: 20-Jan-1996 13:12:08
35733   last tried:   21-Feb-1996 11:42:03
35734   next try at:  21-Feb-1996 19:42:03
35735   past final cutoff time
35736 .endd
35737 You can also give &'exinext'& a local part, without a domain, and it
35738 will give any retry information for that local part in your default domain.
35739 A message id can be used to obtain retry information pertaining to a specific
35740 message. This exists only when an attempt to deliver a message to a remote host
35741 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35742 &'exinext'& is not particularly efficient, but then it is not expected to be
35743 run very often.
35744
35745 The &'exinext'& utility calls Exim to find out information such as the location
35746 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35747 passed on to the &'exim'& commands. The first specifies an alternate Exim
35748 configuration file, and the second sets macros for use within the configuration
35749 file. These features are mainly to help in testing, but might also be useful in
35750 environments where more than one configuration file is in use.
35751
35752
35753
35754 .section "Hints database maintenance" "SECThindatmai"
35755 .cindex "hints database" "maintenance"
35756 .cindex "maintaining Exim's hints database"
35757 Three utility programs are provided for maintaining the DBM files that Exim
35758 uses to contain its delivery hint information. Each program requires two
35759 arguments. The first specifies the name of Exim's spool directory, and the
35760 second is the name of the database it is to operate on. These are as follows:
35761
35762 .ilist
35763 &'retry'&: the database of retry information
35764 .next
35765 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35766 for remote hosts
35767 .next
35768 &'callout'&: the callout cache
35769 .next
35770 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35771 .next
35772 &'misc'&: other hints data
35773 .endlist
35774
35775 The &'misc'& database is used for
35776
35777 .ilist
35778 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35779 .next
35780 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35781 &(smtp)& transport)
35782 .endlist
35783
35784
35785
35786 .section "exim_dumpdb" "SECID261"
35787 .cindex "&'exim_dumpdb'&"
35788 The entire contents of a database are written to the standard output by the
35789 &'exim_dumpdb'& program, which has no options or arguments other than the
35790 spool and database names. For example, to dump the retry database:
35791 .code
35792 exim_dumpdb /var/spool/exim retry
35793 .endd
35794 Two lines of output are produced for each entry:
35795 .code
35796 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35797 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35798 .endd
35799 The first item on the first line is the key of the record. It starts with one
35800 of the letters R, or T, depending on whether it refers to a routing or
35801 transport retry. For a local delivery, the next part is the local address; for
35802 a remote delivery it is the name of the remote host, followed by its failing IP
35803 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35804 transport). If the remote port is not the standard one (port 25), it is added
35805 to the IP address. Then there follows an error code, an additional error code,
35806 and a textual description of the error.
35807
35808 The three times on the second line are the time of first failure, the time of
35809 the last delivery attempt, and the computed time for the next attempt. The line
35810 ends with an asterisk if the cutoff time for the last retry rule has been
35811 exceeded.
35812
35813 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35814 consists of a host name followed by a list of ids for messages that are or were
35815 waiting to be delivered to that host. If there are a very large number for any
35816 one host, continuation records, with a sequence number added to the host name,
35817 may be seen. The data in these records is often out of date, because a message
35818 may be routed to several alternative hosts, and Exim makes no effort to keep
35819 cross-references.
35820
35821
35822
35823 .section "exim_tidydb" "SECID262"
35824 .cindex "&'exim_tidydb'&"
35825 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35826 database. If run with no options, it removes all records that are more than 30
35827 days old. The age is calculated from the date and time that the record was last
35828 updated. Note that, in the case of the retry database, it is &'not'& the time
35829 since the first delivery failure. Information about a host that has been down
35830 for more than 30 days will remain in the database, provided that the record is
35831 updated sufficiently often.
35832
35833 The cutoff date can be altered by means of the &%-t%& option, which must be
35834 followed by a time. For example, to remove all records older than a week from
35835 the retry database:
35836 .code
35837 exim_tidydb -t 7d /var/spool/exim retry
35838 .endd
35839 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35840 message ids. In the former these appear as data in records keyed by host &--
35841 they were messages that were waiting for that host &-- and in the latter they
35842 are the keys for retry information for messages that have suffered certain
35843 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35844 message ids in database records are those of messages that are still on the
35845 queue. Message ids for messages that no longer exist are removed from
35846 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35847 For the &'retry'& database, records whose keys are non-existent message ids are
35848 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35849 whenever it removes information from the database.
35850
35851 Certain records are automatically removed by Exim when they are no longer
35852 needed, but others are not. For example, if all the MX hosts for a domain are
35853 down, a retry record is created for each one. If the primary MX host comes back
35854 first, its record is removed when Exim successfully delivers to it, but the
35855 records for the others remain because Exim has not tried to use those hosts.
35856
35857 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35858 hints databases. You should do this at a quiet time of day, because it requires
35859 a database to be locked (and therefore inaccessible to Exim) while it does its
35860 work. Removing records from a DBM file does not normally make the file smaller,
35861 but all the common DBM libraries are able to re-use the space that is released.
35862 After an initial phase of increasing in size, the databases normally reach a
35863 point at which they no longer get any bigger, as long as they are regularly
35864 tidied.
35865
35866 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35867 databases is likely to keep on increasing.
35868
35869
35870
35871
35872 .section "exim_fixdb" "SECID263"
35873 .cindex "&'exim_fixdb'&"
35874 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35875 Its main use is for testing Exim, but it might also be occasionally useful for
35876 getting round problems in a live system. It has no options, and its interface
35877 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35878 key of a database record can then be entered, and the data for that record is
35879 displayed.
35880
35881 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35882 except the &'retry'& database, that is the only operation that can be carried
35883 out. For the &'retry'& database, each field is output preceded by a number, and
35884 data for individual fields can be changed by typing the field number followed
35885 by new data, for example:
35886 .code
35887 > 4 951102:1000
35888 .endd
35889 resets the time of the next delivery attempt. Time values are given as a
35890 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35891 used as optional separators.
35892
35893
35894
35895
35896 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35897 .cindex "mailbox" "maintenance"
35898 .cindex "&'exim_lock'&"
35899 .cindex "locking mailboxes"
35900 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35901 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35902 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35903 a user agent while investigating a problem. The utility requires the name of
35904 the file as its first argument. If the locking is successful, the second
35905 argument is run as a command (using C's &[system()]& function); if there is no
35906 second argument, the value of the SHELL environment variable is used; if this
35907 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35908 is unlocked and the utility ends. The following options are available:
35909
35910 .vlist
35911 .vitem &%-fcntl%&
35912 Use &[fcntl()]& locking on the open mailbox.
35913
35914 .vitem &%-flock%&
35915 Use &[flock()]& locking on the open mailbox, provided the operating system
35916 supports it.
35917
35918 .vitem &%-interval%&
35919 This must be followed by a number, which is a number of seconds; it sets the
35920 interval to sleep between retries (default 3).
35921
35922 .vitem &%-lockfile%&
35923 Create a lock file before opening the mailbox.
35924
35925 .vitem &%-mbx%&
35926 Lock the mailbox using MBX rules.
35927
35928 .vitem &%-q%&
35929 Suppress verification output.
35930
35931 .vitem &%-retries%&
35932 This must be followed by a number; it sets the number of times to try to get
35933 the lock (default 10).
35934
35935 .vitem &%-restore_time%&
35936 This option causes &%exim_lock%& to restore the modified and read times to the
35937 locked file before exiting. This allows you to access a locked mailbox (for
35938 example, to take a backup copy) without disturbing the times that the user
35939 subsequently sees.
35940
35941 .vitem &%-timeout%&
35942 This must be followed by a number, which is a number of seconds; it sets a
35943 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35944 default), a non-blocking call is used.
35945
35946 .vitem &%-v%&
35947 Generate verbose output.
35948 .endlist
35949
35950 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35951 default is to create a lock file and also to use &[fcntl()]& locking on the
35952 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35953 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35954 requires that the directory containing the file be writeable. Locking by lock
35955 file does not last for ever; Exim assumes that a lock file is expired if it is
35956 more than 30 minutes old.
35957
35958 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35959 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35960 to be taken out on the open mailbox, and an exclusive lock on the file
35961 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35962 number of the mailbox file. When the locking is released, if an exclusive lock
35963 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35964
35965 The default output contains verification of the locking that takes place. The
35966 &%-v%& option causes some additional information to be given. The &%-q%& option
35967 suppresses all output except error messages.
35968
35969 A command such as
35970 .code
35971 exim_lock /var/spool/mail/spqr
35972 .endd
35973 runs an interactive shell while the file is locked, whereas
35974 .display
35975 &`exim_lock -q /var/spool/mail/spqr <<End`&
35976 <&'some commands'&>
35977 &`End`&
35978 .endd
35979 runs a specific non-interactive sequence of commands while the file is locked,
35980 suppressing all verification output. A single command can be run by a command
35981 such as
35982 .code
35983 exim_lock -q /var/spool/mail/spqr \
35984   "cp /var/spool/mail/spqr /some/where"
35985 .endd
35986 Note that if a command is supplied, it must be entirely contained within the
35987 second argument &-- hence the quotes.
35988 .ecindex IIDutils
35989
35990
35991 . ////////////////////////////////////////////////////////////////////////////
35992 . ////////////////////////////////////////////////////////////////////////////
35993
35994 .chapter "The Exim monitor" "CHAPeximon"
35995 .scindex IIDeximon "Exim monitor" "description"
35996 .cindex "X-windows"
35997 .cindex "&'eximon'&"
35998 .cindex "Local/eximon.conf"
35999 .cindex "&_exim_monitor/EDITME_&"
36000 The Exim monitor is an application which displays in an X window information
36001 about the state of Exim's queue and what Exim is doing. An admin user can
36002 perform certain operations on messages from this GUI interface; however all
36003 such facilities are also available from the command line, and indeed, the
36004 monitor itself makes use of the command line to perform any actions requested.
36005
36006
36007
36008 .section "Running the monitor" "SECID264"
36009 The monitor is started by running the script called &'eximon'&. This is a shell
36010 script that sets up a number of environment variables, and then runs the
36011 binary called &_eximon.bin_&. The default appearance of the monitor window can
36012 be changed by editing the &_Local/eximon.conf_& file created by editing
36013 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36014 parameters are for.
36015
36016 The parameters that get built into the &'eximon'& script can be overridden for
36017 a particular invocation by setting up environment variables of the same names,
36018 preceded by &`EXIMON_`&. For example, a shell command such as
36019 .code
36020 EXIMON_LOG_DEPTH=400 eximon
36021 .endd
36022 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36023 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36024 overrides the Exim log file configuration. This makes it possible to have
36025 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36026 syslog messages are routed to a file on the local host.
36027
36028 X resources can be used to change the appearance of the window in the normal
36029 way. For example, a resource setting of the form
36030 .code
36031 Eximon*background: gray94
36032 .endd
36033 changes the colour of the background to light grey rather than white. The
36034 stripcharts are drawn with both the data lines and the reference lines in
36035 black. This means that the reference lines are not visible when on top of the
36036 data. However, their colour can be changed by setting a resource called
36037 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36038 For example, if your X server is running Unix, you could set up lighter
36039 reference lines in the stripcharts by obeying
36040 .code
36041 xrdb -merge <<End
36042 Eximon*highlight: gray
36043 End
36044 .endd
36045 .cindex "admin user"
36046 In order to see the contents of messages on the queue, and to operate on them,
36047 &'eximon'& must either be run as root or by an admin user.
36048
36049 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36050 contain X11 resource parameters interpreted by the X11 library.  In addition,
36051 if the first parameter starts with the string "gdb" then it is removed and the
36052 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36053 versioned variants of gdb can be invoked).
36054
36055 The monitor's window is divided into three parts. The first contains one or
36056 more stripcharts and two action buttons, the second contains a &"tail"& of the
36057 main log file, and the third is a display of the queue of messages awaiting
36058 delivery, with two more action buttons. The following sections describe these
36059 different parts of the display.
36060
36061
36062
36063
36064 .section "The stripcharts" "SECID265"
36065 .cindex "stripchart"
36066 The first stripchart is always a count of messages on the queue. Its name can
36067 be configured by setting QUEUE_STRIPCHART_NAME in the
36068 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36069 configuration script by regular expression matches on log file entries, making
36070 it possible to display, for example, counts of messages delivered to certain
36071 hosts or using certain transports. The supplied defaults display counts of
36072 received and delivered messages, and of local and SMTP deliveries. The default
36073 period between stripchart updates is one minute; this can be adjusted by a
36074 parameter in the &_Local/eximon.conf_& file.
36075
36076 The stripchart displays rescale themselves automatically as the value they are
36077 displaying changes. There are always 10 horizontal lines in each chart; the
36078 title string indicates the value of each division when it is greater than one.
36079 For example, &"x2"& means that each division represents a value of 2.
36080
36081 It is also possible to have a stripchart which shows the percentage fullness of
36082 a particular disk partition, which is useful when local deliveries are confined
36083 to a single partition.
36084
36085 .cindex "&%statvfs%& function"
36086 This relies on the availability of the &[statvfs()]& function or equivalent in
36087 the operating system. Most, but not all versions of Unix that support Exim have
36088 this. For this particular stripchart, the top of the chart always represents
36089 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36090 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36091 &_Local/eximon.conf_& file.
36092
36093
36094
36095
36096 .section "Main action buttons" "SECID266"
36097 .cindex "size" "of monitor window"
36098 .cindex "Exim monitor" "window size"
36099 .cindex "window size"
36100 Below the stripcharts there is an action button for quitting the monitor. Next
36101 to this is another button marked &"Size"&. They are placed here so that
36102 shrinking the window to its default minimum size leaves just the queue count
36103 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36104 the window to expand to its maximum size, unless it is already at the maximum,
36105 in which case it is reduced to its minimum.
36106
36107 When expanding to the maximum, if the window cannot be fully seen where it
36108 currently is, it is moved back to where it was the last time it was at full
36109 size. When it is expanding from its minimum size, the old position is
36110 remembered, and next time it is reduced to the minimum it is moved back there.
36111
36112 The idea is that you can keep a reduced window just showing one or two
36113 stripcharts at a convenient place on your screen, easily expand it to show
36114 the full window when required, and just as easily put it back to what it was.
36115 The idea is copied from what the &'twm'& window manager does for its
36116 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36117 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36118
36119 Normally, the monitor starts up with the window at its full size, but it can be
36120 built so that it starts up with the window at its smallest size, by setting
36121 START_SMALL=yes in &_Local/eximon.conf_&.
36122
36123
36124
36125 .section "The log display" "SECID267"
36126 .cindex "log" "tail of; in monitor"
36127 The second section of the window is an area in which a display of the tail of
36128 the main log is maintained.
36129 To save space on the screen, the timestamp on each log line is shortened by
36130 removing the date and, if &%log_timezone%& is set, the timezone.
36131 The log tail is not available when the only destination for logging data is
36132 syslog, unless the syslog lines are routed to a local file whose name is passed
36133 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36134
36135 The log sub-window has a scroll bar at its lefthand side which can be used to
36136 move back to look at earlier text, and the up and down arrow keys also have a
36137 scrolling effect. The amount of log that is kept depends on the setting of
36138 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36139 to use. When this is full, the earlier 50% of data is discarded &-- this is
36140 much more efficient than throwing it away line by line. The sub-window also has
36141 a horizontal scroll bar for accessing the ends of long log lines. This is the
36142 only means of horizontal scrolling; the right and left arrow keys are not
36143 available. Text can be cut from this part of the window using the mouse in the
36144 normal way. The size of this subwindow is controlled by parameters in the
36145 configuration file &_Local/eximon.conf_&.
36146
36147 Searches of the text in the log window can be carried out by means of the ^R
36148 and ^S keystrokes, which default to a reverse and a forward search,
36149 respectively. The search covers only the text that is displayed in the window.
36150 It cannot go further back up the log.
36151
36152 The point from which the search starts is indicated by a caret marker. This is
36153 normally at the end of the text in the window, but can be positioned explicitly
36154 by pointing and clicking with the left mouse button, and is moved automatically
36155 by a successful search. If new text arrives in the window when it is scrolled
36156 back, the caret remains where it is, but if the window is not scrolled back,
36157 the caret is moved to the end of the new text.
36158
36159 Pressing ^R or ^S pops up a window into which the search text can be typed.
36160 There are buttons for selecting forward or reverse searching, for carrying out
36161 the search, and for cancelling. If the &"Search"& button is pressed, the search
36162 happens and the window remains so that further searches can be done. If the
36163 &"Return"& key is pressed, a single search is done and the window is closed. If
36164 ^C is typed the search is cancelled.
36165
36166 The searching facility is implemented using the facilities of the Athena text
36167 widget. By default this pops up a window containing both &"search"& and
36168 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36169 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36170 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36171 provided version of &%TextPop%& when the remaining parts of the text widget
36172 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36173 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36174 on these systems, at the expense of having unwanted items in the search popup
36175 window.
36176
36177
36178
36179 .section "The queue display" "SECID268"
36180 .cindex "queue" "display in monitor"
36181 The bottom section of the monitor window contains a list of all messages that
36182 are on the queue, which includes those currently being received or delivered,
36183 as well as those awaiting delivery. The size of this subwindow is controlled by
36184 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36185 at which it is updated is controlled by another parameter in the same file &--
36186 the default is 5 minutes, since queue scans can be quite expensive. However,
36187 there is an &"Update"& action button just above the display which can be used
36188 to force an update of the queue display at any time.
36189
36190 When a host is down for some time, a lot of pending mail can build up for it,
36191 and this can make it hard to deal with other messages on the queue. To help
36192 with this situation there is a button next to &"Update"& called &"Hide"&. If
36193 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36194 type anything in here and press &"Return"&, the text is added to a chain of
36195 such texts, and if every undelivered address in a message matches at least one
36196 of the texts, the message is not displayed.
36197
36198 If there is an address that does not match any of the texts, all the addresses
36199 are displayed as normal. The matching happens on the ends of addresses so, for
36200 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36201 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36202 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36203 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36204 a hide request is automatically cancelled after one hour.
36205
36206 While the dialogue box is displayed, you can't press any buttons or do anything
36207 else to the monitor window. For this reason, if you want to cut text from the
36208 queue display to use in the dialogue box, you have to do the cutting before
36209 pressing the &"Hide"& button.
36210
36211 The queue display contains, for each unhidden queued message, the length of
36212 time it has been on the queue, the size of the message, the message id, the
36213 message sender, and the first undelivered recipient, all on one line. If it is
36214 a bounce message, the sender is shown as &"<>"&. If there is more than one
36215 recipient to which the message has not yet been delivered, subsequent ones are
36216 listed on additional lines, up to a maximum configured number, following which
36217 an ellipsis is displayed. Recipients that have already received the message are
36218 not shown.
36219
36220 .cindex "frozen messages" "display"
36221 If a message is frozen, an asterisk is displayed at the left-hand side.
36222
36223 The queue display has a vertical scroll bar, and can also be scrolled by means
36224 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36225 The text searching facilities, as described above for the log window, are also
36226 available, but the caret is always moved to the end of the text when the queue
36227 display is updated.
36228
36229
36230
36231 .section "The queue menu" "SECID269"
36232 .cindex "queue" "menu in monitor"
36233 If the &%shift%& key is held down and the left button is clicked when the mouse
36234 pointer is over the text for any message, an action menu pops up, and the first
36235 line of the queue display for the message is highlighted. This does not affect
36236 any selected text.
36237
36238 If you want to use some other event for popping up the menu, you can set the
36239 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36240 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36241 value set in this parameter is a standard X event description. For example, to
36242 run eximon using &%ctrl%& rather than &%shift%& you could use
36243 .code
36244 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36245 .endd
36246 The title of the menu is the message id, and it contains entries which act as
36247 follows:
36248
36249 .ilist
36250 &'message log'&: The contents of the message log for the message are displayed
36251 in a new text window.
36252 .next
36253 &'headers'&: Information from the spool file that contains the envelope
36254 information and headers is displayed in a new text window. See chapter
36255 &<<CHAPspool>>& for a description of the format of spool files.
36256 .next
36257 &'body'&: The contents of the spool file containing the body of the message are
36258 displayed in a new text window. There is a default limit of 20,000 bytes to the
36259 amount of data displayed. This can be changed by setting the BODY_MAX
36260 option at compile time, or the EXIMON_BODY_MAX option at run time.
36261 .next
36262 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36263 delivery of the message. This causes an automatic thaw if the message is
36264 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36265 a new text window. The delivery is run in a separate process, to avoid holding
36266 up the monitor while the delivery proceeds.
36267 .next
36268 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36269 that the message be frozen.
36270 .next
36271 .cindex "thawing messages"
36272 .cindex "unfreezing messages"
36273 .cindex "frozen messages" "thawing"
36274 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36275 that the message be thawed.
36276 .next
36277 .cindex "delivery" "forcing failure"
36278 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36279 that Exim gives up trying to deliver the message. A bounce message is generated
36280 for any remaining undelivered addresses.
36281 .next
36282 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36283 that the message be deleted from the system without generating a bounce
36284 message.
36285 .next
36286 &'add recipient'&: A dialog box is displayed into which a recipient address can
36287 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36288 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36289 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36290 causes a call to Exim to be made using the &%-Mar%& option to request that an
36291 additional recipient be added to the message, unless the entry box is empty, in
36292 which case no action is taken.
36293 .next
36294 &'mark delivered'&: A dialog box is displayed into which a recipient address
36295 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36296 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36297 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36298 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36299 recipient address as already delivered, unless the entry box is empty, in which
36300 case no action is taken.
36301 .next
36302 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36303 mark all recipient addresses as already delivered.
36304 .next
36305 &'edit sender'&: A dialog box is displayed initialized with the current
36306 sender's address. Pressing RETURN causes a call to Exim to be made using the
36307 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36308 in which case no action is taken. If you want to set an empty sender (as in
36309 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36310 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36311 the address is qualified with that domain.
36312 .endlist
36313
36314 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36315 other cases when a call to Exim is made, if there is any output from Exim (in
36316 particular, if the command fails) a window containing the command and the
36317 output is displayed. Otherwise, the results of the action are normally apparent
36318 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36319 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36320 if no output is generated.
36321
36322 The queue display is automatically updated for actions such as freezing and
36323 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36324 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36325 force an update of the display after one of these actions.
36326
36327 In any text window that is displayed as result of a menu action, the normal
36328 cut-and-paste facility is available, and searching can be carried out using ^R
36329 and ^S, as described above for the log tail window.
36330 .ecindex IIDeximon
36331
36332
36333
36334
36335
36336 . ////////////////////////////////////////////////////////////////////////////
36337 . ////////////////////////////////////////////////////////////////////////////
36338
36339 .chapter "Security considerations" "CHAPsecurity"
36340 .scindex IIDsecurcon "security" "discussion of"
36341 This chapter discusses a number of issues concerned with security, some of
36342 which are also covered in other parts of this manual.
36343
36344 For reasons that this author does not understand, some people have promoted
36345 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36346 existence of this chapter in the documentation. However, the intent of the
36347 chapter is simply to describe the way Exim works in relation to certain
36348 security concerns, not to make any specific claims about the effectiveness of
36349 its security as compared with other MTAs.
36350
36351 What follows is a description of the way Exim is supposed to be. Best efforts
36352 have been made to try to ensure that the code agrees with the theory, but an
36353 absence of bugs can never be guaranteed. Any that are reported will get fixed
36354 as soon as possible.
36355
36356
36357 .section "Building a more &""hardened""& Exim" "SECID286"
36358 .cindex "security" "build-time features"
36359 There are a number of build-time options that can be set in &_Local/Makefile_&
36360 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36361 Exim administrator who does not have the root password, or by someone who has
36362 penetrated the Exim (but not the root) account. These options are as follows:
36363
36364 .ilist
36365 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36366 start of any file names used with the &%-C%& option. When it is set, these file
36367 names are also not allowed to contain the sequence &"/../"&. (However, if the
36368 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36369 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36370 default setting for &%ALT_CONFIG_PREFIX%&.
36371
36372 If the permitted configuration files are confined to a directory to
36373 which only root has access, this guards against someone who has broken
36374 into the Exim account from running a privileged Exim with an arbitrary
36375 configuration file, and using it to break into other accounts.
36376 .next
36377
36378 If a non-trusted configuration file (i.e. not the default configuration file
36379 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36380 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36381 the next item), then root privilege is retained only if the caller of Exim is
36382 root. This locks out the possibility of testing a configuration using &%-C%&
36383 right through message reception and delivery, even if the caller is root. The
36384 reception works, but by that time, Exim is running as the Exim user, so when
36385 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36386 privilege to be lost. However, root can test reception and delivery using two
36387 separate commands.
36388
36389 .next
36390 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36391 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36392 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36393 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36394 the restrictive side.  Requiring build-time selection of safe macros is onerous
36395 but this option is intended solely as a transition mechanism to permit
36396 previously-working configurations to continue to work after release 4.73.
36397 .next
36398 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36399 is disabled.
36400 .next
36401 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36402 never to be used for any deliveries. This is like the &%never_users%& runtime
36403 option, but it cannot be overridden; the runtime option adds additional users
36404 to the list. The default setting is &"root"&; this prevents a non-root user who
36405 is permitted to modify the runtime file from using Exim as a way to get root.
36406 .endlist
36407
36408
36409
36410 .section "Root privilege" "SECID270"
36411 .cindex "setuid"
36412 .cindex "root privilege"
36413 The Exim binary is normally setuid to root, which means that it gains root
36414 privilege (runs as root) when it starts execution. In some special cases (for
36415 example, when the daemon is not in use and there are no local deliveries), it
36416 may be possible to run Exim setuid to some user other than root. This is
36417 discussed in the next section. However, in most installations, root privilege
36418 is required for two things:
36419
36420 .ilist
36421 To set up a socket connected to the standard SMTP port (25) when initialising
36422 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36423 not required.
36424 .next
36425 To be able to change uid and gid in order to read users' &_.forward_& files and
36426 perform local deliveries as the receiving user or as specified in the
36427 configuration.
36428 .endlist
36429
36430 It is not necessary to be root to do any of the other things Exim does, such as
36431 receiving messages and delivering them externally over SMTP, and it is
36432 obviously more secure if Exim does not run as root except when necessary.
36433 For this reason, a user and group for Exim to use must be defined in
36434 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36435 group"&. Their values can be changed by the run time configuration, though this
36436 is not recommended. Often a user called &'exim'& is used, but some sites use
36437 &'mail'& or another user name altogether.
36438
36439 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36440 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36441 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36442
36443 After a new Exim process has interpreted its command line options, it changes
36444 uid and gid in the following cases:
36445
36446 .ilist
36447 .oindex "&%-C%&"
36448 .oindex "&%-D%&"
36449 If the &%-C%& option is used to specify an alternate configuration file, or if
36450 the &%-D%& option is used to define macro values for the configuration, and the
36451 calling process is not running as root, the uid and gid are changed to those of
36452 the calling process.
36453 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36454 option may not be used at all.
36455 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36456 can be supplied if the calling process is running as root, the Exim run-time
36457 user or CONFIGURE_OWNER, if defined.
36458 .next
36459 .oindex "&%-be%&"
36460 .oindex "&%-bf%&"
36461 .oindex "&%-bF%&"
36462 If the expansion test option (&%-be%&) or one of the filter testing options
36463 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36464 calling process.
36465 .next
36466 If the process is not a daemon process or a queue runner process or a delivery
36467 process or a process for testing address routing (started with &%-bt%&), the
36468 uid and gid are changed to the Exim user and group. This means that Exim always
36469 runs under its own uid and gid when receiving messages. This also applies when
36470 testing address verification
36471 .oindex "&%-bv%&"
36472 .oindex "&%-bh%&"
36473 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36474 option).
36475 .next
36476 For a daemon, queue runner, delivery, or address testing process, the uid
36477 remains as root at this stage, but the gid is changed to the Exim group.
36478 .endlist
36479
36480 The processes that initially retain root privilege behave as follows:
36481
36482 .ilist
36483 A daemon process changes the gid to the Exim group and the uid to the Exim
36484 user after setting up one or more listening sockets. The &[initgroups()]&
36485 function is called, so that if the Exim user is in any additional groups, they
36486 will be used during message reception.
36487 .next
36488 A queue runner process retains root privilege throughout its execution. Its
36489 job is to fork a controlled sequence of delivery processes.
36490 .next
36491 A delivery process retains root privilege throughout most of its execution,
36492 but any actual deliveries (that is, the transports themselves) are run in
36493 subprocesses which always change to a non-root uid and gid. For local
36494 deliveries this is typically the uid and gid of the owner of the mailbox; for
36495 remote deliveries, the Exim uid and gid are used. Once all the delivery
36496 subprocesses have been run, a delivery process changes to the Exim uid and gid
36497 while doing post-delivery tidying up such as updating the retry database and
36498 generating bounce and warning messages.
36499
36500 While the recipient addresses in a message are being routed, the delivery
36501 process runs as root. However, if a user's filter file has to be processed,
36502 this is done in a subprocess that runs under the individual user's uid and
36503 gid. A system filter is run as root unless &%system_filter_user%& is set.
36504 .next
36505 A process that is testing addresses (the &%-bt%& option) runs as root so that
36506 the routing is done in the same environment as a message delivery.
36507 .endlist
36508
36509
36510
36511
36512 .section "Running Exim without privilege" "SECTrunexiwitpri"
36513 .cindex "privilege, running without"
36514 .cindex "unprivileged running"
36515 .cindex "root privilege" "running without"
36516 Some installations like to run Exim in an unprivileged state for more of its
36517 operation, for added security. Support for this mode of operation is provided
36518 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36519 gid are changed to the Exim user and group at the start of a delivery process
36520 (and also queue runner and address testing processes). This means that address
36521 routing is no longer run as root, and the deliveries themselves cannot change
36522 to any other uid.
36523
36524 .cindex SIGHUP
36525 .cindex "daemon" "restarting"
36526 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36527 that the daemon can still be started in the usual way, and it can respond
36528 correctly to SIGHUP because the re-invocation regains root privilege.
36529
36530 An alternative approach is to make Exim setuid to the Exim user and also setgid
36531 to the Exim group. If you do this, the daemon must be started from a root
36532 process. (Calling Exim from a root process makes it behave in the way it does
36533 when it is setuid root.) However, the daemon cannot restart itself after a
36534 SIGHUP signal because it cannot regain privilege.
36535
36536 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36537 stops Exim from trying to re-invoke itself to do a delivery after a message has
36538 been received. Such a re-invocation is a waste of resources because it has no
36539 effect.
36540
36541 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36542 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36543 to the Exim user seems a clean approach, but there is one complication:
36544
36545 In this style of operation, Exim is running with the real uid and gid set to
36546 those of the calling process, and the effective uid/gid set to Exim's values.
36547 Ideally, any association with the calling process' uid/gid should be dropped,
36548 that is, the real uid/gid should be reset to the effective values so as to
36549 discard any privileges that the caller may have. While some operating systems
36550 have a function that permits this action for a non-root effective uid, quite a
36551 number of them do not. Because of this lack of standardization, Exim does not
36552 address this problem at this time.
36553
36554 For this reason, the recommended approach for &"mostly unprivileged"& running
36555 is to keep the Exim binary setuid to root, and to set
36556 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36557 be used in the most straightforward way.
36558
36559 If you configure Exim not to run delivery processes as root, there are a
36560 number of restrictions on what you can do:
36561
36562 .ilist
36563 You can deliver only as the Exim user/group. You should  explicitly use the
36564 &%user%& and &%group%& options to override routers or local transports that
36565 normally deliver as the recipient. This makes sure that configurations that
36566 work in this mode function the same way in normal mode. Any implicit or
36567 explicit specification of another user causes an error.
36568 .next
36569 Use of &_.forward_& files is severely restricted, such that it is usually
36570 not worthwhile to include them in the configuration.
36571 .next
36572 Users who wish to use &_.forward_& would have to make their home directory and
36573 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36574 and their equivalents in Exim filters, cannot be used. While they could be
36575 enabled in the Exim user's name, that would be insecure and not very useful.
36576 .next
36577 Unless the local user mailboxes are all owned by the Exim user (possible in
36578 some POP3 or IMAP-only environments):
36579
36580 .olist
36581 They must be owned by the Exim group and be writeable by that group. This
36582 implies you must set &%mode%& in the appendfile configuration, as well as the
36583 mode of the mailbox files themselves.
36584 .next
36585 You must set &%no_check_owner%&, since most or all of the files will not be
36586 owned by the Exim user.
36587 .next
36588 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36589 on a newly created mailbox when unprivileged. This also implies that new
36590 mailboxes need to be created manually.
36591 .endlist olist
36592 .endlist ilist
36593
36594
36595 These restrictions severely restrict what can be done in local deliveries.
36596 However, there are no restrictions on remote deliveries. If you are running a
36597 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36598 gives more security at essentially no cost.
36599
36600 If you are using the &%mua_wrapper%& facility (see chapter
36601 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36602
36603
36604
36605
36606 .section "Delivering to local files" "SECID271"
36607 Full details of the checks applied by &(appendfile)& before it writes to a file
36608 are given in chapter &<<CHAPappendfile>>&.
36609
36610
36611
36612 .section "Running local commands" "SECTsecconslocalcmds"
36613 .cindex "security" "local commands"
36614 .cindex "security" "command injection attacks"
36615 There are a number of ways in which an administrator can configure Exim to run
36616 commands based upon received, untrustworthy, data. Further, in some
36617 configurations a user who can control a &_.forward_& file can also arrange to
36618 run commands. Configuration to check includes, but is not limited to:
36619
36620 .ilist
36621 Use of &%use_shell%& in the pipe transport: various forms of shell command
36622 injection may be possible with this option present. It is dangerous and should
36623 be used only with considerable caution. Consider constraints which whitelist
36624 allowed characters in a variable which is to be used in a pipe transport that
36625 has &%use_shell%& enabled.
36626 .next
36627 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36628 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36629 &_.forward_& files in a redirect router. If Exim is running on a central mail
36630 hub to which ordinary users do not have shell access, but home directories are
36631 NFS mounted (for instance) then administrators should review the list of these
36632 forbid options available, and should bear in mind that the options that may
36633 need forbidding can change as new features are added between releases.
36634 .next
36635 The &%${run...}%& expansion item does not use a shell by default, but
36636 administrators can configure use of &_/bin/sh_& as part of the command.
36637 Such invocations should be viewed with prejudicial suspicion.
36638 .next
36639 Administrators who use embedded Perl are advised to explore how Perl's
36640 taint checking might apply to their usage.
36641 .next
36642 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36643 administrators are well advised to view its use with suspicion, in case (for
36644 instance) it allows a local-part to contain embedded Exim directives.
36645 .next
36646 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36647 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36648 each can reference arbitrary lists and files, rather than just being a list
36649 of opaque strings.
36650 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36651 real-world security vulnerabilities caused by its use with untrustworthy data
36652 injected in, for SQL injection attacks.
36653 Consider the use of the &%inlisti%& expansion condition instead.
36654 .endlist
36655
36656
36657
36658
36659 .section "Trust in configuration data" "SECTsecconfdata"
36660 .cindex "security" "data sources"
36661 .cindex "security" "regular expressions"
36662 .cindex "regular expressions" "security"
36663 .cindex "PCRE" "security"
36664 If configuration data for Exim can come from untrustworthy sources, there
36665 are some issues to be aware of:
36666
36667 .ilist
36668 Use of &%${expand...}%& may provide a path for shell injection attacks.
36669 .next
36670 Letting untrusted data provide a regular expression is unwise.
36671 .next
36672 Using &%${match...}%& to apply a fixed regular expression against untrusted
36673 data may result in pathological behaviour within PCRE.  Be aware of what
36674 "backtracking" means and consider options for being more strict with a regular
36675 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36676 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36677 possessive quantifiers or just not using regular expressions against untrusted
36678 data.
36679 .next
36680 It can be important to correctly use &%${quote:...}%&,
36681 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36682 items to ensure that data is correctly constructed.
36683 .next
36684 Some lookups might return multiple results, even though normal usage is only
36685 expected to yield one result.
36686 .endlist
36687
36688
36689
36690
36691 .section "IPv4 source routing" "SECID272"
36692 .cindex "source routing" "in IP packets"
36693 .cindex "IP source routing"
36694 Many operating systems suppress IP source-routed packets in the kernel, but
36695 some cannot be made to do this, so Exim does its own check. It logs incoming
36696 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36697 IPv6. No special checking is currently done.
36698
36699
36700
36701 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36702 Support for these SMTP commands is disabled by default. If required, they can
36703 be enabled by defining suitable ACLs.
36704
36705
36706
36707
36708 .section "Privileged users" "SECID274"
36709 .cindex "trusted users"
36710 .cindex "admin user"
36711 .cindex "privileged user"
36712 .cindex "user" "trusted"
36713 .cindex "user" "admin"
36714 Exim recognizes two sets of users with special privileges. Trusted users are
36715 able to submit new messages to Exim locally, but supply their own sender
36716 addresses and information about a sending host. For other users submitting
36717 local messages, Exim sets up the sender address from the uid, and doesn't
36718 permit a remote host to be specified.
36719
36720 .oindex "&%-f%&"
36721 However, an untrusted user is permitted to use the &%-f%& command line option
36722 in the special form &%-f <>%& to indicate that a delivery failure for the
36723 message should not cause an error report. This affects the message's envelope,
36724 but it does not affect the &'Sender:'& header. Untrusted users may also be
36725 permitted to use specific forms of address with the &%-f%& option by setting
36726 the &%untrusted_set_sender%& option.
36727
36728 Trusted users are used to run processes that receive mail messages from some
36729 other mail domain and pass them on to Exim for delivery either locally, or over
36730 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36731 as any user listed in the &%trusted_users%& configuration option, or under any
36732 group listed in the &%trusted_groups%& option.
36733
36734 Admin users are permitted to do things to the messages on Exim's queue. They
36735 can freeze or thaw messages, cause them to be returned to their senders, remove
36736 them entirely, or modify them in various ways. In addition, admin users can run
36737 the Exim monitor and see all the information it is capable of providing, which
36738 includes the contents of files on the spool.
36739
36740 .oindex "&%-M%&"
36741 .oindex "&%-q%&"
36742 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36743 delivery of messages on its queue is restricted to admin users. This
36744 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36745 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36746 queue is also restricted to admin users. This restriction can be relaxed by
36747 setting &%no_queue_list_requires_admin%&.
36748
36749 Exim recognizes an admin user if the calling process is running as root or as
36750 the Exim user or if any of the groups associated with the calling process is
36751 the Exim group. It is not necessary actually to be running under the Exim
36752 group. However, if admin users who are not root or the Exim user are to access
36753 the contents of files on the spool via the Exim monitor (which runs
36754 unprivileged), Exim must be built to allow group read access to its spool
36755 files.
36756
36757
36758
36759 .section "Spool files" "SECID275"
36760 .cindex "spool directory" "files"
36761 Exim's spool directory and everything it contains is owned by the Exim user and
36762 set to the Exim group. The mode for spool files is defined in the
36763 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36764 any user who is a member of the Exim group can access these files.
36765
36766
36767
36768 .section "Use of argv[0]" "SECID276"
36769 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36770 of specific strings, Exim assumes certain options. For example, calling Exim
36771 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36772 to calling it with the option &%-bS%&. There are no security implications in
36773 this.
36774
36775
36776
36777 .section "Use of %f formatting" "SECID277"
36778 The only use made of &"%f"& by Exim is in formatting load average values. These
36779 are actually stored in integer variables as 1000 times the load average.
36780 Consequently, their range is limited and so therefore is the length of the
36781 converted output.
36782
36783
36784
36785 .section "Embedded Exim path" "SECID278"
36786 Exim uses its own path name, which is embedded in the code, only when it needs
36787 to re-exec in order to regain root privilege. Therefore, it is not root when it
36788 does so. If some bug allowed the path to get overwritten, it would lead to an
36789 arbitrary program's being run as exim, not as root.
36790
36791
36792
36793 .section "Dynamic module directory" "SECTdynmoddir"
36794 Any dynamically loadable modules must be installed into the directory
36795 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36796 loading it.
36797
36798
36799 .section "Use of sprintf()" "SECID279"
36800 .cindex "&[sprintf()]&"
36801 A large number of occurrences of &"sprintf"& in the code are actually calls to
36802 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36803 The intermediate formatting is done into a large fixed buffer by a function
36804 that runs through the format string itself, and checks the length of each
36805 conversion before performing it, thus preventing buffer overruns.
36806
36807 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36808 the output buffer is known to be sufficiently long to contain the converted
36809 string.
36810
36811
36812
36813 .section "Use of debug_printf() and log_write()" "SECID280"
36814 Arbitrary strings are passed to both these functions, but they do their
36815 formatting by calling the function &'string_vformat()'&, which runs through
36816 the format string itself, and checks the length of each conversion.
36817
36818
36819
36820 .section "Use of strcat() and strcpy()" "SECID281"
36821 These are used only in cases where the output buffer is known to be large
36822 enough to hold the result.
36823 .ecindex IIDsecurcon
36824
36825
36826
36827
36828 . ////////////////////////////////////////////////////////////////////////////
36829 . ////////////////////////////////////////////////////////////////////////////
36830
36831 .chapter "Format of spool files" "CHAPspool"
36832 .scindex IIDforspo1 "format" "spool files"
36833 .scindex IIDforspo2 "spool directory" "format of files"
36834 .scindex IIDforspo3 "spool files" "format of"
36835 .cindex "spool files" "editing"
36836 A message on Exim's queue consists of two files, whose names are the message id
36837 followed by -D and -H, respectively. The data portion of the message is kept in
36838 the -D file on its own. The message's envelope, status, and headers are all
36839 kept in the -H file, whose format is described in this chapter. Each of these
36840 two files contains the final component of its own name as its first line. This
36841 is insurance against disk crashes where the directory is lost but the files
36842 themselves are recoverable.
36843
36844 Some people are tempted into editing -D files in order to modify messages. You
36845 need to be extremely careful if you do this; it is not recommended and you are
36846 on your own if you do it. Here are some of the pitfalls:
36847
36848 .ilist
36849 You must ensure that Exim does not try to deliver the message while you are
36850 fiddling with it. The safest way is to take out a write lock on the -D file,
36851 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36852 place, the lock will be retained. If you write a new file and rename it, the
36853 lock will be lost at the instant of rename.
36854 .next
36855 .vindex "&$body_linecount$&"
36856 If you change the number of lines in the file, the value of
36857 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36858 present, this value is not used by Exim, but there is no guarantee that this
36859 will always be the case.
36860 .next
36861 If the message is in MIME format, you must take care not to break it.
36862 .next
36863 If the message is cryptographically signed, any change will invalidate the
36864 signature.
36865 .endlist
36866 All in all, modifying -D files is fraught with danger.
36867
36868 Files whose names end with -J may also be seen in the &_input_& directory (or
36869 its subdirectories when &%split_spool_directory%& is set). These are journal
36870 files, used to record addresses to which the message has been delivered during
36871 the course of a delivery attempt. If there are still undelivered recipients at
36872 the end, the -H file is updated, and the -J file is deleted. If, however, there
36873 is some kind of crash (for example, a power outage) before this happens, the -J
36874 file remains in existence. When Exim next processes the message, it notices the
36875 -J file and uses it to update the -H file before starting the next delivery
36876 attempt.
36877
36878 .section "Format of the -H file" "SECID282"
36879 .cindex "uid (user id)" "in spool file"
36880 .cindex "gid (group id)" "in spool file"
36881 The second line of the -H file contains the login name for the uid of the
36882 process that called Exim to read the message, followed by the numerical uid and
36883 gid. For a locally generated message, this is normally the user who sent the
36884 message. For a message received over TCP/IP via the daemon, it is
36885 normally the Exim user.
36886
36887 The third line of the file contains the address of the message's sender as
36888 transmitted in the envelope, contained in angle brackets. The sender address is
36889 empty for bounce messages. For incoming SMTP mail, the sender address is given
36890 in the MAIL command. For locally generated mail, the sender address is
36891 created by Exim from the login name of the current user and the configured
36892 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36893 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36894 &"<>"& or an address that matches &%untrusted_set_senders%&.
36895
36896 The fourth line contains two numbers. The first is the time that the message
36897 was received, in the conventional Unix form &-- the number of seconds since the
36898 start of the epoch. The second number is a count of the number of messages
36899 warning of delayed delivery that have been sent to the sender.
36900
36901 There follow a number of lines starting with a hyphen. These can appear in any
36902 order, and are omitted when not relevant:
36903
36904 .vlist
36905 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36906 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36907 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36908 recognized, to provide backward compatibility. In the old format, a line of
36909 this form is present for every ACL variable that is not empty. The number
36910 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36911 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36912 the data string for the variable. The string itself starts at the beginning of
36913 the next line, and is followed by a newline character. It may contain internal
36914 newlines.
36915
36916 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36917 A line of this form is present for every ACL connection variable that is
36918 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36919 The length is the length of the data string for the variable. The string itself
36920 starts at the beginning of the next line, and is followed by a newline
36921 character. It may contain internal newlines.
36922
36923 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36924 A line of this form is present for every ACL message variable that is defined.
36925 Note that there is a space between &%-aclm%& and the rest of the name. The
36926 length is the length of the data string for the variable. The string itself
36927 starts at the beginning of the next line, and is followed by a newline
36928 character. It may contain internal newlines.
36929
36930 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36931 This is present if, when the message was received over SMTP, the value of
36932 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36933
36934 .vitem &%-allow_unqualified_recipient%&
36935 This is present if unqualified recipient addresses are permitted in header
36936 lines (to stop such addresses from being qualified if rewriting occurs at
36937 transport time). Local messages that were input using &%-bnq%& and remote
36938 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36939
36940 .vitem &%-allow_unqualified_sender%&
36941 This is present if unqualified sender addresses are permitted in header lines
36942 (to stop such addresses from being qualified if rewriting occurs at transport
36943 time). Local messages that were input using &%-bnq%& and remote messages from
36944 hosts that match &%sender_unqualified_hosts%& set this flag.
36945
36946 .vitem "&%-auth_id%&&~<&'text'&>"
36947 The id information for a message received on an authenticated SMTP connection
36948 &-- the value of the &$authenticated_id$& variable.
36949
36950 .vitem "&%-auth_sender%&&~<&'address'&>"
36951 The address of an authenticated sender &-- the value of the
36952 &$authenticated_sender$& variable.
36953
36954 .vitem "&%-body_linecount%&&~<&'number'&>"
36955 This records the number of lines in the body of the message, and is always
36956 present.
36957
36958 .vitem "&%-body_zerocount%&&~<&'number'&>"
36959 This records the number of binary zero bytes in the body of the message, and is
36960 present if the number is greater than zero.
36961
36962 .vitem &%-deliver_firsttime%&
36963 This is written when a new message is first added to the spool. When the spool
36964 file is updated after a deferral, it is omitted.
36965
36966 .vitem "&%-frozen%&&~<&'time'&>"
36967 .cindex "frozen messages" "spool data"
36968 The message is frozen, and the freezing happened at <&'time'&>.
36969
36970 .vitem "&%-helo_name%&&~<&'text'&>"
36971 This records the host name as specified by a remote host in a HELO or EHLO
36972 command.
36973
36974 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36975 This records the IP address of the host from which the message was received and
36976 the remote port number that was used. It is omitted for locally generated
36977 messages.
36978
36979 .vitem "&%-host_auth%&&~<&'text'&>"
36980 If the message was received on an authenticated SMTP connection, this records
36981 the name of the authenticator &-- the value of the
36982 &$sender_host_authenticated$& variable.
36983
36984 .vitem &%-host_lookup_failed%&
36985 This is present if an attempt to look up the sending host's name from its IP
36986 address failed. It corresponds to the &$host_lookup_failed$& variable.
36987
36988 .vitem "&%-host_name%&&~<&'text'&>"
36989 .cindex "reverse DNS lookup"
36990 .cindex "DNS" "reverse lookup"
36991 This records the name of the remote host from which the message was received,
36992 if the host name was looked up from the IP address when the message was being
36993 received. It is not present if no reverse lookup was done.
36994
36995 .vitem "&%-ident%&&~<&'text'&>"
36996 For locally submitted messages, this records the login of the originating user,
36997 unless it was a trusted user and the &%-oMt%& option was used to specify an
36998 ident value. For messages received over TCP/IP, this records the ident string
36999 supplied by the remote host, if any.
37000
37001 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37002 This records the IP address of the local interface and the port number through
37003 which a message was received from a remote host. It is omitted for locally
37004 generated messages.
37005
37006 .vitem &%-local%&
37007 The message is from a local sender.
37008
37009 .vitem &%-localerror%&
37010 The message is a locally-generated bounce message.
37011
37012 .vitem "&%-local_scan%&&~<&'string'&>"
37013 This records the data string that was returned by the &[local_scan()]& function
37014 when the message was received &-- the value of the &$local_scan_data$&
37015 variable. It is omitted if no data was returned.
37016
37017 .vitem &%-manual_thaw%&
37018 The message was frozen but has been thawed manually, that is, by an explicit
37019 Exim command rather than via the auto-thaw process.
37020
37021 .vitem &%-N%&
37022 A testing delivery process was started using the &%-N%& option to suppress any
37023 actual deliveries, but delivery was deferred. At any further delivery attempts,
37024 &%-N%& is assumed.
37025
37026 .vitem &%-received_protocol%&
37027 This records the value of the &$received_protocol$& variable, which contains
37028 the name of the protocol by which the message was received.
37029
37030 .vitem &%-sender_set_untrusted%&
37031 The envelope sender of this message was set by an untrusted local caller (used
37032 to ensure that the caller is displayed in queue listings).
37033
37034 .vitem "&%-spam_score_int%&&~<&'number'&>"
37035 If a message was scanned by SpamAssassin, this is present. It records the value
37036 of &$spam_score_int$&.
37037
37038 .vitem &%-tls_certificate_verified%&
37039 A TLS certificate was received from the client that sent this message, and the
37040 certificate was verified by the server.
37041
37042 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37043 When the message was received over an encrypted connection, this records the
37044 name of the cipher suite that was used.
37045
37046 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37047 When the message was received over an encrypted connection, and a certificate
37048 was received from the client, this records the Distinguished Name from that
37049 certificate.
37050 .endlist
37051
37052 Following the options there is a list of those addresses to which the message
37053 is not to be delivered. This set of addresses is initialized from the command
37054 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37055 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37056 the address is added to this set. The addresses are kept internally as a
37057 balanced binary tree, and it is a representation of that tree which is written
37058 to the spool file. If an address is expanded via an alias or forward file, the
37059 original address is added to the tree when deliveries to all its child
37060 addresses are complete.
37061
37062 If the tree is empty, there is a single line in the spool file containing just
37063 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37064 Y or N, followed by an address. The address is the value for the node of the
37065 tree, and the letters indicate whether the node has a left branch and/or a
37066 right branch attached to it, respectively. If branches exist, they immediately
37067 follow. Here is an example of a three-node tree:
37068 .code
37069 YY darcy@austen.fict.example
37070 NN alice@wonderland.fict.example
37071 NN editor@thesaurus.ref.example
37072 .endd
37073 After the non-recipients tree, there is a list of the message's recipients.
37074 This is a simple list, preceded by a count. It includes all the original
37075 recipients of the message, including those to whom the message has already been
37076 delivered. In the simplest case, the list contains one address per line. For
37077 example:
37078 .code
37079 4
37080 editor@thesaurus.ref.example
37081 darcy@austen.fict.example
37082 rdo@foundation
37083 alice@wonderland.fict.example
37084 .endd
37085 However, when a child address has been added to the top-level addresses as a
37086 result of the use of the &%one_time%& option on a &(redirect)& router, each
37087 line is of the following form:
37088 .display
37089 <&'top-level address'&> <&'errors_to address'&> &&&
37090   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37091 .endd
37092 The 01 flag bit indicates the presence of the three other fields that follow
37093 the top-level address. Other bits may be used in future to support additional
37094 fields. The <&'parent number'&> is the offset in the recipients list of the
37095 original parent of the &"one time"& address. The first two fields are the
37096 envelope sender that is associated with this address and its length. If the
37097 length is zero, there is no special envelope sender (there are then two space
37098 characters in the line). A non-empty field can arise from a &(redirect)& router
37099 that has an &%errors_to%& setting.
37100
37101
37102 A blank line separates the envelope and status information from the headers
37103 which follow. A header may occupy several lines of the file, and to save effort
37104 when reading it in, each header is preceded by a number and an identifying
37105 character. The number is the number of characters in the header, including any
37106 embedded newlines and the terminating newline. The character is one of the
37107 following:
37108
37109 .table2 50pt
37110 .row <&'blank'&>         "header in which Exim has no special interest"
37111 .row &`B`&               "&'Bcc:'& header"
37112 .row &`C`&               "&'Cc:'& header"
37113 .row &`F`&               "&'From:'& header"
37114 .row &`I`&               "&'Message-id:'& header"
37115 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37116 .row &`R`&               "&'Reply-To:'& header"
37117 .row &`S`&               "&'Sender:'& header"
37118 .row &`T`&               "&'To:'& header"
37119 .row &`*`&               "replaced or deleted header"
37120 .endtable
37121
37122 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37123 purposes. They are not transmitted when the message is delivered. Here is a
37124 typical set of headers:
37125 .code
37126 111P Received: by hobbit.fict.example with local (Exim 4.00)
37127 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37128 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37129 038* X-rewrote-sender: bb@hobbit.fict.example
37130 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37131 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37132 099* To: alice@wonderland.fict.example, rdo@foundation,
37133 darcy@austen.fict.example, editor@thesaurus.ref.example
37134 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37135 darcy@austen.fict.example, editor@thesaurus.ref.example
37136 038  Date: Fri, 11 May 2001 10:28:59 +0100
37137 .endd
37138 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37139 &'To:'& header have been rewritten, the last one because routing expanded the
37140 unqualified domain &'foundation'&.
37141 .ecindex IIDforspo1
37142 .ecindex IIDforspo2
37143 .ecindex IIDforspo3
37144
37145 . ////////////////////////////////////////////////////////////////////////////
37146 . ////////////////////////////////////////////////////////////////////////////
37147
37148 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37149          "DKIM Support"
37150 .cindex "DKIM"
37151
37152 DKIM is a mechanism by which messages sent by some entity can be provably
37153 linked to a domain which that entity controls.  It permits reputation to
37154 be tracked on a per-domain basis, rather than merely upon source IP address.
37155 DKIM is documented in RFC 4871.
37156
37157 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37158 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37159
37160 Exim's DKIM implementation allows to
37161 .olist
37162 Sign outgoing messages: This function is implemented in the SMTP transport.
37163 It can co-exist with all other Exim features
37164 (including transport filters)
37165 except cutthrough delivery.
37166 .next
37167 Verify signatures in incoming messages: This is implemented by an additional
37168 ACL (acl_smtp_dkim), which can be called several times per message, with
37169 different signature contexts.
37170 .endlist
37171
37172 In typical Exim style, the verification implementation does not include any
37173 default "policy". Instead it enables you to build your own policy using
37174 Exim's standard controls.
37175
37176 Please note that verification of DKIM signatures in incoming mail is turned
37177 on by default for logging purposes. For each signature in incoming email,
37178 exim will log a line displaying the most important signature details, and the
37179 signature status. Here is an example (with line-breaks added for clarity):
37180 .code
37181 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37182     d=facebookmail.com s=q1-2009b
37183     c=relaxed/relaxed a=rsa-sha1
37184     i=@facebookmail.com t=1252484542 [verification succeeded]
37185 .endd
37186 You might want to turn off DKIM verification processing entirely for internal
37187 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37188 control modifier. This should typically be done in the RCPT ACL, at points
37189 where you accept mail from relay sources (internal hosts or authenticated
37190 senders).
37191
37192
37193 .section "Signing outgoing messages" "SECID513"
37194 .cindex "DKIM" "signing"
37195
37196 Signing is implemented by setting private options on the SMTP transport.
37197 These options take (expandable) strings as arguments.
37198
37199 .option dkim_domain smtp string&!! unset
37200 MANDATORY:
37201 The domain you want to sign with. The result of this expanded
37202 option is put into the &%$dkim_domain%& expansion variable.
37203
37204 .option dkim_selector smtp string&!! unset
37205 MANDATORY:
37206 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37207 variable to look up a matching selector. The result is put in the expansion
37208 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37209 option along with &%$dkim_domain%&.
37210
37211 .option dkim_private_key smtp string&!! unset
37212 MANDATORY:
37213 This sets the private key to use. You can use the &%$dkim_domain%& and
37214 &%$dkim_selector%& expansion variables to determine the private key to use.
37215 The result can either
37216 .ilist
37217 be a valid RSA private key in ASCII armor, including line breaks.
37218 .next
37219 start with a slash, in which case it is treated as a file that contains
37220 the private key.
37221 .next
37222 be "0", "false" or the empty string, in which case the message will not
37223 be signed. This case will not result in an error, even if &%dkim_strict%&
37224 is set.
37225 .endlist
37226
37227 .option dkim_canon smtp string&!! unset
37228 OPTIONAL:
37229 This option sets the canonicalization method used when signing a message.
37230 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37231 The option defaults to "relaxed" when unset. Note: the current implementation
37232 only supports using the same canonicalization method for both headers and body.
37233
37234 .option dkim_strict smtp string&!! unset
37235 OPTIONAL:
37236 This  option  defines  how  Exim  behaves  when  signing a message that
37237 should be signed fails for some reason.  When the expansion evaluates to
37238 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37239 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37240 variables here.
37241
37242 .option dkim_sign_headers smtp string&!! unset
37243 OPTIONAL:
37244 When set, this option must expand to (or be specified as) a colon-separated
37245 list of header names. Headers with these names will be included in the message
37246 signature. When unspecified, the header names recommended in RFC4871 will be
37247 used.
37248
37249
37250 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37251 .cindex "DKIM" "verification"
37252
37253 Verification of DKIM signatures in incoming email is implemented via the
37254 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37255 syntactically(!) correct signature in the incoming message.
37256 A missing ACL definition defaults to accept.
37257 If any ACL call does not acccept, the message is not accepted.
37258 If a cutthrough delivery was in progress for the message it is
37259 summarily dropped (having wasted the transmission effort).
37260
37261 To evaluate the signature in the ACL a large number of expansion variables
37262 containing the signature status and its details are set up during the
37263 runtime of the ACL.
37264
37265 Calling the ACL only for existing signatures is not sufficient to build
37266 more advanced policies. For that reason, the global option
37267 &%dkim_verify_signers%&, and a global expansion variable
37268 &%$dkim_signers%& exist.
37269
37270 The global option &%dkim_verify_signers%& can be set to a colon-separated
37271 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37272 called. It is expanded when the message has been received. At this point,
37273 the expansion variable &%$dkim_signers%& already contains a colon-separated
37274 list of signer domains and identities for the message. When
37275 &%dkim_verify_signers%& is not specified in the main configuration,
37276 it defaults as:
37277 .code
37278 dkim_verify_signers = $dkim_signers
37279 .endd
37280 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37281 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37282 call the ACL for known domains or identities. This would be achieved as follows:
37283 .code
37284 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37285 .endd
37286 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37287 and "ebay.com", plus all domains and identities that have signatures in the message.
37288 You can also be more creative in constructing your policy. For example:
37289 .code
37290 dkim_verify_signers = $sender_address_domain:$dkim_signers
37291 .endd
37292
37293 If a domain or identity is listed several times in the (expanded) value of
37294 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37295
37296
37297 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37298 available (from most to least important):
37299
37300
37301 .vlist
37302 .vitem &%$dkim_cur_signer%&
37303 The signer that is being evaluated in this ACL run. This can be a domain or
37304 an identity. This is one of the list items from the expanded main option
37305 &%dkim_verify_signers%& (see above).
37306 .vitem &%$dkim_verify_status%&
37307 A string describing the general status of the signature. One of
37308 .ilist
37309 &%none%&: There is no signature in the message for the current domain or
37310 identity (as reflected by &%$dkim_cur_signer%&).
37311 .next
37312 &%invalid%&: The signature could not be verified due to a processing error.
37313 More detail is available in &%$dkim_verify_reason%&.
37314 .next
37315 &%fail%&: Verification of the signature failed.  More detail is
37316 available in &%$dkim_verify_reason%&.
37317 .next
37318 &%pass%&: The signature passed verification. It is valid.
37319 .endlist
37320 .vitem &%$dkim_verify_reason%&
37321 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37322 "fail" or "invalid". One of
37323 .ilist
37324 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37325 key for the domain could not be retrieved. This may be a temporary problem.
37326 .next
37327 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37328 record for the domain is syntactically invalid.
37329 .next
37330 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37331 body hash does not match the one specified in the signature header. This
37332 means that the message body was modified in transit.
37333 .next
37334 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37335 could not be verified. This may mean that headers were modified,
37336 re-written or otherwise changed in a way which is incompatible with
37337 DKIM verification. It may of course also mean that the signature is forged.
37338 .endlist
37339 .vitem &%$dkim_domain%&
37340 The signing domain. IMPORTANT: This variable is only populated if there is
37341 an actual signature in the message for the current domain or identity (as
37342 reflected by &%$dkim_cur_signer%&).
37343 .vitem &%$dkim_identity%&
37344 The signing identity, if present. IMPORTANT: This variable is only populated
37345 if there is an actual signature in the message for the current domain or
37346 identity (as reflected by &%$dkim_cur_signer%&).
37347 .vitem &%$dkim_selector%&
37348 The key record selector string.
37349 .vitem &%$dkim_algo%&
37350 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37351 .vitem &%$dkim_canon_body%&
37352 The body canonicalization method. One of 'relaxed' or 'simple'.
37353 .vitem &%dkim_canon_headers%&
37354 The header canonicalization method. One of 'relaxed' or 'simple'.
37355 .vitem &%$dkim_copiedheaders%&
37356 A transcript of headers and their values which are included in the signature
37357 (copied from the 'z=' tag of the signature).
37358 .vitem &%$dkim_bodylength%&
37359 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37360 limit was set by the signer, "9999999999999" is returned. This makes sure
37361 that this variable always expands to an integer value.
37362 .vitem &%$dkim_created%&
37363 UNIX timestamp reflecting the date and time when the signature was created.
37364 When this was not specified by the signer, "0" is returned.
37365 .vitem &%$dkim_expires%&
37366 UNIX timestamp reflecting the date and time when the signer wants the
37367 signature to be treated as "expired". When this was not specified by the
37368 signer, "9999999999999" is returned. This makes it possible to do useful
37369 integer size comparisons against this value.
37370 .vitem &%$dkim_headernames%&
37371 A colon-separated list of names of headers included in the signature.
37372 .vitem &%$dkim_key_testing%&
37373 "1" if the key record has the "testing" flag set, "0" if not.
37374 .vitem &%$dkim_key_nosubdomains%&
37375 "1" if the key record forbids subdomaining, "0" otherwise.
37376 .vitem &%$dkim_key_srvtype%&
37377 Service type (tag s=) from the key record. Defaults to "*" if not specified
37378 in the key record.
37379 .vitem &%$dkim_key_granularity%&
37380 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37381 in the key record.
37382 .vitem &%$dkim_key_notes%&
37383 Notes from the key record (tag n=).
37384 .endlist
37385
37386 In addition, two ACL conditions are provided:
37387
37388 .vlist
37389 .vitem &%dkim_signers%&
37390 ACL condition that checks a colon-separated list of domains or identities
37391 for a match against the domain or identity that the ACL is currently verifying
37392 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37393 verb to a group of domains or identities. For example:
37394
37395 .code
37396 # Warn when Mail purportedly from GMail has no signature at all
37397 warn log_message = GMail sender without DKIM signature
37398      sender_domains = gmail.com
37399      dkim_signers = gmail.com
37400      dkim_status = none
37401 .endd
37402
37403 .vitem &%dkim_status%&
37404 ACL condition that checks a colon-separated list of possible DKIM verification
37405 results against the actual result of verification. This is typically used
37406 to restrict an ACL verb to a list of verification outcomes, for example:
37407
37408 .code
37409 deny message = Mail from Paypal with invalid/missing signature
37410      sender_domains = paypal.com:paypal.de
37411      dkim_signers = paypal.com:paypal.de
37412      dkim_status = none:invalid:fail
37413 .endd
37414
37415 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37416 see the documentation of the &%$dkim_verify_status%& expansion variable above
37417 for more information of what they mean.
37418 .endlist
37419
37420 . ////////////////////////////////////////////////////////////////////////////
37421 . ////////////////////////////////////////////////////////////////////////////
37422
37423 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37424          "Adding drivers or lookups"
37425 .cindex "adding drivers"
37426 .cindex "new drivers, adding"
37427 .cindex "drivers" "adding new"
37428 The following actions have to be taken in order to add a new router, transport,
37429 authenticator, or lookup type to Exim:
37430
37431 .olist
37432 Choose a name for the driver or lookup type that does not conflict with any
37433 existing name; I will use &"newdriver"& in what follows.
37434 .next
37435 Add to &_src/EDITME_& the line:
37436 .display
37437 <&'type'&>&`_NEWDRIVER=yes`&
37438 .endd
37439 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37440 code is not to be included in the binary by default, comment this line out. You
37441 should also add any relevant comments about the driver or lookup type.
37442 .next
37443 Add to &_src/config.h.defaults_& the line:
37444 .code
37445 #define <type>_NEWDRIVER
37446 .endd
37447 .next
37448 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37449 and create a table entry as is done for all the other drivers and lookup types.
37450 .next
37451 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37452 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37453 Add your &`NEWDRIVER`& to that list.
37454 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37455 simple form that most lookups have.
37456 .next
37457 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37458 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37459 driver or lookup type and add it to the definition of OBJ.
37460 .next
37461 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37462 &_src_&.
37463 .next
37464 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37465 as for other drivers and lookups.
37466 .endlist
37467
37468 Then all you need to do is write the code! A good way to start is to make a
37469 proforma by copying an existing module of the same type, globally changing all
37470 occurrences of the name, and cutting out most of the code. Note that any
37471 options you create must be listed in alphabetical order, because the tables are
37472 searched using a binary chop procedure.
37473
37474 There is a &_README_& file in each of the sub-directories of &_src_& describing
37475 the interface that is expected.
37476
37477
37478
37479
37480 . ////////////////////////////////////////////////////////////////////////////
37481 . ////////////////////////////////////////////////////////////////////////////
37482
37483 . /////////////////////////////////////////////////////////////////////////////
37484 . These lines are processing instructions for the Simple DocBook Processor that
37485 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37486 . PDFs than using xmlto and fop. They will be ignored by all other XML
37487 . processors.
37488 . /////////////////////////////////////////////////////////////////////////////
37489
37490 .literal xml
37491 <?sdop
37492   format="newpage"
37493   foot_right_recto="&chaptertitle;"
37494   foot_right_verso="&chaptertitle;"
37495 ?>
37496 .literal off
37497
37498 .makeindex "Options index"   "option"
37499 .makeindex "Variables index" "variable"
37500 .makeindex "Concept index"   "concept"
37501
37502
37503 . /////////////////////////////////////////////////////////////////////////////
37504 . /////////////////////////////////////////////////////////////////////////////