Merge branch 'master' into 4.next
[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.86"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2015
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database" "deferred deliveries"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default is set at build time). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 For a trusted user, there is never any check on the contents of the &'From:'&
2631 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2632 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2633
2634 Trusted users may also specify a host name, host address, interface address,
2635 protocol name, ident value, and authentication data when submitting a message
2636 locally. Thus, they are able to insert messages into Exim's queue locally that
2637 have the characteristics of messages received from a remote host. Untrusted
2638 users may in some circumstances use &%-f%&, but can never set the other values
2639 that are available to trusted users.
2640 .next
2641 .cindex "user" "admin definition of"
2642 .cindex "admin user" "definition of"
2643 The admin users are root, the Exim user, and any user that is a member of the
2644 Exim group or of any group listed in the &%admin_groups%& configuration option.
2645 The current group does not have to be one of these groups.
2646
2647 Admin users are permitted to list the queue, and to carry out certain
2648 operations on messages, for example, to force delivery failures. It is also
2649 necessary to be an admin user in order to see the full information provided by
2650 the Exim monitor, and full debugging output.
2651
2652 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2653 Exim to attempt delivery of messages on its queue is restricted to admin users.
2654 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2655 option false (that is, specifying &%no_prod_requires_admin%&).
2656
2657 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2658 is restricted to admin users unless &%queue_list_requires_admin%& is set
2659 false.
2660 .endlist
2661
2662
2663 &*Warning*&: If you configure your system so that admin users are able to
2664 edit Exim's configuration file, you are giving those users an easy way of
2665 getting root. There is further discussion of this issue at the start of chapter
2666 &<<CHAPconf>>&.
2667
2668
2669
2670
2671 .section "Command line options" "SECID39"
2672 Exim's command line options are described in alphabetical order below. If none
2673 of the options that specifies a specific action (such as starting the daemon or
2674 a queue runner, or testing an address, or receiving a message in a specific
2675 format, or listing the queue) are present, and there is at least one argument
2676 on the command line, &%-bm%& (accept a local message on the standard input,
2677 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2678 outputs a brief message about itself and exits.
2679
2680 . ////////////////////////////////////////////////////////////////////////////
2681 . Insert a stylized XML comment here, to identify the start of the command line
2682 . options. This is for the benefit of the Perl script that automatically
2683 . creates a man page for the options.
2684 . ////////////////////////////////////////////////////////////////////////////
2685
2686 .literal xml
2687 <!-- === Start of command line options === -->
2688 .literal off
2689
2690
2691 .vlist
2692 .vitem &%--%&
2693 .oindex "--"
2694 .cindex "options" "command line; terminating"
2695 This is a pseudo-option whose only purpose is to terminate the options and
2696 therefore to cause subsequent command line items to be treated as arguments
2697 rather than options, even if they begin with hyphens.
2698
2699 .vitem &%--help%&
2700 .oindex "&%--help%&"
2701 This option causes Exim to output a few sentences stating what it is.
2702 The same output is generated if the Exim binary is called with no options and
2703 no arguments.
2704
2705 .vitem &%--version%&
2706 .oindex "&%--version%&"
2707 This option is an alias for &%-bV%& and causes version information to be
2708 displayed.
2709
2710 .vitem &%-Ac%& &&&
2711        &%-Am%&
2712 .oindex "&%-Ac%&"
2713 .oindex "&%-Am%&"
2714 These options are used by Sendmail for selecting configuration files and are
2715 ignored by Exim.
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$sender_domain$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file,
3053 using the malware scanning framework.  The option of &%av_scanner%& influences
3054 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3055 the expansion should have defaults which apply to this invocation.  ACLs are
3056 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3057 will never be populated and &%-bmalware%& will fail.
3058
3059 Exim will have changed working directory before resolving the filename, so
3060 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3061 user when it tries to open the file, rather than as the invoking user.
3062 This option requires admin privileges.
3063
3064 The &%-bmalware%& option will not be extended to be more generally useful,
3065 there are better tools for file-scanning.  This option exists to help
3066 administrators verify their Exim and AV scanner configuration.
3067
3068 .vitem &%-bnq%&
3069 .oindex "&%-bnq%&"
3070 .cindex "address qualification, suppressing"
3071 By default, Exim automatically qualifies unqualified addresses (those
3072 without domains) that appear in messages that are submitted locally (that
3073 is, not over TCP/IP). This qualification applies both to addresses in
3074 envelopes, and addresses in header lines. Sender addresses are qualified using
3075 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3076 defaults to the value of &%qualify_domain%&).
3077
3078 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3079 being used to re-submit messages that originally came from remote hosts after
3080 content scanning, you probably do not want to qualify unqualified addresses in
3081 header lines. (Such lines will be present only if you have not enabled a header
3082 syntax check in the appropriate ACL.)
3083
3084 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3085 messages that originate on the local host. When this is used, unqualified
3086 addresses in the envelope provoke errors (causing message rejection) and
3087 unqualified addresses in header lines are left alone.
3088
3089
3090 .vitem &%-bP%&
3091 .oindex "&%-bP%&"
3092 .cindex "configuration options" "extracting"
3093 .cindex "options" "configuration &-- extracting"
3094 If this option is given with no arguments, it causes the values of all Exim's
3095 main configuration options to be written to the standard output. The values
3096 of one or more specific options can be requested by giving their names as
3097 arguments, for example:
3098 .code
3099 exim -bP qualify_domain hold_domains
3100 .endd
3101 .cindex "hiding configuration option values"
3102 .cindex "configuration options" "hiding value of"
3103 .cindex "options" "hiding value of"
3104 However, any option setting that is preceded by the word &"hide"& in the
3105 configuration file is not shown in full, except to an admin user. For other
3106 users, the output is as in this example:
3107 .code
3108 mysql_servers = <value not displayable>
3109 .endd
3110 If &%config%& is given as an argument, the config is
3111 output, as it was parsed, any include file resolved, any comment removed.
3112
3113 If &%config_file%& is given as an argument, the name of the run time
3114 configuration file is output. (&%configure_file%& works too, for
3115 backward compatibility.)
3116 If a list of configuration files was supplied, the value that is output here
3117 is the name of the file that was actually used.
3118
3119 .cindex "options" "hiding name of"
3120 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3121 name will not be output.
3122
3123 .cindex "daemon" "process id (pid)"
3124 .cindex "pid (process id)" "of daemon"
3125 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3126 directories where log files and daemon pid files are written are output,
3127 respectively. If these values are unset, log files are written in a
3128 sub-directory of the spool directory called &%log%&, and the pid file is
3129 written directly into the spool directory.
3130
3131 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3132 .code
3133 exim -bP +local_domains
3134 .endd
3135 it searches for a matching named list of any type (domain, host, address, or
3136 local part) and outputs what it finds.
3137
3138 .cindex "options" "router &-- extracting"
3139 .cindex "options" "transport &-- extracting"
3140 .cindex "options" "authenticator &-- extracting"
3141 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3142 followed by the name of an appropriate driver instance, the option settings for
3143 that driver are output. For example:
3144 .code
3145 exim -bP transport local_delivery
3146 .endd
3147 The generic driver options are output first, followed by the driver's private
3148 options. A list of the names of drivers of a particular type can be obtained by
3149 using one of the words &%router_list%&, &%transport_list%&, or
3150 &%authenticator_list%&, and a complete list of all drivers with their option
3151 settings can be obtained by using &%routers%&, &%transports%&, or
3152 &%authenticators%&.
3153
3154 .cindex "options" "macro &-- extracting"
3155 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3156 are available, similarly to the drivers.  Because macros are sometimes used
3157 for storing passwords, this option is restricted.
3158 The output format is one item per line.
3159
3160 .vitem &%-bp%&
3161 .oindex "&%-bp%&"
3162 .cindex "queue" "listing messages on"
3163 .cindex "listing" "messages on the queue"
3164 This option requests a listing of the contents of the mail queue on the
3165 standard output. If the &%-bp%& option is followed by a list of message ids,
3166 just those messages are listed. By default, this option can be used only by an
3167 admin user. However, the &%queue_list_requires_admin%& option can be set false
3168 to allow any user to see the queue.
3169
3170 Each message on the queue is displayed as in the following example:
3171 .code
3172 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3173           red.king@looking-glass.fict.example
3174           <other addresses>
3175 .endd
3176 .cindex "message" "size in queue listing"
3177 .cindex "size" "of message"
3178 The first line contains the length of time the message has been on the queue
3179 (in this case 25 minutes), the size of the message (2.9K), the unique local
3180 identifier for the message, and the message sender, as contained in the
3181 envelope. For bounce messages, the sender address is empty, and appears as
3182 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3183 the default sender address, the user's login name is shown in parentheses
3184 before the sender address.
3185
3186 .cindex "frozen messages" "in queue listing"
3187 If the message is frozen (attempts to deliver it are suspended) then the text
3188 &"*** frozen ***"& is displayed at the end of this line.
3189
3190 The recipients of the message (taken from the envelope, not the headers) are
3191 displayed on subsequent lines. Those addresses to which the message has already
3192 been delivered are marked with the letter D. If an original address gets
3193 expanded into several addresses via an alias or forward file, the original is
3194 displayed with a D only when deliveries for all of its child addresses are
3195 complete.
3196
3197
3198 .vitem &%-bpa%&
3199 .oindex "&%-bpa%&"
3200 This option operates like &%-bp%&, but in addition it shows delivered addresses
3201 that were generated from the original top level address(es) in each message by
3202 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3203 of just &"D"&.
3204
3205
3206 .vitem &%-bpc%&
3207 .oindex "&%-bpc%&"
3208 .cindex "queue" "count of messages on"
3209 This option counts the number of messages on the queue, and writes the total
3210 to the standard output. It is restricted to admin users, unless
3211 &%queue_list_requires_admin%& is set false.
3212
3213
3214 .vitem &%-bpr%&
3215 .oindex "&%-bpr%&"
3216 This option operates like &%-bp%&, but the output is not sorted into
3217 chronological order of message arrival. This can speed it up when there are
3218 lots of messages on the queue, and is particularly useful if the output is
3219 going to be post-processed in a way that doesn't need the sorting.
3220
3221 .vitem &%-bpra%&
3222 .oindex "&%-bpra%&"
3223 This option is a combination of &%-bpr%& and &%-bpa%&.
3224
3225 .vitem &%-bpru%&
3226 .oindex "&%-bpru%&"
3227 This option is a combination of &%-bpr%& and &%-bpu%&.
3228
3229
3230 .vitem &%-bpu%&
3231 .oindex "&%-bpu%&"
3232 This option operates like &%-bp%& but shows only undelivered top-level
3233 addresses for each message displayed. Addresses generated by aliasing or
3234 forwarding are not shown, unless the message was deferred after processing by a
3235 router with the &%one_time%& option set.
3236
3237
3238 .vitem &%-brt%&
3239 .oindex "&%-brt%&"
3240 .cindex "testing" "retry configuration"
3241 .cindex "retry" "configuration testing"
3242 This option is for testing retry rules, and it must be followed by up to three
3243 arguments. It causes Exim to look for a retry rule that matches the values
3244 and to write it to the standard output. For example:
3245 .code
3246 exim -brt bach.comp.mus.example
3247 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3248 .endd
3249 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3250 argument, which is required, can be a complete address in the form
3251 &'local_part@domain'&, or it can be just a domain name. If the second argument
3252 contains a dot, it is interpreted as an optional second domain name; if no
3253 retry rule is found for the first argument, the second is tried. This ties in
3254 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3255 rule is found that matches the host, one that matches the mail domain is
3256 sought. Finally, an argument that is the name of a specific delivery error, as
3257 used in setting up retry rules, can be given. For example:
3258 .code
3259 exim -brt haydn.comp.mus.example quota_3d
3260 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3261 .endd
3262
3263 .vitem &%-brw%&
3264 .oindex "&%-brw%&"
3265 .cindex "testing" "rewriting"
3266 .cindex "rewriting" "testing"
3267 This option is for testing address rewriting rules, and it must be followed by
3268 a single argument, consisting of either a local part without a domain, or a
3269 complete address with a fully qualified domain. Exim outputs how this address
3270 would be rewritten for each possible place it might appear. See chapter
3271 &<<CHAPrewrite>>& for further details.
3272
3273 .vitem &%-bS%&
3274 .oindex "&%-bS%&"
3275 .cindex "SMTP" "batched incoming"
3276 .cindex "batched SMTP input"
3277 This option is used for batched SMTP input, which is an alternative interface
3278 for non-interactive local message submission. A number of messages can be
3279 submitted in a single run. However, despite its name, this is not really SMTP
3280 input. Exim reads each message's envelope from SMTP commands on the standard
3281 input, but generates no responses. If the caller is trusted, or
3282 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3283 believed; otherwise the sender is always the caller of Exim.
3284
3285 The message itself is read from the standard input, in SMTP format (leading
3286 dots doubled), terminated by a line containing just a single dot. An error is
3287 provoked if the terminating dot is missing. A further message may then follow.
3288
3289 As for other local message submissions, the contents of incoming batch SMTP
3290 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3291 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3292 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3293
3294 Some other SMTP commands are recognized in the input. HELO and EHLO act
3295 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3296 QUIT quits, ignoring the rest of the standard input.
3297
3298 .cindex "return code" "for &%-bS%&"
3299 If any error is encountered, reports are written to the standard output and
3300 error streams, and Exim gives up immediately. The return code is 0 if no error
3301 was detected; it is 1 if one or more messages were accepted before the error
3302 was detected; otherwise it is 2.
3303
3304 More details of input using batched SMTP are given in section
3305 &<<SECTincomingbatchedSMTP>>&.
3306
3307 .vitem &%-bs%&
3308 .oindex "&%-bs%&"
3309 .cindex "SMTP" "local input"
3310 .cindex "local SMTP input"
3311 This option causes Exim to accept one or more messages by reading SMTP commands
3312 on the standard input, and producing SMTP replies on the standard output. SMTP
3313 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3314 Some user agents use this interface as a way of passing locally-generated
3315 messages to the MTA.
3316
3317 In
3318 .cindex "sender" "source of"
3319 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3320 set, the senders of messages are taken from the SMTP MAIL commands.
3321 Otherwise the content of these commands is ignored and the sender is set up as
3322 the calling user. Unqualified addresses are automatically qualified using
3323 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3324 &%-bnq%& option is used.
3325
3326 .cindex "inetd"
3327 The
3328 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3329 using a listening daemon. Exim can distinguish the two cases by checking
3330 whether the standard input is a TCP/IP socket. When Exim is called from
3331 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3332 above concerning senders and qualification do not apply. In this situation,
3333 Exim behaves in exactly the same way as it does when receiving a message via
3334 the listening daemon.
3335
3336 .vitem &%-bt%&
3337 .oindex "&%-bt%&"
3338 .cindex "testing" "addresses"
3339 .cindex "address" "testing"
3340 This option runs Exim in address testing mode, in which each argument is taken
3341 as a recipient address to be tested for deliverability. The results are
3342 written to the standard output. If a test fails, and the caller is not an admin
3343 user, no details of the failure are output, because these might contain
3344 sensitive information such as usernames and passwords for database lookups.
3345
3346 If no arguments are given, Exim runs in an interactive manner, prompting with a
3347 right angle bracket for addresses to be tested.
3348
3349 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3350 &[readline()]& function, because it is running as &'root'& and there are
3351 security issues.
3352
3353 Each address is handled as if it were the recipient address of a message
3354 (compare the &%-bv%& option). It is passed to the routers and the result is
3355 written to the standard output. However, any router that has
3356 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3357 genuine routing tests if your first router passes everything to a scanner
3358 program.
3359
3360 .cindex "return code" "for &%-bt%&"
3361 The return code is 2 if any address failed outright; it is 1 if no address
3362 failed outright but at least one could not be resolved for some reason. Return
3363 code 0 is given only when all addresses succeed.
3364
3365 .cindex "duplicate addresses"
3366 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3367 addresses after routing is complete, so that only one delivery takes place.
3368 This does not happen when testing with &%-bt%&; the full results of routing are
3369 always shown.
3370
3371 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3372 routers in the configuration makes any tests on the sender address of a
3373 message,
3374 .oindex "&%-f%&" "for address testing"
3375 you can use the &%-f%& option to set an appropriate sender when running
3376 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3377 default qualifying domain. However, if you have set up (for example) routers
3378 whose behaviour depends on the contents of an incoming message, you cannot test
3379 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3380 doing such tests.
3381
3382 .vitem &%-bV%&
3383 .oindex "&%-bV%&"
3384 .cindex "version number of Exim"
3385 This option causes Exim to write the current version number, compilation
3386 number, and compilation date of the &'exim'& binary to the standard output.
3387 It also lists the DBM library that is being used, the optional modules (such as
3388 specific lookup types), the drivers that are included in the binary, and the
3389 name of the run time configuration file that is in use.
3390
3391 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3392 configuration file. However, this is a static check only. It cannot check
3393 values that are to be expanded. For example, although a misspelt ACL verb is
3394 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3395 alone to discover (for example) all the typos in the configuration; some
3396 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3397 dynamic testing facilities.
3398
3399 .vitem &%-bv%&
3400 .oindex "&%-bv%&"
3401 .cindex "verifying address" "using &%-bv%&"
3402 .cindex "address" "verification"
3403 This option runs Exim in address verification mode, in which each argument is
3404 taken as a recipient address to be verified by the routers. (This does
3405 not involve any verification callouts). During normal operation, verification
3406 happens mostly as a consequence processing a &%verify%& condition in an ACL
3407 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3408 including callouts, see the &%-bh%& and &%-bhc%& options.
3409
3410 If verification fails, and the caller is not an admin user, no details of the
3411 failure are output, because these might contain sensitive information such as
3412 usernames and passwords for database lookups.
3413
3414 If no arguments are given, Exim runs in an interactive manner, prompting with a
3415 right angle bracket for addresses to be verified.
3416
3417 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3418 &[readline()]& function, because it is running as &'exim'& and there are
3419 security issues.
3420
3421 Verification differs from address testing (the &%-bt%& option) in that routers
3422 that have &%no_verify%& set are skipped, and if the address is accepted by a
3423 router that has &%fail_verify%& set, verification fails. The address is
3424 verified as a recipient if &%-bv%& is used; to test verification for a sender
3425 address, &%-bvs%& should be used.
3426
3427 If the &%-v%& option is not set, the output consists of a single line for each
3428 address, stating whether it was verified or not, and giving a reason in the
3429 latter case. Without &%-v%&, generating more than one address by redirection
3430 causes verification to end successfully, without considering the generated
3431 addresses. However, if just one address is generated, processing continues,
3432 and the generated address must verify successfully for the overall verification
3433 to succeed.
3434
3435 When &%-v%& is set, more details are given of how the address has been handled,
3436 and in the case of address redirection, all the generated addresses are also
3437 considered. Verification may succeed for some and fail for others.
3438
3439 The
3440 .cindex "return code" "for &%-bv%&"
3441 return code is 2 if any address failed outright; it is 1 if no address
3442 failed outright but at least one could not be resolved for some reason. Return
3443 code 0 is given only when all addresses succeed.
3444
3445 If any of the routers in the configuration makes any tests on the sender
3446 address of a message, you should use the &%-f%& option to set an appropriate
3447 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3448 calling user at the default qualifying domain.
3449
3450 .vitem &%-bvs%&
3451 .oindex "&%-bvs%&"
3452 This option acts like &%-bv%&, but verifies the address as a sender rather
3453 than a recipient address. This affects any rewriting and qualification that
3454 might happen.
3455
3456 .vitem &%-bw%&
3457 .oindex "&%-bw%&"
3458 .cindex "daemon"
3459 .cindex "inetd"
3460 .cindex "inetd" "wait mode"
3461 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3462 similarly to the &%-bd%& option.  All port specifications on the command-line
3463 and in the configuration file are ignored.  Queue-running may not be specified.
3464
3465 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3466 listening for connections.  This permits the system to start up and have
3467 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3468 each port only when the first connection is received.
3469
3470 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3471 which the daemon will exit, which should cause inetd to listen once more.
3472
3473 .vitem &%-C%&&~<&'filelist'&>
3474 .oindex "&%-C%&"
3475 .cindex "configuration file" "alternate"
3476 .cindex "CONFIGURE_FILE"
3477 .cindex "alternate configuration file"
3478 This option causes Exim to find the run time configuration file from the given
3479 list instead of from the list specified by the CONFIGURE_FILE
3480 compile-time setting. Usually, the list will consist of just a single file
3481 name, but it can be a colon-separated list of names. In this case, the first
3482 file that exists is used. Failure to open an existing file stops Exim from
3483 proceeding any further along the list, and an error is generated.
3484
3485 When this option is used by a caller other than root, and the list is different
3486 from the compiled-in list, Exim gives up its root privilege immediately, and
3487 runs with the real and effective uid and gid set to those of the caller.
3488 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3489 file contains a list of full pathnames, one per line, for configuration files
3490 which are trusted. Root privilege is retained for any configuration file so
3491 listed, as long as the caller is the Exim user (or the user specified in the
3492 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3493 not writeable by inappropriate users or groups.
3494
3495 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3496 configuration using &%-C%& right through message reception and delivery,
3497 even if the caller is root. The reception works, but by that time, Exim is
3498 running as the Exim user, so when it re-executes to regain privilege for the
3499 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3500 test reception and delivery using two separate commands (one to put a message
3501 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3502
3503 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3504 prefix string with which any file named in a &%-C%& command line option
3505 must start. In addition, the file name must not contain the sequence &`/../`&.
3506 However, if the value of the &%-C%& option is identical to the value of
3507 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3508 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3509 unset, any file name can be used with &%-C%&.
3510
3511 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3512 to a directory to which only root has access. This prevents someone who has
3513 broken into the Exim account from running a privileged Exim with an arbitrary
3514 configuration file.
3515
3516 The &%-C%& facility is useful for ensuring that configuration files are
3517 syntactically correct, but cannot be used for test deliveries, unless the
3518 caller is privileged, or unless it is an exotic configuration that does not
3519 require privilege. No check is made on the owner or group of the files
3520 specified by this option.
3521
3522
3523 .vitem &%-D%&<&'macro'&>=<&'value'&>
3524 .oindex "&%-D%&"
3525 .cindex "macro" "setting on command line"
3526 This option can be used to override macro definitions in the configuration file
3527 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3528 unprivileged caller, it causes Exim to give up its root privilege.
3529 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3530 completely disabled, and its use causes an immediate error exit.
3531
3532 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3533 colon-separated list of macros which are considered safe and, if &%-D%& only
3534 supplies macros from this list, and the values are acceptable, then Exim will
3535 not give up root privilege if the caller is root, the Exim run-time user, or
3536 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3537 to be removed in the future.  Acceptable values for the macros satisfy the
3538 regexp: &`^[A-Za-z0-9_/.-]*$`&
3539
3540 The entire option (including equals sign if present) must all be within one
3541 command line item. &%-D%& can be used to set the value of a macro to the empty
3542 string, in which case the equals sign is optional. These two commands are
3543 synonymous:
3544 .code
3545 exim -DABC  ...
3546 exim -DABC= ...
3547 .endd
3548 To include spaces in a macro definition item, quotes must be used. If you use
3549 quotes, spaces are permitted around the macro name and the equals sign. For
3550 example:
3551 .code
3552 exim '-D ABC = something' ...
3553 .endd
3554 &%-D%& may be repeated up to 10 times on a command line.
3555 .new
3556 Only macro names up to 22 letters long can be set.
3557 .wen
3558
3559
3560 .vitem &%-d%&<&'debug&~options'&>
3561 .oindex "&%-d%&"
3562 .cindex "debugging" "list of selectors"
3563 .cindex "debugging" "&%-d%& option"
3564 This option causes debugging information to be written to the standard
3565 error stream. It is restricted to admin users because debugging output may show
3566 database queries that contain password information. Also, the details of users'
3567 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3568 writes an error message to the standard error stream and exits with a non-zero
3569 return code.
3570
3571 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3572 standard debugging data is output. This can be reduced, or increased to include
3573 some more rarely needed information, by directly following &%-d%& with a string
3574 made up of names preceded by plus or minus characters. These add or remove sets
3575 of debugging data, respectively. For example, &%-d+filter%& adds filter
3576 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3577 no spaces are allowed in the debug setting. The available debugging categories
3578 are:
3579 .display
3580 &`acl            `& ACL interpretation
3581 &`auth           `& authenticators
3582 &`deliver        `& general delivery logic
3583 &`dns            `& DNS lookups (see also resolver)
3584 &`dnsbl          `& DNS black list (aka RBL) code
3585 &`exec           `& arguments for &[execv()]& calls
3586 &`expand         `& detailed debugging for string expansions
3587 &`filter         `& filter handling
3588 &`hints_lookup   `& hints data lookups
3589 &`host_lookup    `& all types of name-to-IP address handling
3590 &`ident          `& ident lookup
3591 &`interface      `& lists of local interfaces
3592 &`lists          `& matching things in lists
3593 &`load           `& system load checks
3594 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3595                     &<<CHAPlocalscan>>&)
3596 &`lookup         `& general lookup code and all lookups
3597 &`memory         `& memory handling
3598 &`pid            `& add pid to debug output lines
3599 &`process_info   `& setting info for the process log
3600 &`queue_run      `& queue runs
3601 &`receive        `& general message reception logic
3602 &`resolver       `& turn on the DNS resolver's debugging output
3603 &`retry          `& retry handling
3604 &`rewrite        `& address rewriting
3605 &`route          `& address routing
3606 &`timestamp      `& add timestamp to debug output lines
3607 &`tls            `& TLS logic
3608 &`transport      `& transports
3609 &`uid            `& changes of uid/gid and looking up uid/gid
3610 &`verify         `& address verification logic
3611 &`all            `& almost all of the above (see below), and also &%-v%&
3612 .endd
3613 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3614 for &`-all`&. The reason for this is that &`+all`& is something that people
3615 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3616 is included, an awful lot of output that is very rarely of interest is
3617 generated, so it now has to be explicitly requested. However, &`-all`& does
3618 turn everything off.
3619
3620 .cindex "resolver, debugging output"
3621 .cindex "DNS resolver, debugging output"
3622 The &`resolver`& option produces output only if the DNS resolver was compiled
3623 with DEBUG enabled. This is not the case in some operating systems. Also,
3624 unfortunately, debugging output from the DNS resolver is written to stdout
3625 rather than stderr.
3626
3627 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3628 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3629 However, the &`pid`& selector is forced when debugging is turned on for a
3630 daemon, which then passes it on to any re-executed Exims. Exim also
3631 automatically adds the pid to debug lines when several remote deliveries are
3632 run in parallel.
3633
3634 The &`timestamp`& selector causes the current time to be inserted at the start
3635 of all debug output lines. This can be useful when trying to track down delays
3636 in processing.
3637
3638 If the &%debug_print%& option is set in any driver, it produces output whenever
3639 any debugging is selected, or if &%-v%& is used.
3640
3641 .vitem &%-dd%&<&'debug&~options'&>
3642 .oindex "&%-dd%&"
3643 This option behaves exactly like &%-d%& except when used on a command that
3644 starts a daemon process. In that case, debugging is turned off for the
3645 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3646 behaviour of the daemon without creating as much output as full debugging does.
3647
3648 .vitem &%-dropcr%&
3649 .oindex "&%-dropcr%&"
3650 This is an obsolete option that is now a no-op. It used to affect the way Exim
3651 handled CR and LF characters in incoming messages. What happens now is
3652 described in section &<<SECTlineendings>>&.
3653
3654 .vitem &%-E%&
3655 .oindex "&%-E%&"
3656 .cindex "bounce message" "generating"
3657 This option specifies that an incoming message is a locally-generated delivery
3658 failure report. It is used internally by Exim when handling delivery failures
3659 and is not intended for external use. Its only effect is to stop Exim
3660 generating certain messages to the postmaster, as otherwise message cascades
3661 could occur in some situations. As part of the same option, a message id may
3662 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3663 new message contains the id, following &"R="&, as a cross-reference.
3664
3665 .vitem &%-e%&&'x'&
3666 .oindex "&%-e%&&'x'&"
3667 There are a number of Sendmail options starting with &%-oe%& which seem to be
3668 called by various programs without the leading &%o%& in the option. For
3669 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3670 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3671
3672 .vitem &%-F%&&~<&'string'&>
3673 .oindex "&%-F%&"
3674 .cindex "sender" "name"
3675 .cindex "name" "of sender"
3676 This option sets the sender's full name for use when a locally-generated
3677 message is being accepted. In the absence of this option, the user's &'gecos'&
3678 entry from the password data is used. As users are generally permitted to alter
3679 their &'gecos'& entries, no security considerations are involved. White space
3680 between &%-F%& and the <&'string'&> is optional.
3681
3682 .vitem &%-f%&&~<&'address'&>
3683 .oindex "&%-f%&"
3684 .cindex "sender" "address"
3685 .cindex "address" "sender"
3686 .cindex "trusted users"
3687 .cindex "envelope sender"
3688 .cindex "user" "trusted"
3689 This option sets the address of the envelope sender of a locally-generated
3690 message (also known as the return path). The option can normally be used only
3691 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3692 users to use it.
3693
3694 Processes running as root or the Exim user are always trusted. Other
3695 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3696 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3697 of a local message is set to the caller's login name at the default qualify
3698 domain.
3699
3700 There is one exception to the restriction on the use of &%-f%&: an empty sender
3701 can be specified by any user, trusted or not, to create a message that can
3702 never provoke a bounce. An empty sender can be specified either as an empty
3703 string, or as a pair of angle brackets with nothing between them, as in these
3704 examples of shell commands:
3705 .code
3706 exim -f '<>' user@domain
3707 exim -f "" user@domain
3708 .endd
3709 In addition, the use of &%-f%& is not restricted when testing a filter file
3710 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3711 &%-bv%& options.
3712
3713 Allowing untrusted users to change the sender address does not of itself make
3714 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3715 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3716 though this can be overridden by setting &%no_local_from_check%&.
3717
3718 White
3719 .cindex "&""From""& line"
3720 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3721 given as two arguments or one combined argument). The sender of a
3722 locally-generated message can also be set (when permitted) by an initial
3723 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3724 if &%-f%& is also present, it overrides &"From&~"&.
3725
3726 .vitem &%-G%&
3727 .oindex "&%-G%&"
3728 .cindex "submission fixups, suppressing (command-line)"
3729 This option is equivalent to an ACL applying:
3730 .code
3731 control = suppress_local_fixups
3732 .endd
3733 for every message received.  Note that Sendmail will complain about such
3734 bad formatting, where Exim silently just does not fix it up.  This may change
3735 in future.
3736
3737 As this affects audit information, the caller must be a trusted user to use
3738 this option.
3739
3740 .vitem &%-h%&&~<&'number'&>
3741 .oindex "&%-h%&"
3742 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3743 This option is accepted for compatibility with Sendmail, but has no effect. (In
3744 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3745 headers.)
3746
3747 .vitem &%-i%&
3748 .oindex "&%-i%&"
3749 .cindex "Solaris" "&'mail'& command"
3750 .cindex "dot" "in incoming non-SMTP message"
3751 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3752 line by itself should not terminate an incoming, non-SMTP message. I can find
3753 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3754 command in Solaris 2.4 uses it. See also &%-ti%&.
3755
3756 .vitem &%-L%&&~<&'tag'&>
3757 .oindex "&%-L%&"
3758 .cindex "syslog" "process name; set with flag"
3759 This option is equivalent to setting &%syslog_processname%& in the config
3760 file and setting &%log_file_path%& to &`syslog`&.
3761 Its use is restricted to administrators.  The configuration file has to be
3762 read and parsed, to determine access rights, before this is set and takes
3763 effect, so early configuration file errors will not honour this flag.
3764
3765 The tag should not be longer than 32 characters.
3766
3767 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3768 .oindex "&%-M%&"
3769 .cindex "forcing delivery"
3770 .cindex "delivery" "forcing attempt"
3771 .cindex "frozen messages" "forcing delivery"
3772 This option requests Exim to run a delivery attempt on each message in turn. If
3773 any of the messages are frozen, they are automatically thawed before the
3774 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3775 and &%hold_domains%& are ignored.
3776
3777 Retry
3778 .cindex "hints database" "overriding retry hints"
3779 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3780 the normal retry time has not yet been reached. This option requires the caller
3781 to be an admin user. However, there is an option called &%prod_requires_admin%&
3782 which can be set false to relax this restriction (and also the same requirement
3783 for the &%-q%&, &%-R%&, and &%-S%& options).
3784
3785 The deliveries happen synchronously, that is, the original Exim process does
3786 not terminate until all the delivery attempts have finished. No output is
3787 produced unless there is a serious error. If you want to see what is happening,
3788 use the &%-v%& option as well, or inspect Exim's main log.
3789
3790 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3791 .oindex "&%-Mar%&"
3792 .cindex "message" "adding recipients"
3793 .cindex "recipient" "adding"
3794 This option requests Exim to add the addresses to the list of recipients of the
3795 message (&"ar"& for &"add recipients"&). The first argument must be a message
3796 id, and the remaining ones must be email addresses. However, if the message is
3797 active (in the middle of a delivery attempt), it is not altered. This option
3798 can be used only by an admin user.
3799
3800 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3801         &~<&'message&~id'&>"
3802 .oindex "&%-MC%&"
3803 .cindex "SMTP" "passed connection"
3804 .cindex "SMTP" "multiple deliveries"
3805 .cindex "multiple SMTP deliveries"
3806 This option is not intended for use by external callers. It is used internally
3807 by Exim to invoke another instance of itself to deliver a waiting message using
3808 an existing SMTP connection, which is passed as the standard input. Details are
3809 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3810 must be root or the Exim user in order to use it.
3811
3812 .vitem &%-MCA%&
3813 .oindex "&%-MCA%&"
3814 This option is not intended for use by external callers. It is used internally
3815 by Exim in conjunction with the &%-MC%& option. It signifies that the
3816 connection to the remote host has been authenticated.
3817
3818 .vitem &%-MCD%&
3819 .oindex "&%-MCD%&"
3820 This option is not intended for use by external callers. It is used internally
3821 by Exim in conjunction with the &%-MC%& option. It signifies that the
3822 remote host supports the ESMTP &_DSN_& extension.
3823
3824 .vitem &%-MCP%&
3825 .oindex "&%-MCP%&"
3826 This option is not intended for use by external callers. It is used internally
3827 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3828 which Exim is connected supports pipelining.
3829
3830 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3831 .oindex "&%-MCQ%&"
3832 This option is not intended for use by external callers. It is used internally
3833 by Exim in conjunction with the &%-MC%& option when the original delivery was
3834 started by a queue runner. It passes on the process id of the queue runner,
3835 together with the file descriptor number of an open pipe. Closure of the pipe
3836 signals the final completion of the sequence of processes that are passing
3837 messages through the same SMTP connection.
3838
3839 .vitem &%-MCS%&
3840 .oindex "&%-MCS%&"
3841 This option is not intended for use by external callers. It is used internally
3842 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3843 SMTP SIZE option should be used on messages delivered down the existing
3844 connection.
3845
3846 .vitem &%-MCT%&
3847 .oindex "&%-MCT%&"
3848 This option is not intended for use by external callers. It is used internally
3849 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3850 host to which Exim is connected supports TLS encryption.
3851
3852 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3853 .oindex "&%-Mc%&"
3854 .cindex "hints database" "not overridden by &%-Mc%&"
3855 .cindex "delivery" "manually started &-- not forced"
3856 This option requests Exim to run a delivery attempt on each message in turn,
3857 but unlike the &%-M%& option, it does check for retry hints, and respects any
3858 that are found. This option is not very useful to external callers. It is
3859 provided mainly for internal use by Exim when it needs to re-invoke itself in
3860 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3861 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3862 respects retry times and other options such as &%hold_domains%& that are
3863 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3864 If you want to run a specific delivery as if in a queue run, you should use
3865 &%-q%& with a message id argument. A distinction between queue run deliveries
3866 and other deliveries is made in one or two places.
3867
3868 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3869 .oindex "&%-Mes%&"
3870 .cindex "message" "changing sender"
3871 .cindex "sender" "changing"
3872 This option requests Exim to change the sender address in the message to the
3873 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3874 &"edit sender"&). There must be exactly two arguments. The first argument must
3875 be a message id, and the second one an email address. However, if the message
3876 is active (in the middle of a delivery attempt), its status is not altered.
3877 This option can be used only by an admin user.
3878
3879 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3880 .oindex "&%-Mf%&"
3881 .cindex "freezing messages"
3882 .cindex "message" "manually freezing"
3883 This option requests Exim to mark each listed message as &"frozen"&. This
3884 prevents any delivery attempts taking place until the message is &"thawed"&,
3885 either manually or as a result of the &%auto_thaw%& configuration option.
3886 However, if any of the messages are active (in the middle of a delivery
3887 attempt), their status is not altered. This option can be used only by an admin
3888 user.
3889
3890 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3891 .oindex "&%-Mg%&"
3892 .cindex "giving up on messages"
3893 .cindex "message" "abandoning delivery attempts"
3894 .cindex "delivery" "abandoning further attempts"
3895 This option requests Exim to give up trying to deliver the listed messages,
3896 including any that are frozen. However, if any of the messages are active,
3897 their status is not altered. For non-bounce messages, a delivery error message
3898 is sent to the sender, containing the text &"cancelled by administrator"&.
3899 Bounce messages are just discarded. This option can be used only by an admin
3900 user.
3901
3902 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3903 .oindex "&%-Mmad%&"
3904 .cindex "delivery" "cancelling all"
3905 This option requests Exim to mark all the recipient addresses in the messages
3906 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3907 message is active (in the middle of a delivery attempt), its status is not
3908 altered. This option can be used only by an admin user.
3909
3910 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3911 .oindex "&%-Mmd%&"
3912 .cindex "delivery" "cancelling by address"
3913 .cindex "recipient" "removing"
3914 .cindex "removing recipients"
3915 This option requests Exim to mark the given addresses as already delivered
3916 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3917 the remaining ones must be email addresses. These are matched to recipient
3918 addresses in the message in a case-sensitive manner. If the message is active
3919 (in the middle of a delivery attempt), its status is not altered. This option
3920 can be used only by an admin user.
3921
3922 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3923 .oindex "&%-Mrm%&"
3924 .cindex "removing messages"
3925 .cindex "abandoning mail"
3926 .cindex "message" "manually discarding"
3927 This option requests Exim to remove the given messages from the queue. No
3928 bounce messages are sent; each message is simply forgotten. However, if any of
3929 the messages are active, their status is not altered. This option can be used
3930 only by an admin user or by the user who originally caused the message to be
3931 placed on the queue.
3932
3933 .vitem &%-Mset%&&~<&'message&~id'&>
3934 .oindex "&%-Mset%&
3935 .cindex "testing" "string expansion"
3936 .cindex "expansion" "testing"
3937 This option is useful only in conjunction with &%-be%& (that is, when testing
3938 string expansions). Exim loads the given message from its spool before doing
3939 the test expansions, thus setting message-specific variables such as
3940 &$message_size$& and the header variables. The &$recipients$& variable is made
3941 available. This feature is provided to make it easier to test expansions that
3942 make use of these variables. However, this option can be used only by an admin
3943 user. See also &%-bem%&.
3944
3945 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3946 .oindex "&%-Mt%&"
3947 .cindex "thawing messages"
3948 .cindex "unfreezing messages"
3949 .cindex "frozen messages" "thawing"
3950 .cindex "message" "thawing frozen"
3951 This option requests Exim to &"thaw"& any of the listed messages that are
3952 &"frozen"&, so that delivery attempts can resume. However, if any of the
3953 messages are active, their status is not altered. This option can be used only
3954 by an admin user.
3955
3956 .vitem &%-Mvb%&&~<&'message&~id'&>
3957 .oindex "&%-Mvb%&"
3958 .cindex "listing" "message body"
3959 .cindex "message" "listing body of"
3960 This option causes the contents of the message body (-D) spool file to be
3961 written to the standard output. This option can be used only by an admin user.
3962
3963 .vitem &%-Mvc%&&~<&'message&~id'&>
3964 .oindex "&%-Mvc%&"
3965 .cindex "message" "listing in RFC 2822 format"
3966 .cindex "listing" "message in RFC 2822 format"
3967 This option causes a copy of the complete message (header lines plus body) to
3968 be written to the standard output in RFC 2822 format. This option can be used
3969 only by an admin user.
3970
3971 .vitem &%-Mvh%&&~<&'message&~id'&>
3972 .oindex "&%-Mvh%&"
3973 .cindex "listing" "message headers"
3974 .cindex "header lines" "listing"
3975 .cindex "message" "listing header lines"
3976 This option causes the contents of the message headers (-H) spool file to be
3977 written to the standard output. This option can be used only by an admin user.
3978
3979 .vitem &%-Mvl%&&~<&'message&~id'&>
3980 .oindex "&%-Mvl%&"
3981 .cindex "listing" "message log"
3982 .cindex "message" "listing message log"
3983 This option causes the contents of the message log spool file to be written to
3984 the standard output. This option can be used only by an admin user.
3985
3986 .vitem &%-m%&
3987 .oindex "&%-m%&"
3988 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3989 treats it that way too.
3990
3991 .vitem &%-N%&
3992 .oindex "&%-N%&"
3993 .cindex "debugging" "&%-N%& option"
3994 .cindex "debugging" "suppressing delivery"
3995 This is a debugging option that inhibits delivery of a message at the transport
3996 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3997 it just doesn't actually transport the message, but instead behaves as if it
3998 had successfully done so. However, it does not make any updates to the retry
3999 database, and the log entries for deliveries are flagged with &"*>"& rather
4000 than &"=>"&.
4001
4002 Because &%-N%& discards any message to which it applies, only root or the Exim
4003 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4004 words, an ordinary user can use it only when supplying an incoming message to
4005 which it will apply. Although transportation never fails when &%-N%& is set, an
4006 address may be deferred because of a configuration problem on a transport, or a
4007 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4008 the message, and applies to any subsequent delivery attempts that may happen
4009 for that message.
4010
4011 .vitem &%-n%&
4012 .oindex "&%-n%&"
4013 This option is interpreted by Sendmail to mean &"no aliasing"&.
4014 For normal modes of operation, it is ignored by Exim.
4015 When combined with &%-bP%& it suppresses the name of an option from being output.
4016
4017 .vitem &%-O%&&~<&'data'&>
4018 .oindex "&%-O%&"
4019 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4020 Exim.
4021
4022 .vitem &%-oA%&&~<&'file&~name'&>
4023 .oindex "&%-oA%&"
4024 .cindex "Sendmail compatibility" "&%-oA%& option"
4025 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4026 alternative alias file name. Exim handles &%-bi%& differently; see the
4027 description above.
4028
4029 .vitem &%-oB%&&~<&'n'&>
4030 .oindex "&%-oB%&"
4031 .cindex "SMTP" "passed connection"
4032 .cindex "SMTP" "multiple deliveries"
4033 .cindex "multiple SMTP deliveries"
4034 This is a debugging option which limits the maximum number of messages that can
4035 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4036 transport. If <&'n'&> is omitted, the limit is set to 1.
4037
4038 .vitem &%-odb%&
4039 .oindex "&%-odb%&"
4040 .cindex "background delivery"
4041 .cindex "delivery" "in the background"
4042 This option applies to all modes in which Exim accepts incoming messages,
4043 including the listening daemon. It requests &"background"& delivery of such
4044 messages, which means that the accepting process automatically starts a
4045 delivery process for each message received, but does not wait for the delivery
4046 processes to finish.
4047
4048 When all the messages have been received, the reception process exits,
4049 leaving the delivery processes to finish in their own time. The standard output
4050 and error streams are closed at the start of each delivery process.
4051 This is the default action if none of the &%-od%& options are present.
4052
4053 If one of the queueing options in the configuration file
4054 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4055 overrides it if &%queue_only_override%& is set true, which is the default
4056 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4057
4058 .vitem &%-odf%&
4059 .oindex "&%-odf%&"
4060 .cindex "foreground delivery"
4061 .cindex "delivery" "in the foreground"
4062 This option requests &"foreground"& (synchronous) delivery when Exim has
4063 accepted a locally-generated message. (For the daemon it is exactly the same as
4064 &%-odb%&.) A delivery process is automatically started to deliver the message,
4065 and Exim waits for it to complete before proceeding.
4066
4067 The original Exim reception process does not finish until the delivery
4068 process for the final message has ended. The standard error stream is left open
4069 during deliveries.
4070
4071 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4072 false and one of the queueing options in the configuration file is in effect.
4073
4074 If there is a temporary delivery error during foreground delivery, the
4075 message is left on the queue for later delivery, and the original reception
4076 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4077 restricted configuration that never queues messages.
4078
4079
4080 .vitem &%-odi%&
4081 .oindex "&%-odi%&"
4082 This option is synonymous with &%-odf%&. It is provided for compatibility with
4083 Sendmail.
4084
4085 .vitem &%-odq%&
4086 .oindex "&%-odq%&"
4087 .cindex "non-immediate delivery"
4088 .cindex "delivery" "suppressing immediate"
4089 .cindex "queueing incoming messages"
4090 This option applies to all modes in which Exim accepts incoming messages,
4091 including the listening daemon. It specifies that the accepting process should
4092 not automatically start a delivery process for each message received. Messages
4093 are placed on the queue, and remain there until a subsequent queue runner
4094 process encounters them. There are several configuration options (such as
4095 &%queue_only%&) that can be used to queue incoming messages under certain
4096 conditions. This option overrides all of them and also &%-odqs%&. It always
4097 forces queueing.
4098
4099 .vitem &%-odqs%&
4100 .oindex "&%-odqs%&"
4101 .cindex "SMTP" "delaying delivery"
4102 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4103 However, like &%-odb%& and &%-odi%&, this option has no effect if
4104 &%queue_only_override%& is false and one of the queueing options in the
4105 configuration file is in effect.
4106
4107 When &%-odqs%& does operate, a delivery process is started for each incoming
4108 message, in the background by default, but in the foreground if &%-odi%& is
4109 also present. The recipient addresses are routed, and local deliveries are done
4110 in the normal way. However, if any SMTP deliveries are required, they are not
4111 done at this time, so the message remains on the queue until a subsequent queue
4112 runner process encounters it. Because routing was done, Exim knows which
4113 messages are waiting for which hosts, and so a number of messages for the same
4114 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4115 configuration option has the same effect for specific domains. See also the
4116 &%-qq%& option.
4117
4118 .vitem &%-oee%&
4119 .oindex "&%-oee%&"
4120 .cindex "error" "reporting"
4121 If an error is detected while a non-SMTP message is being received (for
4122 example, a malformed address), the error is reported to the sender in a mail
4123 message.
4124
4125 .cindex "return code" "for &%-oee%&"
4126 Provided
4127 this error message is successfully sent, the Exim receiving process
4128 exits with a return code of zero. If not, the return code is 2 if the problem
4129 is that the original message has no recipients, or 1 for any other error.
4130 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4131
4132 .vitem &%-oem%&
4133 .oindex "&%-oem%&"
4134 .cindex "error" "reporting"
4135 .cindex "return code" "for &%-oem%&"
4136 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4137 return code, whether or not the error message was successfully sent.
4138 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4139
4140 .vitem &%-oep%&
4141 .oindex "&%-oep%&"
4142 .cindex "error" "reporting"
4143 If an error is detected while a non-SMTP message is being received, the
4144 error is reported by writing a message to the standard error file (stderr).
4145 .cindex "return code" "for &%-oep%&"
4146 The return code is 1 for all errors.
4147
4148 .vitem &%-oeq%&
4149 .oindex "&%-oeq%&"
4150 .cindex "error" "reporting"
4151 This option is supported for compatibility with Sendmail, but has the same
4152 effect as &%-oep%&.
4153
4154 .vitem &%-oew%&
4155 .oindex "&%-oew%&"
4156 .cindex "error" "reporting"
4157 This option is supported for compatibility with Sendmail, but has the same
4158 effect as &%-oem%&.
4159
4160 .vitem &%-oi%&
4161 .oindex "&%-oi%&"
4162 .cindex "dot" "in incoming non-SMTP message"
4163 This option, which has the same effect as &%-i%&, specifies that a dot on a
4164 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4165 single dot does terminate, though Exim does no special processing for other
4166 lines that start with a dot. This option is set by default if Exim is called as
4167 &'rmail'&. See also &%-ti%&.
4168
4169 .vitem &%-oitrue%&
4170 .oindex "&%-oitrue%&"
4171 This option is treated as synonymous with &%-oi%&.
4172
4173 .vitem &%-oMa%&&~<&'host&~address'&>
4174 .oindex "&%-oMa%&"
4175 .cindex "sender" "host address, specifying for local message"
4176 A number of options starting with &%-oM%& can be used to set values associated
4177 with remote hosts on locally-submitted messages (that is, messages not received
4178 over TCP/IP). These options can be used by any caller in conjunction with the
4179 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4180 other circumstances, they are ignored unless the caller is trusted.
4181
4182 The &%-oMa%& option sets the sender host address. This may include a port
4183 number at the end, after a full stop (period). For example:
4184 .code
4185 exim -bs -oMa 10.9.8.7.1234
4186 .endd
4187 An alternative syntax is to enclose the IP address in square brackets,
4188 followed by a colon and the port number:
4189 .code
4190 exim -bs -oMa [10.9.8.7]:1234
4191 .endd
4192 The IP address is placed in the &$sender_host_address$& variable, and the
4193 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4194 are present on the command line, the sender host IP address is taken from
4195 whichever one is last.
4196
4197 .vitem &%-oMaa%&&~<&'name'&>
4198 .oindex "&%-oMaa%&"
4199 .cindex "authentication" "name, specifying for local message"
4200 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4201 option sets the value of &$sender_host_authenticated$& (the authenticator
4202 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4203 This option can be used with &%-bh%& and &%-bs%& to set up an
4204 authenticated SMTP session without actually using the SMTP AUTH command.
4205
4206 .vitem &%-oMai%&&~<&'string'&>
4207 .oindex "&%-oMai%&"
4208 .cindex "authentication" "id, specifying for local message"
4209 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4210 option sets the value of &$authenticated_id$& (the id that was authenticated).
4211 This overrides the default value (the caller's login id, except with &%-bh%&,
4212 where there is no default) for messages from local sources. See chapter
4213 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4214
4215 .vitem &%-oMas%&&~<&'address'&>
4216 .oindex "&%-oMas%&"
4217 .cindex "authentication" "sender, specifying for local message"
4218 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4219 option sets the authenticated sender value in &$authenticated_sender$&. It
4220 overrides the sender address that is created from the caller's login id for
4221 messages from local sources, except when &%-bh%& is used, when there is no
4222 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4223 specified on a MAIL command overrides this value. See chapter
4224 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4225
4226 .vitem &%-oMi%&&~<&'interface&~address'&>
4227 .oindex "&%-oMi%&"
4228 .cindex "interface" "address, specifying for local message"
4229 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4230 option sets the IP interface address value. A port number may be included,
4231 using the same syntax as for &%-oMa%&. The interface address is placed in
4232 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4233
4234 .vitem &%-oMm%&&~<&'message&~reference'&>
4235 .oindex "&%-oMm%&"
4236 .cindex "message reference" "message reference, specifying for local message"
4237 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4238 option sets the message reference, e.g. message-id, and is logged during
4239 delivery. This is useful when some kind of audit trail is required to tie
4240 messages together. The format of the message reference is checked and will
4241 abort if the format is invalid. The option will only be accepted if exim is
4242 running in trusted mode, not as any regular user.
4243
4244 The best example of a message reference is when Exim sends a bounce message.
4245 The message reference is the message-id of the original message for which Exim
4246 is sending the bounce.
4247
4248 .vitem &%-oMr%&&~<&'protocol&~name'&>
4249 .oindex "&%-oMr%&"
4250 .cindex "protocol, specifying for local message"
4251 .vindex "&$received_protocol$&"
4252 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4253 option sets the received protocol value that is stored in
4254 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4255 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4256 SMTP protocol names (see the description of &$received_protocol$& in section
4257 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4258 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4259 be set by &%-oMr%&.
4260
4261 .vitem &%-oMs%&&~<&'host&~name'&>
4262 .oindex "&%-oMs%&"
4263 .cindex "sender" "host name, specifying for local message"
4264 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4265 option sets the sender host name in &$sender_host_name$&. When this option is
4266 present, Exim does not attempt to look up a host name from an IP address; it
4267 uses the name it is given.
4268
4269 .vitem &%-oMt%&&~<&'ident&~string'&>
4270 .oindex "&%-oMt%&"
4271 .cindex "sender" "ident string, specifying for local message"
4272 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4273 option sets the sender ident value in &$sender_ident$&. The default setting for
4274 local callers is the login id of the calling process, except when &%-bh%& is
4275 used, when there is no default.
4276
4277 .vitem &%-om%&
4278 .oindex "&%-om%&"
4279 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4280 In Sendmail, this option means &"me too"&, indicating that the sender of a
4281 message should receive a copy of the message if the sender appears in an alias
4282 expansion. Exim always does this, so the option does nothing.
4283
4284 .vitem &%-oo%&
4285 .oindex "&%-oo%&"
4286 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4287 This option is ignored. In Sendmail it specifies &"old style headers"&,
4288 whatever that means.
4289
4290 .vitem &%-oP%&&~<&'path'&>
4291 .oindex "&%-oP%&"
4292 .cindex "pid (process id)" "of daemon"
4293 .cindex "daemon" "process id (pid)"
4294 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4295 value. The option specifies the file to which the process id of the daemon is
4296 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4297 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4298 because in those cases, the normal pid file is not used.
4299
4300 .vitem &%-or%&&~<&'time'&>
4301 .oindex "&%-or%&"
4302 .cindex "timeout" "for non-SMTP input"
4303 This option sets a timeout value for incoming non-SMTP messages. If it is not
4304 set, Exim will wait forever for the standard input. The value can also be set
4305 by the &%receive_timeout%& option. The format used for specifying times is
4306 described in section &<<SECTtimeformat>>&.
4307
4308 .vitem &%-os%&&~<&'time'&>
4309 .oindex "&%-os%&"
4310 .cindex "timeout" "for SMTP input"
4311 .cindex "SMTP" "input timeout"
4312 This option sets a timeout value for incoming SMTP messages. The timeout
4313 applies to each SMTP command and block of data. The value can also be set by
4314 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4315 for specifying times is described in section &<<SECTtimeformat>>&.
4316
4317 .vitem &%-ov%&
4318 .oindex "&%-ov%&"
4319 This option has exactly the same effect as &%-v%&.
4320
4321 .vitem &%-oX%&&~<&'number&~or&~string'&>
4322 .oindex "&%-oX%&"
4323 .cindex "TCP/IP" "setting listening ports"
4324 .cindex "TCP/IP" "setting listening interfaces"
4325 .cindex "port" "receiving TCP/IP"
4326 This option is relevant only when the &%-bd%& (start listening daemon) option
4327 is also given. It controls which ports and interfaces the daemon uses. Details
4328 of the syntax, and how it interacts with configuration file options, are given
4329 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4330 file is written unless &%-oP%& is also present to specify a pid file name.
4331
4332 .vitem &%-pd%&
4333 .oindex "&%-pd%&"
4334 .cindex "Perl" "starting the interpreter"
4335 This option applies when an embedded Perl interpreter is linked with Exim (see
4336 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4337 option, forcing the starting of the interpreter to be delayed until it is
4338 needed.
4339
4340 .vitem &%-ps%&
4341 .oindex "&%-ps%&"
4342 .cindex "Perl" "starting the interpreter"
4343 This option applies when an embedded Perl interpreter is linked with Exim (see
4344 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4345 option, forcing the starting of the interpreter to occur as soon as Exim is
4346 started.
4347
4348 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4349 .oindex "&%-p%&"
4350 For compatibility with Sendmail, this option is equivalent to
4351 .display
4352 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4353 .endd
4354 It sets the incoming protocol and host name (for trusted callers). The
4355 host name and its colon can be omitted when only the protocol is to be set.
4356 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4357 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4358 or &`s`& using this option (but that does not seem a real limitation).
4359
4360 .vitem &%-q%&
4361 .oindex "&%-q%&"
4362 .cindex "queue runner" "starting manually"
4363 This option is normally restricted to admin users. However, there is a
4364 configuration option called &%prod_requires_admin%& which can be set false to
4365 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4366 and &%-S%& options).
4367
4368 .cindex "queue runner" "description of operation"
4369 The &%-q%& option starts one queue runner process. This scans the queue of
4370 waiting messages, and runs a delivery process for each one in turn. It waits
4371 for each delivery process to finish before starting the next one. A delivery
4372 process may not actually do any deliveries if the retry times for the addresses
4373 have not been reached. Use &%-qf%& (see below) if you want to override this.
4374
4375 If
4376 .cindex "SMTP" "passed connection"
4377 .cindex "SMTP" "multiple deliveries"
4378 .cindex "multiple SMTP deliveries"
4379 the delivery process spawns other processes to deliver other messages down
4380 passed SMTP connections, the queue runner waits for these to finish before
4381 proceeding.
4382
4383 When all the queued messages have been considered, the original queue runner
4384 process terminates. In other words, a single pass is made over the waiting
4385 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4386 this to be repeated periodically.
4387
4388 Exim processes the waiting messages in an unpredictable order. It isn't very
4389 random, but it is likely to be different each time, which is all that matters.
4390 If one particular message screws up a remote MTA, other messages to the same
4391 MTA have a chance of getting through if they get tried first.
4392
4393 It is possible to cause the messages to be processed in lexical message id
4394 order, which is essentially the order in which they arrived, by setting the
4395 &%queue_run_in_order%& option, but this is not recommended for normal use.
4396
4397 .vitem &%-q%&<&'qflags'&>
4398 The &%-q%& option may be followed by one or more flag letters that change its
4399 behaviour. They are all optional, but if more than one is present, they must
4400 appear in the correct order. Each flag is described in a separate item below.
4401
4402 .vitem &%-qq...%&
4403 .oindex "&%-qq%&"
4404 .cindex "queue" "double scanning"
4405 .cindex "queue" "routing"
4406 .cindex "routing" "whole queue before delivery"
4407 An option starting with &%-qq%& requests a two-stage queue run. In the first
4408 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4409 every domain. Addresses are routed, local deliveries happen, but no remote
4410 transports are run.
4411
4412 .cindex "hints database" "remembering routing"
4413 The hints database that remembers which messages are waiting for specific hosts
4414 is updated, as if delivery to those hosts had been deferred. After this is
4415 complete, a second, normal queue scan happens, with routing and delivery taking
4416 place as normal. Messages that are routed to the same host should mostly be
4417 delivered down a single SMTP
4418 .cindex "SMTP" "passed connection"
4419 .cindex "SMTP" "multiple deliveries"
4420 .cindex "multiple SMTP deliveries"
4421 connection because of the hints that were set up during the first queue scan.
4422 This option may be useful for hosts that are connected to the Internet
4423 intermittently.
4424
4425 .vitem &%-q[q]i...%&
4426 .oindex "&%-qi%&"
4427 .cindex "queue" "initial delivery"
4428 If the &'i'& flag is present, the queue runner runs delivery processes only for
4429 those messages that haven't previously been tried. (&'i'& stands for &"initial
4430 delivery"&.) This can be helpful if you are putting messages on the queue using
4431 &%-odq%& and want a queue runner just to process the new messages.
4432
4433 .vitem &%-q[q][i]f...%&
4434 .oindex "&%-qf%&"
4435 .cindex "queue" "forcing delivery"
4436 .cindex "delivery" "forcing in queue run"
4437 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4438 message, whereas without &'f'& only those non-frozen addresses that have passed
4439 their retry times are tried.
4440
4441 .vitem &%-q[q][i]ff...%&
4442 .oindex "&%-qff%&"
4443 .cindex "frozen messages" "forcing delivery"
4444 If &'ff'& is present, a delivery attempt is forced for every message, whether
4445 frozen or not.
4446
4447 .vitem &%-q[q][i][f[f]]l%&
4448 .oindex "&%-ql%&"
4449 .cindex "queue" "local deliveries only"
4450 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4451 be done. If a message requires any remote deliveries, it remains on the queue
4452 for later delivery.
4453
4454 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4455 .cindex "queue" "delivering specific messages"
4456 When scanning the queue, Exim can be made to skip over messages whose ids are
4457 lexically less than a given value by following the &%-q%& option with a
4458 starting message id. For example:
4459 .code
4460 exim -q 0t5C6f-0000c8-00
4461 .endd
4462 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4463 second message id is given, messages whose ids are lexically greater than it
4464 are also skipped. If the same id is given twice, for example,
4465 .code
4466 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4467 .endd
4468 just one delivery process is started, for that message. This differs from
4469 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4470 that it counts as a delivery from a queue run. Note that the selection
4471 mechanism does not affect the order in which the messages are scanned. There
4472 are also other ways of selecting specific sets of messages for delivery in a
4473 queue run &-- see &%-R%& and &%-S%&.
4474
4475 .vitem &%-q%&<&'qflags'&><&'time'&>
4476 .cindex "queue runner" "starting periodically"
4477 .cindex "periodic queue running"
4478 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4479 starting a queue runner process at intervals specified by the given time value
4480 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4481 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4482 single daemon process handles both functions. A common way of starting up a
4483 combined daemon at system boot time is to use a command such as
4484 .code
4485 /usr/exim/bin/exim -bd -q30m
4486 .endd
4487 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4488 process every 30 minutes.
4489
4490 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4491 pid file is written unless one is explicitly requested by the &%-oP%& option.
4492
4493 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4494 .oindex "&%-qR%&"
4495 This option is synonymous with &%-R%&. It is provided for Sendmail
4496 compatibility.
4497
4498 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-qS%&"
4500 This option is synonymous with &%-S%&.
4501
4502 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4503 .oindex "&%-R%&"
4504 .cindex "queue runner" "for specific recipients"
4505 .cindex "delivery" "to given domain"
4506 .cindex "domain" "delivery to"
4507 The <&'rsflags'&> may be empty, in which case the white space before the string
4508 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4509 which are the possible values for <&'rsflags'&>. White space is required if
4510 <&'rsflags'&> is not empty.
4511
4512 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4513 perform a single queue run, except that, when scanning the messages on the
4514 queue, Exim processes only those that have at least one undelivered recipient
4515 address containing the given string, which is checked in a case-independent
4516 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4517 regular expression; otherwise it is a literal string.
4518
4519 If you want to do periodic queue runs for messages with specific recipients,
4520 you can combine &%-R%& with &%-q%& and a time value. For example:
4521 .code
4522 exim -q25m -R @special.domain.example
4523 .endd
4524 This example does a queue run for messages with recipients in the given domain
4525 every 25 minutes. Any additional flags that are specified with &%-q%& are
4526 applied to each queue run.
4527
4528 Once a message is selected for delivery by this mechanism, all its addresses
4529 are processed. For the first selected message, Exim overrides any retry
4530 information and forces a delivery attempt for each undelivered address. This
4531 means that if delivery of any address in the first message is successful, any
4532 existing retry information is deleted, and so delivery attempts for that
4533 address in subsequently selected messages (which are processed without forcing)
4534 will run. However, if delivery of any address does not succeed, the retry
4535 information is updated, and in subsequently selected messages, the failing
4536 address will be skipped.
4537
4538 .cindex "frozen messages" "forcing delivery"
4539 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4540 all selected messages, not just the first; frozen messages are included when
4541 &'ff'& is present.
4542
4543 The &%-R%& option makes it straightforward to initiate delivery of all messages
4544 to a given domain after a host has been down for some time. When the SMTP
4545 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4546 effect is to run Exim with the &%-R%& option, but it can be configured to run
4547 an arbitrary command instead.
4548
4549 .vitem &%-r%&
4550 .oindex "&%-r%&"
4551 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4552
4553 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4554 .oindex "&%-S%&"
4555 .cindex "delivery" "from given sender"
4556 .cindex "queue runner" "for specific senders"
4557 This option acts like &%-R%& except that it checks the string against each
4558 message's sender instead of against the recipients. If &%-R%& is also set, both
4559 conditions must be met for a message to be selected. If either of the options
4560 has &'f'& or &'ff'& in its flags, the associated action is taken.
4561
4562 .vitem &%-Tqt%&&~<&'times'&>
4563 .oindex "&%-Tqt%&"
4564 This is an option that is exclusively for use by the Exim testing suite. It is not
4565 recognized when Exim is run normally. It allows for the setting up of explicit
4566 &"queue times"& so that various warning/retry features can be tested.
4567
4568 .vitem &%-t%&
4569 .oindex "&%-t%&"
4570 .cindex "recipient" "extracting from header lines"
4571 .cindex "&'Bcc:'& header line"
4572 .cindex "&'Cc:'& header line"
4573 .cindex "&'To:'& header line"
4574 When Exim is receiving a locally-generated, non-SMTP message on its standard
4575 input, the &%-t%& option causes the recipients of the message to be obtained
4576 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4577 from the command arguments. The addresses are extracted before any rewriting
4578 takes place and the &'Bcc:'& header line, if present, is then removed.
4579
4580 .cindex "Sendmail compatibility" "&%-t%& option"
4581 If the command has any arguments, they specify addresses to which the message
4582 is &'not'& to be delivered. That is, the argument addresses are removed from
4583 the recipients list obtained from the headers. This is compatible with Smail 3
4584 and in accordance with the documented behaviour of several versions of
4585 Sendmail, as described in man pages on a number of operating systems (e.g.
4586 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4587 argument addresses to those obtained from the headers, and the O'Reilly
4588 Sendmail book documents it that way. Exim can be made to add argument addresses
4589 instead of subtracting them by setting the option
4590 &%extract_addresses_remove_arguments%& false.
4591
4592 .cindex "&%Resent-%& header lines" "with &%-t%&"
4593 If there are any &%Resent-%& header lines in the message, Exim extracts
4594 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4595 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4596 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4597 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4598
4599 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4600 message is resent several times). The RFC also specifies that they should be
4601 added at the front of the message, and separated by &'Received:'& lines. It is
4602 not at all clear how &%-t%& should operate in the present of multiple sets,
4603 nor indeed exactly what constitutes a &"set"&.
4604 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4605 are often added at the end of the header, and if a message is resent more than
4606 once, it is common for the original set of &%Resent-%& headers to be renamed as
4607 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4608
4609 .vitem &%-ti%&
4610 .oindex "&%-ti%&"
4611 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4612 compatibility with Sendmail.
4613
4614 .vitem &%-tls-on-connect%&
4615 .oindex "&%-tls-on-connect%&"
4616 .cindex "TLS" "use without STARTTLS"
4617 .cindex "TLS" "automatic start"
4618 This option is available when Exim is compiled with TLS support. It forces all
4619 incoming SMTP connections to behave as if the incoming port is listed in the
4620 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4621 &<<CHAPTLS>>& for further details.
4622
4623
4624 .vitem &%-U%&
4625 .oindex "&%-U%&"
4626 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4627 Sendmail uses this option for &"initial message submission"&, and its
4628 documentation states that in future releases, it may complain about
4629 syntactically invalid messages rather than fixing them when this flag is not
4630 set. Exim ignores this option.
4631
4632 .vitem &%-v%&
4633 .oindex "&%-v%&"
4634 This option causes Exim to write information to the standard error stream,
4635 describing what it is doing. In particular, it shows the log lines for
4636 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4637 dialogue is shown. Some of the log lines shown may not actually be written to
4638 the log if the setting of &%log_selector%& discards them. Any relevant
4639 selectors are shown with each log line. If none are shown, the logging is
4640 unconditional.
4641
4642 .vitem &%-x%&
4643 .oindex "&%-x%&"
4644 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4645 National Language Support extended characters in the body of the mail item"&).
4646 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4647 this option.
4648
4649 .vitem &%-X%&&~<&'logfile'&>
4650 .oindex "&%-X%&"
4651 This option is interpreted by Sendmail to cause debug information to be sent
4652 to the named file.  It is ignored by Exim.
4653
4654 .vitem &%-z%&&~<&'log-line'&>
4655 .oindex "&%-z%&"
4656 This option writes its argument to Exim's logfile.
4657 Use is restricted to administrators; the intent is for operational notes.
4658 Quotes should be used to maintain a multi-word item as a single argument,
4659 under most shells.
4660 .endlist
4661
4662 .ecindex IIDclo1
4663 .ecindex IIDclo2
4664
4665
4666 . ////////////////////////////////////////////////////////////////////////////
4667 . Insert a stylized DocBook comment here, to identify the end of the command
4668 . line options. This is for the benefit of the Perl script that automatically
4669 . creates a man page for the options.
4670 . ////////////////////////////////////////////////////////////////////////////
4671
4672 .literal xml
4673 <!-- === End of command line options === -->
4674 .literal off
4675
4676
4677
4678
4679
4680 . ////////////////////////////////////////////////////////////////////////////
4681 . ////////////////////////////////////////////////////////////////////////////
4682
4683
4684 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4685          "The runtime configuration file"
4686
4687 .cindex "run time configuration"
4688 .cindex "configuration file" "general description"
4689 .cindex "CONFIGURE_FILE"
4690 .cindex "configuration file" "errors in"
4691 .cindex "error" "in configuration file"
4692 .cindex "return code" "for bad configuration"
4693 Exim uses a single run time configuration file that is read whenever an Exim
4694 binary is executed. Note that in normal operation, this happens frequently,
4695 because Exim is designed to operate in a distributed manner, without central
4696 control.
4697
4698 If a syntax error is detected while reading the configuration file, Exim
4699 writes a message on the standard error, and exits with a non-zero return code.
4700 The message is also written to the panic log. &*Note*&: Only simple syntax
4701 errors can be detected at this time. The values of any expanded options are
4702 not checked until the expansion happens, even when the expansion does not
4703 actually alter the string.
4704
4705 The name of the configuration file is compiled into the binary for security
4706 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4707 most configurations, this specifies a single file. However, it is permitted to
4708 give a colon-separated list of file names, in which case Exim uses the first
4709 existing file in the list.
4710
4711 .cindex "EXIM_USER"
4712 .cindex "EXIM_GROUP"
4713 .cindex "CONFIGURE_OWNER"
4714 .cindex "CONFIGURE_GROUP"
4715 .cindex "configuration file" "ownership"
4716 .cindex "ownership" "configuration file"
4717 The run time configuration file must be owned by root or by the user that is
4718 specified at compile time by the CONFIGURE_OWNER option (if set). The
4719 configuration file must not be world-writeable, or group-writeable unless its
4720 group is the root group or the one specified at compile time by the
4721 CONFIGURE_GROUP option.
4722
4723 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4724 to root, anybody who is able to edit the run time configuration file has an
4725 easy way to run commands as root. If you specify a user or group in the
4726 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4727 who are members of that group will trivially be able to obtain root privileges.
4728
4729 Up to Exim version 4.72, the run time configuration file was also permitted to
4730 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4731 since it offered a simple privilege escalation for any attacker who managed to
4732 compromise the Exim user account.
4733
4734 A default configuration file, which will work correctly in simple situations,
4735 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4736 defines just one file name, the installation process copies the default
4737 configuration to a new file of that name if it did not previously exist. If
4738 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4739 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4740 configuration.
4741
4742
4743
4744 .section "Using a different configuration file" "SECID40"
4745 .cindex "configuration file" "alternate"
4746 A one-off alternate configuration can be specified by the &%-C%& command line
4747 option, which may specify a single file or a list of files. However, when
4748 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4749 unless the argument for &%-C%& is identical to the built-in value from
4750 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4751 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4752 is useful mainly for checking the syntax of configuration files before
4753 installing them. No owner or group checks are done on a configuration file
4754 specified by &%-C%&, if root privilege has been dropped.
4755
4756 Even the Exim user is not trusted to specify an arbitrary configuration file
4757 with the &%-C%& option to be used with root privileges, unless that file is
4758 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4759 testing a configuration using &%-C%& right through message reception and
4760 delivery, even if the caller is root. The reception works, but by that time,
4761 Exim is running as the Exim user, so when it re-execs to regain privilege for
4762 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4763 can test reception and delivery using two separate commands (one to put a
4764 message on the queue, using &%-odq%&, and another to do the delivery, using
4765 &%-M%&).
4766
4767 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4768 prefix string with which any file named in a &%-C%& command line option must
4769 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4770 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4771 name can be used with &%-C%&.
4772
4773 One-off changes to a configuration can be specified by the &%-D%& command line
4774 option, which defines and overrides values for macros used inside the
4775 configuration file. However, like &%-C%&, the use of this option by a
4776 non-privileged user causes Exim to discard its root privilege.
4777 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4778 completely disabled, and its use causes an immediate error exit.
4779
4780 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4781 to declare certain macro names trusted, such that root privilege will not
4782 necessarily be discarded.
4783 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4784 considered safe and, if &%-D%& only supplies macros from this list, and the
4785 values are acceptable, then Exim will not give up root privilege if the caller
4786 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4787 transition mechanism and is expected to be removed in the future.  Acceptable
4788 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4789
4790 Some sites may wish to use the same Exim binary on different machines that
4791 share a file system, but to use different configuration files on each machine.
4792 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4793 looks for a file whose name is the configuration file name followed by a dot
4794 and the machine's node name, as obtained from the &[uname()]& function. If this
4795 file does not exist, the standard name is tried. This processing occurs for
4796 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4797
4798 In some esoteric situations different versions of Exim may be run under
4799 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4800 help with this. See the comments in &_src/EDITME_& for details.
4801
4802
4803
4804 .section "Configuration file format" "SECTconffilfor"
4805 .cindex "configuration file" "format of"
4806 .cindex "format" "configuration file"
4807 Exim's configuration file is divided into a number of different parts. General
4808 option settings must always appear at the start of the file. The other parts
4809 are all optional, and may appear in any order. Each part other than the first
4810 is introduced by the word &"begin"& followed by at least one literal
4811 space, and the name of the part. The optional parts are:
4812
4813 .ilist
4814 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4815 &<<CHAPACL>>&).
4816 .next
4817 .cindex "AUTH" "configuration"
4818 &'authenticators'&: Configuration settings for the authenticator drivers. These
4819 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4820 .next
4821 &'routers'&: Configuration settings for the router drivers. Routers process
4822 addresses and determine how the message is to be delivered (see chapters
4823 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4824 .next
4825 &'transports'&: Configuration settings for the transport drivers. Transports
4826 define mechanisms for copying messages to destinations (see chapters
4827 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4828 .next
4829 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4830 If there is no retry section, or if it is empty (that is, no retry rules are
4831 defined), Exim will not retry deliveries. In this situation, temporary errors
4832 are treated the same as permanent errors. Retry rules are discussed in chapter
4833 &<<CHAPretry>>&.
4834 .next
4835 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4836 when new addresses are generated during delivery. Rewriting is discussed in
4837 chapter &<<CHAPrewrite>>&.
4838 .next
4839 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4840 want to use this feature, you must set
4841 .code
4842 LOCAL_SCAN_HAS_OPTIONS=yes
4843 .endd
4844 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4845 facility are given in chapter &<<CHAPlocalscan>>&.
4846 .endlist
4847
4848 .cindex "configuration file" "leading white space in"
4849 .cindex "configuration file" "trailing white space in"
4850 .cindex "white space" "in configuration file"
4851 Leading and trailing white space in configuration lines is always ignored.
4852
4853 Blank lines in the file, and lines starting with a # character (ignoring
4854 leading white space) are treated as comments and are ignored. &*Note*&: A
4855 # character other than at the beginning of a line is not treated specially,
4856 and does not introduce a comment.
4857
4858 Any non-comment line can be continued by ending it with a backslash. Note that
4859 the general rule for white space means that trailing white space after the
4860 backslash and leading white space at the start of continuation
4861 lines is ignored. Comment lines beginning with # (but not empty lines) may
4862 appear in the middle of a sequence of continuation lines.
4863
4864 A convenient way to create a configuration file is to start from the
4865 default, which is supplied in &_src/configure.default_&, and add, delete, or
4866 change settings as required.
4867
4868 The ACLs, retry rules, and rewriting rules have their own syntax which is
4869 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4870 respectively. The other parts of the configuration file have some syntactic
4871 items in common, and these are described below, from section &<<SECTcos>>&
4872 onwards. Before that, the inclusion, macro, and conditional facilities are
4873 described.
4874
4875
4876
4877 .section "File inclusions in the configuration file" "SECID41"
4878 .cindex "inclusions in configuration file"
4879 .cindex "configuration file" "including other files"
4880 .cindex "&`.include`& in configuration file"
4881 .cindex "&`.include_if_exists`& in configuration file"
4882 You can include other files inside Exim's run time configuration file by
4883 using this syntax:
4884 .display
4885 &`.include`& <&'file name'&>
4886 &`.include_if_exists`& <&'file name'&>
4887 .endd
4888 on a line by itself. Double quotes round the file name are optional. If you use
4889 the first form, a configuration error occurs if the file does not exist; the
4890 second form does nothing for non-existent files. In all cases, an absolute file
4891 name is required.
4892
4893 Includes may be nested to any depth, but remember that Exim reads its
4894 configuration file often, so it is a good idea to keep them to a minimum.
4895 If you change the contents of an included file, you must HUP the daemon,
4896 because an included file is read only when the configuration itself is read.
4897
4898 The processing of inclusions happens early, at a physical line level, so, like
4899 comment lines, an inclusion can be used in the middle of an option setting,
4900 for example:
4901 .code
4902 hosts_lookup = a.b.c \
4903                .include /some/file
4904 .endd
4905 Include processing happens after macro processing (see below). Its effect is to
4906 process the lines of the included file as if they occurred inline where the
4907 inclusion appears.
4908
4909
4910
4911 .section "Macros in the configuration file" "SECTmacrodefs"
4912 .cindex "macro" "description of"
4913 .cindex "configuration file" "macros"
4914 If a line in the main part of the configuration (that is, before the first
4915 &"begin"& line) begins with an upper case letter, it is taken as a macro
4916 definition, and must be of the form
4917 .display
4918 <&'name'&> = <&'rest of line'&>
4919 .endd
4920 The name must consist of letters, digits, and underscores, and need not all be
4921 in upper case, though that is recommended. The rest of the line, including any
4922 continuations, is the replacement text, and has leading and trailing white
4923 space removed. Quotes are not removed. The replacement text can never end with
4924 a backslash character, but this doesn't seem to be a serious limitation.
4925
4926 Macros may also be defined between router, transport, authenticator, or ACL
4927 definitions. They may not, however, be defined within an individual driver or
4928 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4929
4930 .section "Macro substitution" "SECID42"
4931 Once a macro is defined, all subsequent lines in the file (and any included
4932 files) are scanned for the macro name; if there are several macros, the line is
4933 scanned for each in turn, in the order in which the macros are defined. The
4934 replacement text is not re-scanned for the current macro, though it is scanned
4935 for subsequently defined macros. For this reason, a macro name may not contain
4936 the name of a previously defined macro as a substring. You could, for example,
4937 define
4938 .display
4939 &`ABCD_XYZ = `&<&'something'&>
4940 &`ABCD = `&<&'something else'&>
4941 .endd
4942 but putting the definitions in the opposite order would provoke a configuration
4943 error. Macro expansion is applied to individual physical lines from the file,
4944 before checking for line continuation or file inclusion (see above). If a line
4945 consists solely of a macro name, and the expansion of the macro is empty, the
4946 line is ignored. A macro at the start of a line may turn the line into a
4947 comment line or a &`.include`& line.
4948
4949
4950 .section "Redefining macros" "SECID43"
4951 Once defined, the value of a macro can be redefined later in the configuration
4952 (or in an included file). Redefinition is specified by using &'=='& instead of
4953 &'='&. For example:
4954 .code
4955 MAC =  initial value
4956 ...
4957 MAC == updated value
4958 .endd
4959 Redefinition does not alter the order in which the macros are applied to the
4960 subsequent lines of the configuration file. It is still the same order in which
4961 the macros were originally defined. All that changes is the macro's value.
4962 Redefinition makes it possible to accumulate values. For example:
4963 .code
4964 MAC =  initial value
4965 ...
4966 MAC == MAC and something added
4967 .endd
4968 This can be helpful in situations where the configuration file is built
4969 from a number of other files.
4970
4971 .section "Overriding macro values" "SECID44"
4972 The values set for macros in the configuration file can be overridden by the
4973 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4974 used, unless called by root or the Exim user. A definition on the command line
4975 using the &%-D%& option causes all definitions and redefinitions within the
4976 file to be ignored.
4977
4978
4979
4980 .section "Example of macro usage" "SECID45"
4981 As an example of macro usage, consider a configuration where aliases are looked
4982 up in a MySQL database. It helps to keep the file less cluttered if long
4983 strings such as SQL statements are defined separately as macros, for example:
4984 .code
4985 ALIAS_QUERY = select mailbox from user where \
4986               login='${quote_mysql:$local_part}';
4987 .endd
4988 This can then be used in a &(redirect)& router setting like this:
4989 .code
4990 data = ${lookup mysql{ALIAS_QUERY}}
4991 .endd
4992 In earlier versions of Exim macros were sometimes used for domain, host, or
4993 address lists. In Exim 4 these are handled better by named lists &-- see
4994 section &<<SECTnamedlists>>&.
4995
4996
4997 .section "Conditional skips in the configuration file" "SECID46"
4998 .cindex "configuration file" "conditional skips"
4999 .cindex "&`.ifdef`&"
5000 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5001 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5002 portions of the configuration file. The processing happens whenever the file is
5003 read (that is, when an Exim binary starts to run).
5004
5005 The implementation is very simple. Instances of the first four directives must
5006 be followed by text that includes the names of one or macros. The condition
5007 that is tested is whether or not any macro substitution has taken place in the
5008 line. Thus:
5009 .code
5010 .ifdef AAA
5011 message_size_limit = 50M
5012 .else
5013 message_size_limit = 100M
5014 .endif
5015 .endd
5016 sets a message size limit of 50M if the macro &`AAA`& is defined
5017 (or &`A`& or &`AA`&), and 100M
5018 otherwise. If there is more than one macro named on the line, the condition
5019 is true if any of them are defined. That is, it is an &"or"& condition. To
5020 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5021
5022 Although you can use a macro expansion to generate one of these directives,
5023 it is not very useful, because the condition &"there was a macro substitution
5024 in this line"& will always be true.
5025
5026 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5027 to clarify complicated nestings.
5028
5029
5030
5031 .section "Common option syntax" "SECTcos"
5032 .cindex "common option syntax"
5033 .cindex "syntax of common options"
5034 .cindex "configuration file" "common option syntax"
5035 For the main set of options, driver options, and &[local_scan()]& options,
5036 each setting is on a line by itself, and starts with a name consisting of
5037 lower-case letters and underscores. Many options require a data value, and in
5038 these cases the name must be followed by an equals sign (with optional white
5039 space) and then the value. For example:
5040 .code
5041 qualify_domain = mydomain.example.com
5042 .endd
5043 .cindex "hiding configuration option values"
5044 .cindex "configuration options" "hiding value of"
5045 .cindex "options" "hiding value of"
5046 Some option settings may contain sensitive data, for example, passwords for
5047 accessing databases. To stop non-admin users from using the &%-bP%& command
5048 line option to read these values, you can precede the option settings with the
5049 word &"hide"&. For example:
5050 .code
5051 hide mysql_servers = localhost/users/admin/secret-password
5052 .endd
5053 For non-admin users, such options are displayed like this:
5054 .code
5055 mysql_servers = <value not displayable>
5056 .endd
5057 If &"hide"& is used on a driver option, it hides the value of that option on
5058 all instances of the same driver.
5059
5060 The following sections describe the syntax used for the different data types
5061 that are found in option settings.
5062
5063
5064 .section "Boolean options" "SECID47"
5065 .cindex "format" "boolean"
5066 .cindex "boolean configuration values"
5067 .oindex "&%no_%&&'xxx'&"
5068 .oindex "&%not_%&&'xxx'&"
5069 Options whose type is given as boolean are on/off switches. There are two
5070 different ways of specifying such options: with and without a data value. If
5071 the option name is specified on its own without data, the switch is turned on;
5072 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5073 boolean options may be followed by an equals sign and one of the words
5074 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5075 the following two settings have exactly the same effect:
5076 .code
5077 queue_only
5078 queue_only = true
5079 .endd
5080 The following two lines also have the same (opposite) effect:
5081 .code
5082 no_queue_only
5083 queue_only = false
5084 .endd
5085 You can use whichever syntax you prefer.
5086
5087
5088
5089
5090 .section "Integer values" "SECID48"
5091 .cindex "integer configuration values"
5092 .cindex "format" "integer"
5093 If an option's type is given as &"integer"&, the value can be given in decimal,
5094 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5095 number is assumed. Otherwise, it is treated as an octal number unless it starts
5096 with the characters &"0x"&, in which case the remainder is interpreted as a
5097 hexadecimal number.
5098
5099 If an integer value is followed by the letter K, it is multiplied by 1024; if
5100 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5101 of integer option settings are output, values which are an exact multiple of
5102 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5103 and M. The printing style is independent of the actual input format that was
5104 used.
5105
5106
5107 .section "Octal integer values" "SECID49"
5108 .cindex "integer format"
5109 .cindex "format" "octal integer"
5110 If an option's type is given as &"octal integer"&, its value is always
5111 interpreted as an octal number, whether or not it starts with the digit zero.
5112 Such options are always output in octal.
5113
5114
5115 .section "Fixed point numbers" "SECID50"
5116 .cindex "fixed point configuration values"
5117 .cindex "format" "fixed point"
5118 If an option's type is given as &"fixed-point"&, its value must be a decimal
5119 integer, optionally followed by a decimal point and up to three further digits.
5120
5121
5122
5123 .section "Time intervals" "SECTtimeformat"
5124 .cindex "time interval" "specifying in configuration"
5125 .cindex "format" "time interval"
5126 A time interval is specified as a sequence of numbers, each followed by one of
5127 the following letters, with no intervening white space:
5128
5129 .table2 30pt
5130 .irow &%s%& seconds
5131 .irow &%m%& minutes
5132 .irow &%h%& hours
5133 .irow &%d%& days
5134 .irow &%w%& weeks
5135 .endtable
5136
5137 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5138 intervals are output in the same format. Exim does not restrict the values; it
5139 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5140
5141
5142
5143 .section "String values" "SECTstrings"
5144 .cindex "string" "format of configuration values"
5145 .cindex "format" "string"
5146 If an option's type is specified as &"string"&, the value can be specified with
5147 or without double-quotes. If it does not start with a double-quote, the value
5148 consists of the remainder of the line plus any continuation lines, starting at
5149 the first character after any leading white space, with trailing white space
5150 removed, and with no interpretation of the characters in the string. Because
5151 Exim removes comment lines (those beginning with #) at an early stage, they can
5152 appear in the middle of a multi-line string. The following two settings are
5153 therefore equivalent:
5154 .code
5155 trusted_users = uucp:mail
5156 trusted_users = uucp:\
5157                 # This comment line is ignored
5158                 mail
5159 .endd
5160 .cindex "string" "quoted"
5161 .cindex "escape characters in quoted strings"
5162 If a string does start with a double-quote, it must end with a closing
5163 double-quote, and any backslash characters other than those used for line
5164 continuation are interpreted as escape characters, as follows:
5165
5166 .table2 100pt
5167 .irow &`\\`&                     "single backslash"
5168 .irow &`\n`&                     "newline"
5169 .irow &`\r`&                     "carriage return"
5170 .irow &`\t`&                     "tab"
5171 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5172 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5173                                    character"
5174 .endtable
5175
5176 If a backslash is followed by some other character, including a double-quote
5177 character, that character replaces the pair.
5178
5179 Quoting is necessary only if you want to make use of the backslash escapes to
5180 insert special characters, or if you need to specify a value with leading or
5181 trailing spaces. These cases are rare, so quoting is almost never needed in
5182 current versions of Exim. In versions of Exim before 3.14, quoting was required
5183 in order to continue lines, so you may come across older configuration files
5184 and examples that apparently quote unnecessarily.
5185
5186
5187 .section "Expanded strings" "SECID51"
5188 .cindex "expansion" "definition of"
5189 Some strings in the configuration file are subjected to &'string expansion'&,
5190 by which means various parts of the string may be changed according to the
5191 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5192 is as just described; in particular, the handling of backslashes in quoted
5193 strings is done as part of the input process, before expansion takes place.
5194 However, backslash is also an escape character for the expander, so any
5195 backslashes that are required for that reason must be doubled if they are
5196 within a quoted configuration string.
5197
5198
5199 .section "User and group names" "SECID52"
5200 .cindex "user name" "format of"
5201 .cindex "format" "user name"
5202 .cindex "groups" "name format"
5203 .cindex "format" "group name"
5204 User and group names are specified as strings, using the syntax described
5205 above, but the strings are interpreted specially. A user or group name must
5206 either consist entirely of digits, or be a name that can be looked up using the
5207 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5208
5209
5210 .section "List construction" "SECTlistconstruct"
5211 .cindex "list" "syntax of in configuration"
5212 .cindex "format" "list item in configuration"
5213 .cindex "string" "list, definition of"
5214 The data for some configuration options is a list of items, with colon as the
5215 default separator. Many of these options are shown with type &"string list"& in
5216 the descriptions later in this document. Others are listed as &"domain list"&,
5217 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5218 are all the same; however, those other than &"string list"& are subject to
5219 particular kinds of interpretation, as described in chapter
5220 &<<CHAPdomhosaddlists>>&.
5221
5222 In all these cases, the entire list is treated as a single string as far as the
5223 input syntax is concerned. The &%trusted_users%& setting in section
5224 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5225 in a list, it must be entered as two colons. Leading and trailing white space
5226 on each item in a list is ignored. This makes it possible to include items that
5227 start with a colon, and in particular, certain forms of IPv6 address. For
5228 example, the list
5229 .code
5230 local_interfaces = 127.0.0.1 : ::::1
5231 .endd
5232 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5233
5234 &*Note*&: Although leading and trailing white space is ignored in individual
5235 list items, it is not ignored when parsing the list. The space after the first
5236 colon in the example above is necessary. If it were not there, the list would
5237 be interpreted as the two items 127.0.0.1:: and 1.
5238
5239 .section "Changing list separators" "SECTlistsepchange"
5240 .cindex "list separator" "changing"
5241 .cindex "IPv6" "addresses in lists"
5242 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5243 introduced to allow the separator character to be changed. If a list begins
5244 with a left angle bracket, followed by any punctuation character, that
5245 character is used instead of colon as the list separator. For example, the list
5246 above can be rewritten to use a semicolon separator like this:
5247 .code
5248 local_interfaces = <; 127.0.0.1 ; ::1
5249 .endd
5250 This facility applies to all lists, with the exception of the list in
5251 &%log_file_path%&. It is recommended that the use of non-colon separators be
5252 confined to circumstances where they really are needed.
5253
5254 .cindex "list separator" "newline as"
5255 .cindex "newline" "as list separator"
5256 It is also possible to use newline and other control characters (those with
5257 code values less than 32, plus DEL) as separators in lists. Such separators
5258 must be provided literally at the time the list is processed. For options that
5259 are string-expanded, you can write the separator using a normal escape
5260 sequence. This will be processed by the expander before the string is
5261 interpreted as a list. For example, if a newline-separated list of domains is
5262 generated by a lookup, you can process it directly by a line such as this:
5263 .code
5264 domains = <\n ${lookup mysql{.....}}
5265 .endd
5266 This avoids having to change the list separator in such data. You are unlikely
5267 to want to use a control character as a separator in an option that is not
5268 expanded, because the value is literal text. However, it can be done by giving
5269 the value in quotes. For example:
5270 .code
5271 local_interfaces = "<\n 127.0.0.1 \n ::1"
5272 .endd
5273 Unlike printing character separators, which can be included in list items by
5274 doubling, it is not possible to include a control character as data when it is
5275 set as the separator. Two such characters in succession are interpreted as
5276 enclosing an empty list item.
5277
5278
5279
5280 .section "Empty items in lists" "SECTempitelis"
5281 .cindex "list" "empty item in"
5282 An empty item at the end of a list is always ignored. In other words, trailing
5283 separator characters are ignored. Thus, the list in
5284 .code
5285 senders = user@domain :
5286 .endd
5287 contains only a single item. If you want to include an empty string as one item
5288 in a list, it must not be the last item. For example, this list contains three
5289 items, the second of which is empty:
5290 .code
5291 senders = user1@domain : : user2@domain
5292 .endd
5293 &*Note*&: There must be white space between the two colons, as otherwise they
5294 are interpreted as representing a single colon data character (and the list
5295 would then contain just one item). If you want to specify a list that contains
5296 just one, empty item, you can do it as in this example:
5297 .code
5298 senders = :
5299 .endd
5300 In this case, the first item is empty, and the second is discarded because it
5301 is at the end of the list.
5302
5303
5304
5305
5306 .section "Format of driver configurations" "SECTfordricon"
5307 .cindex "drivers" "configuration format"
5308 There are separate parts in the configuration for defining routers, transports,
5309 and authenticators. In each part, you are defining a number of driver
5310 instances, each with its own set of options. Each driver instance is defined by
5311 a sequence of lines like this:
5312 .display
5313 <&'instance name'&>:
5314   <&'option'&>
5315   ...
5316   <&'option'&>
5317 .endd
5318 In the following example, the instance name is &(localuser)&, and it is
5319 followed by three options settings:
5320 .code
5321 localuser:
5322   driver = accept
5323   check_local_user
5324   transport = local_delivery
5325 .endd
5326 For each driver instance, you specify which Exim code module it uses &-- by the
5327 setting of the &%driver%& option &-- and (optionally) some configuration
5328 settings. For example, in the case of transports, if you want a transport to
5329 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5330 a local file you would use the &(appendfile)& driver. Each of the drivers is
5331 described in detail in its own separate chapter later in this manual.
5332
5333 You can have several routers, transports, or authenticators that are based on
5334 the same underlying driver (each must have a different instance name).
5335
5336 The order in which routers are defined is important, because addresses are
5337 passed to individual routers one by one, in order. The order in which
5338 transports are defined does not matter at all. The order in which
5339 authenticators are defined is used only when Exim, as a client, is searching
5340 them to find one that matches an authentication mechanism offered by the
5341 server.
5342
5343 .cindex "generic options"
5344 .cindex "options" "generic &-- definition of"
5345 Within a driver instance definition, there are two kinds of option: &'generic'&
5346 and &'private'&. The generic options are those that apply to all drivers of the
5347 same type (that is, all routers, all transports or all authenticators). The
5348 &%driver%& option is a generic option that must appear in every definition.
5349 .cindex "private options"
5350 The private options are special for each driver, and none need appear, because
5351 they all have default values.
5352
5353 The options may appear in any order, except that the &%driver%& option must
5354 precede any private options, since these depend on the particular driver. For
5355 this reason, it is recommended that &%driver%& always be the first option.
5356
5357 Driver instance names, which are used for reference in log entries and
5358 elsewhere, can be any sequence of letters, digits, and underscores (starting
5359 with a letter) and must be unique among drivers of the same type. A router and
5360 a transport (for example) can each have the same name, but no two router
5361 instances can have the same name. The name of a driver instance should not be
5362 confused with the name of the underlying driver module. For example, the
5363 configuration lines:
5364 .code
5365 remote_smtp:
5366   driver = smtp
5367 .endd
5368 create an instance of the &(smtp)& transport driver whose name is
5369 &(remote_smtp)&. The same driver code can be used more than once, with
5370 different instance names and different option settings each time. A second
5371 instance of the &(smtp)& transport, with different options, might be defined
5372 thus:
5373 .code
5374 special_smtp:
5375   driver = smtp
5376   port = 1234
5377   command_timeout = 10s
5378 .endd
5379 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5380 these transport instances from routers, and these names would appear in log
5381 lines.
5382
5383 Comment lines may be present in the middle of driver specifications. The full
5384 list of option settings for any particular driver instance, including all the
5385 defaulted values, can be extracted by making use of the &%-bP%& command line
5386 option.
5387
5388
5389
5390
5391
5392
5393 . ////////////////////////////////////////////////////////////////////////////
5394 . ////////////////////////////////////////////////////////////////////////////
5395
5396 .chapter "The default configuration file" "CHAPdefconfil"
5397 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5398 .cindex "default" "configuration file &""walk through""&"
5399 The default configuration file supplied with Exim as &_src/configure.default_&
5400 is sufficient for a host with simple mail requirements. As an introduction to
5401 the way Exim is configured, this chapter &"walks through"& the default
5402 configuration, giving brief explanations of the settings. Detailed descriptions
5403 of the options are given in subsequent chapters. The default configuration file
5404 itself contains extensive comments about ways you might want to modify the
5405 initial settings. However, note that there are many options that are not
5406 mentioned at all in the default configuration.
5407
5408
5409
5410 .section "Main configuration settings" "SECTdefconfmain"
5411 The main (global) configuration option settings must always come first in the
5412 file. The first thing you'll see in the file, after some initial comments, is
5413 the line
5414 .code
5415 # primary_hostname =
5416 .endd
5417 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5418 to know the official, fully qualified name of your host, and this is where you
5419 can specify it. However, in most cases you do not need to set this option. When
5420 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5421
5422 The first three non-comment configuration lines are as follows:
5423 .code
5424 domainlist local_domains    = @
5425 domainlist relay_to_domains =
5426 hostlist   relay_from_hosts = 127.0.0.1
5427 .endd
5428 These are not, in fact, option settings. They are definitions of two named
5429 domain lists and one named host list. Exim allows you to give names to lists of
5430 domains, hosts, and email addresses, in order to make it easier to manage the
5431 configuration file (see section &<<SECTnamedlists>>&).
5432
5433 The first line defines a domain list called &'local_domains'&; this is used
5434 later in the configuration to identify domains that are to be delivered
5435 on the local host.
5436
5437 .cindex "@ in a domain list"
5438 There is just one item in this list, the string &"@"&. This is a special form
5439 of entry which means &"the name of the local host"&. Thus, if the local host is
5440 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5441 be delivered locally. Because the local host's name is referenced indirectly,
5442 the same configuration file can be used on different hosts.
5443
5444 The second line defines a domain list called &'relay_to_domains'&, but the
5445 list itself is empty. Later in the configuration we will come to the part that
5446 controls mail relaying through the local host; it allows relaying to any
5447 domains in this list. By default, therefore, no relaying on the basis of a mail
5448 domain is permitted.
5449
5450 The third line defines a host list called &'relay_from_hosts'&. This list is
5451 used later in the configuration to permit relaying from any host or IP address
5452 that matches the list. The default contains just the IP address of the IPv4
5453 loopback interface, which means that processes on the local host are able to
5454 submit mail for relaying by sending it over TCP/IP to that interface. No other
5455 hosts are permitted to submit messages for relaying.
5456
5457 Just to be sure there's no misunderstanding: at this point in the configuration
5458 we aren't actually setting up any controls. We are just defining some domains
5459 and hosts that will be used in the controls that are specified later.
5460
5461 The next two configuration lines are genuine option settings:
5462 .code
5463 acl_smtp_rcpt = acl_check_rcpt
5464 acl_smtp_data = acl_check_data
5465 .endd
5466 These options specify &'Access Control Lists'& (ACLs) that are to be used
5467 during an incoming SMTP session for every recipient of a message (every RCPT
5468 command), and after the contents of the message have been received,
5469 respectively. The names of the lists are &'acl_check_rcpt'& and
5470 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5471 section of the configuration. The RCPT ACL controls which recipients are
5472 accepted for an incoming message &-- if a configuration does not provide an ACL
5473 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5474 contents of a message to be checked.
5475
5476 Two commented-out option settings are next:
5477 .code
5478 # av_scanner = clamd:/tmp/clamd
5479 # spamd_address = 127.0.0.1 783
5480 .endd
5481 These are example settings that can be used when Exim is compiled with the
5482 content-scanning extension. The first specifies the interface to the virus
5483 scanner, and the second specifies the interface to SpamAssassin. Further
5484 details are given in chapter &<<CHAPexiscan>>&.
5485
5486 Three more commented-out option settings follow:
5487 .code
5488 # tls_advertise_hosts = *
5489 # tls_certificate = /etc/ssl/exim.crt
5490 # tls_privatekey = /etc/ssl/exim.pem
5491 .endd
5492 These are example settings that can be used when Exim is compiled with
5493 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5494 first one specifies the list of clients that are allowed to use TLS when
5495 connecting to this server; in this case the wildcard means all clients. The
5496 other options specify where Exim should find its TLS certificate and private
5497 key, which together prove the server's identity to any clients that connect.
5498 More details are given in chapter &<<CHAPTLS>>&.
5499
5500 Another two commented-out option settings follow:
5501 .code
5502 # daemon_smtp_ports = 25 : 465 : 587
5503 # tls_on_connect_ports = 465
5504 .endd
5505 .cindex "port" "465 and 587"
5506 .cindex "port" "for message submission"
5507 .cindex "message" "submission, ports for"
5508 .cindex "ssmtp protocol"
5509 .cindex "smtps protocol"
5510 .cindex "SMTP" "ssmtp protocol"
5511 .cindex "SMTP" "smtps protocol"
5512 These options provide better support for roaming users who wish to use this
5513 server for message submission. They are not much use unless you have turned on
5514 TLS (as described in the previous paragraph) and authentication (about which
5515 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5516 on end-user networks, so RFC 4409 specifies that message submission should use
5517 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5518 configured to use port 587 correctly, so these settings also enable the
5519 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5520 &<<SECTsupobssmt>>&).
5521
5522 Two more commented-out options settings follow:
5523 .code
5524 # qualify_domain =
5525 # qualify_recipient =
5526 .endd
5527 The first of these specifies a domain that Exim uses when it constructs a
5528 complete email address from a local login name. This is often needed when Exim
5529 receives a message from a local process. If you do not set &%qualify_domain%&,
5530 the value of &%primary_hostname%& is used. If you set both of these options,
5531 you can have different qualification domains for sender and recipient
5532 addresses. If you set only the first one, its value is used in both cases.
5533
5534 .cindex "domain literal" "recognizing format"
5535 The following line must be uncommented if you want Exim to recognize
5536 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5537 (an IP address within square brackets) instead of a named domain.
5538 .code
5539 # allow_domain_literals
5540 .endd
5541 The RFCs still require this form, but many people think that in the modern
5542 Internet it makes little sense to permit mail to be sent to specific hosts by
5543 quoting their IP addresses. This ancient format has been used by people who
5544 try to abuse hosts by using them for unwanted relaying. However, some
5545 people believe there are circumstances (for example, messages addressed to
5546 &'postmaster'&) where domain literals are still useful.
5547
5548 The next configuration line is a kind of trigger guard:
5549 .code
5550 never_users = root
5551 .endd
5552 It specifies that no delivery must ever be run as the root user. The normal
5553 convention is to set up &'root'& as an alias for the system administrator. This
5554 setting is a guard against slips in the configuration.
5555 The list of users specified by &%never_users%& is not, however, the complete
5556 list; the build-time configuration in &_Local/Makefile_& has an option called
5557 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5558 contents of &%never_users%& are added to this list. By default
5559 FIXED_NEVER_USERS also specifies root.
5560
5561 When a remote host connects to Exim in order to send mail, the only information
5562 Exim has about the host's identity is its IP address. The next configuration
5563 line,
5564 .code
5565 host_lookup = *
5566 .endd
5567 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5568 in order to get a host name. This improves the quality of the logging
5569 information, but if you feel it is too expensive, you can remove it entirely,
5570 or restrict the lookup to hosts on &"nearby"& networks.
5571 Note that it is not always possible to find a host name from an IP address,
5572 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5573 unreachable.
5574
5575 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5576 1413 (hence their names):
5577 .code
5578 rfc1413_hosts = *
5579 rfc1413_query_timeout = 0s
5580 .endd
5581 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5582 Few hosts offer RFC1413 service these days; calls have to be
5583 terminated by a timeout and this needlessly delays the startup
5584 of an incoming SMTP connection.
5585 If you have hosts for which you trust RFC1413 and need this
5586 information, you can change this.
5587
5588 This line enables an efficiency SMTP option.  It is negotiated by clients
5589 and not expected to cause problems but can be disabled if needed.
5590 .code
5591 prdr_enable = true
5592 .endd
5593
5594 When Exim receives messages over SMTP connections, it expects all addresses to
5595 be fully qualified with a domain, as required by the SMTP definition. However,
5596 if you are running a server to which simple clients submit messages, you may
5597 find that they send unqualified addresses. The two commented-out options:
5598 .code
5599 # sender_unqualified_hosts =
5600 # recipient_unqualified_hosts =
5601 .endd
5602 show how you can specify hosts that are permitted to send unqualified sender
5603 and recipient addresses, respectively.
5604
5605 The &%log_selector%& option is used to increase the detail of logging
5606 over the default:
5607 .code
5608 log_selector = +smtp_protocol_error +smtp_syntax_error \
5609                +tls_certificate_verified
5610 .endd
5611
5612 The &%percent_hack_domains%& option is also commented out:
5613 .code
5614 # percent_hack_domains =
5615 .endd
5616 It provides a list of domains for which the &"percent hack"& is to operate.
5617 This is an almost obsolete form of explicit email routing. If you do not know
5618 anything about it, you can safely ignore this topic.
5619
5620 The last two settings in the main part of the default configuration are
5621 concerned with messages that have been &"frozen"& on Exim's queue. When a
5622 message is frozen, Exim no longer continues to try to deliver it. Freezing
5623 occurs when a bounce message encounters a permanent failure because the sender
5624 address of the original message that caused the bounce is invalid, so the
5625 bounce cannot be delivered. This is probably the most common case, but there
5626 are also other conditions that cause freezing, and frozen messages are not
5627 always bounce messages.
5628 .code
5629 ignore_bounce_errors_after = 2d
5630 timeout_frozen_after = 7d
5631 .endd
5632 The first of these options specifies that failing bounce messages are to be
5633 discarded after 2 days on the queue. The second specifies that any frozen
5634 message (whether a bounce message or not) is to be timed out (and discarded)
5635 after a week. In this configuration, the first setting ensures that no failing
5636 bounce message ever lasts a week.
5637
5638
5639
5640 .section "ACL configuration" "SECID54"
5641 .cindex "default" "ACLs"
5642 .cindex "&ACL;" "default configuration"
5643 In the default configuration, the ACL section follows the main configuration.
5644 It starts with the line
5645 .code
5646 begin acl
5647 .endd
5648 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5649 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5650 and &%acl_smtp_data%& above.
5651
5652 .cindex "RCPT" "ACL for"
5653 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5654 RCPT command specifies one of the message's recipients. The ACL statements
5655 are considered in order, until the recipient address is either accepted or
5656 rejected. The RCPT command is then accepted or rejected, according to the
5657 result of the ACL processing.
5658 .code
5659 acl_check_rcpt:
5660 .endd
5661 This line, consisting of a name terminated by a colon, marks the start of the
5662 ACL, and names it.
5663 .code
5664 accept  hosts = :
5665 .endd
5666 This ACL statement accepts the recipient if the sending host matches the list.
5667 But what does that strange list mean? It doesn't actually contain any host
5668 names or IP addresses. The presence of the colon puts an empty item in the
5669 list; Exim matches this only if the incoming message did not come from a remote
5670 host, because in that case, the remote hostname is empty. The colon is
5671 important. Without it, the list itself is empty, and can never match anything.
5672
5673 What this statement is doing is to accept unconditionally all recipients in
5674 messages that are submitted by SMTP from local processes using the standard
5675 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5676 manner.
5677 .code
5678 deny    message       = Restricted characters in address
5679         domains       = +local_domains
5680         local_parts   = ^[.] : ^.*[@%!/|]
5681
5682 deny    message       = Restricted characters in address
5683         domains       = !+local_domains
5684         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5685 .endd
5686 These statements are concerned with local parts that contain any of the
5687 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5688 Although these characters are entirely legal in local parts (in the case of
5689 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5690 in Internet mail addresses.
5691
5692 The first three have in the past been associated with explicitly routed
5693 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5694 option). Addresses containing these characters are regularly tried by spammers
5695 in an attempt to bypass relaying restrictions, and also by open relay testing
5696 programs. Unless you really need them it is safest to reject these characters
5697 at this early stage. This configuration is heavy-handed in rejecting these
5698 characters for all messages it accepts from remote hosts. This is a deliberate
5699 policy of being as safe as possible.
5700
5701 The first rule above is stricter, and is applied to messages that are addressed
5702 to one of the local domains handled by this host. This is implemented by the
5703 first condition, which restricts it to domains that are listed in the
5704 &'local_domains'& domain list. The &"+"& character is used to indicate a
5705 reference to a named list. In this configuration, there is just one domain in
5706 &'local_domains'&, but in general there may be many.
5707
5708 The second condition on the first statement uses two regular expressions to
5709 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5710 or &"|"&. If you have local accounts that include these characters, you will
5711 have to modify this rule.
5712
5713 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5714 allows them because they have been encountered in practice. (Consider the
5715 common convention of local parts constructed as
5716 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5717 the author of Exim, who has no second initial.) However, a local part starting
5718 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5719 file name (for example, for a mailing list). This is also true for local parts
5720 that contain slashes. A pipe symbol can also be troublesome if the local part
5721 is incorporated unthinkingly into a shell command line.
5722
5723 The second rule above applies to all other domains, and is less strict. This
5724 allows your own users to send outgoing messages to sites that use slashes
5725 and vertical bars in their local parts. It blocks local parts that begin
5726 with a dot, slash, or vertical bar, but allows these characters within the
5727 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5728 and &"!"& is blocked, as before. The motivation here is to prevent your users
5729 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5730 .code
5731 accept  local_parts   = postmaster
5732         domains       = +local_domains
5733 .endd
5734 This statement, which has two conditions, accepts an incoming address if the
5735 local part is &'postmaster'& and the domain is one of those listed in the
5736 &'local_domains'& domain list. The &"+"& character is used to indicate a
5737 reference to a named list. In this configuration, there is just one domain in
5738 &'local_domains'&, but in general there may be many.
5739
5740 The presence of this statement means that mail to postmaster is never blocked
5741 by any of the subsequent tests. This can be helpful while sorting out problems
5742 in cases where the subsequent tests are incorrectly denying access.
5743 .code
5744 require verify        = sender
5745 .endd
5746 This statement requires the sender address to be verified before any subsequent
5747 ACL statement can be used. If verification fails, the incoming recipient
5748 address is refused. Verification consists of trying to route the address, to
5749 see if a bounce message could be delivered to it. In the case of remote
5750 addresses, basic verification checks only the domain, but &'callouts'& can be
5751 used for more verification if required. Section &<<SECTaddressverification>>&
5752 discusses the details of address verification.
5753 .code
5754 accept  hosts         = +relay_from_hosts
5755         control       = submission
5756 .endd
5757 This statement accepts the address if the message is coming from one of the
5758 hosts that are defined as being allowed to relay through this host. Recipient
5759 verification is omitted here, because in many cases the clients are dumb MUAs
5760 that do not cope well with SMTP error responses. For the same reason, the
5761 second line specifies &"submission mode"& for messages that are accepted. This
5762 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5763 messages that are deficient in some way, for example, because they lack a
5764 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5765 probably add recipient verification here, and disable submission mode.
5766 .code
5767 accept  authenticated = *
5768         control       = submission
5769 .endd
5770 This statement accepts the address if the client host has authenticated itself.
5771 Submission mode is again specified, on the grounds that such messages are most
5772 likely to come from MUAs. The default configuration does not define any
5773 authenticators, though it does include some nearly complete commented-out
5774 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5775 fact authenticate until you complete the authenticator definitions.
5776 .code
5777 require message = relay not permitted
5778         domains = +local_domains : +relay_to_domains
5779 .endd
5780 This statement rejects the address if its domain is neither a local domain nor
5781 one of the domains for which this host is a relay.
5782 .code
5783 require verify = recipient
5784 .endd
5785 This statement requires the recipient address to be verified; if verification
5786 fails, the address is rejected.
5787 .code
5788 # deny    message     = rejected because $sender_host_address \
5789 #                       is in a black list at $dnslist_domain\n\
5790 #                       $dnslist_text
5791 #         dnslists    = black.list.example
5792 #
5793 # warn    dnslists    = black.list.example
5794 #         add_header  = X-Warning: $sender_host_address is in \
5795 #                       a black list at $dnslist_domain
5796 #         log_message = found in $dnslist_domain
5797 .endd
5798 These commented-out lines are examples of how you could configure Exim to check
5799 sending hosts against a DNS black list. The first statement rejects messages
5800 from blacklisted hosts, whereas the second just inserts a warning header
5801 line.
5802 .code
5803 # require verify = csa
5804 .endd
5805 This commented-out line is an example of how you could turn on client SMTP
5806 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5807 records.
5808 .code
5809 accept
5810 .endd
5811 The final statement in the first ACL unconditionally accepts any recipient
5812 address that has successfully passed all the previous tests.
5813 .code
5814 acl_check_data:
5815 .endd
5816 This line marks the start of the second ACL, and names it. Most of the contents
5817 of this ACL are commented out:
5818 .code
5819 # deny    malware   = *
5820 #         message   = This message contains a virus \
5821 #                     ($malware_name).
5822 .endd
5823 These lines are examples of how to arrange for messages to be scanned for
5824 viruses when Exim has been compiled with the content-scanning extension, and a
5825 suitable virus scanner is installed. If the message is found to contain a
5826 virus, it is rejected with the given custom error message.
5827 .code
5828 # warn    spam      = nobody
5829 #         message   = X-Spam_score: $spam_score\n\
5830 #                     X-Spam_score_int: $spam_score_int\n\
5831 #                     X-Spam_bar: $spam_bar\n\
5832 #                     X-Spam_report: $spam_report
5833 .endd
5834 These lines are an example of how to arrange for messages to be scanned by
5835 SpamAssassin when Exim has been compiled with the content-scanning extension,
5836 and SpamAssassin has been installed. The SpamAssassin check is run with
5837 &`nobody`& as its user parameter, and the results are added to the message as a
5838 series of extra header line. In this case, the message is not rejected,
5839 whatever the spam score.
5840 .code
5841 accept
5842 .endd
5843 This final line in the DATA ACL accepts the message unconditionally.
5844
5845
5846 .section "Router configuration" "SECID55"
5847 .cindex "default" "routers"
5848 .cindex "routers" "default"
5849 The router configuration comes next in the default configuration, introduced
5850 by the line
5851 .code
5852 begin routers
5853 .endd
5854 Routers are the modules in Exim that make decisions about where to send
5855 messages. An address is passed to each router in turn, until it is either
5856 accepted, or failed. This means that the order in which you define the routers
5857 matters. Each router is fully described in its own chapter later in this
5858 manual. Here we give only brief overviews.
5859 .code
5860 # domain_literal:
5861 #   driver = ipliteral
5862 #   domains = !+local_domains
5863 #   transport = remote_smtp
5864 .endd
5865 .cindex "domain literal" "default router"
5866 This router is commented out because the majority of sites do not want to
5867 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5868 you uncomment this router, you also need to uncomment the setting of
5869 &%allow_domain_literals%& in the main part of the configuration.
5870 .code
5871 dnslookup:
5872   driver = dnslookup
5873   domains = ! +local_domains
5874   transport = remote_smtp
5875   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5876   no_more
5877 .endd
5878 The first uncommented router handles addresses that do not involve any local
5879 domains. This is specified by the line
5880 .code
5881 domains = ! +local_domains
5882 .endd
5883 The &%domains%& option lists the domains to which this router applies, but the
5884 exclamation mark is a negation sign, so the router is used only for domains
5885 that are not in the domain list called &'local_domains'& (which was defined at
5886 the start of the configuration). The plus sign before &'local_domains'&
5887 indicates that it is referring to a named list. Addresses in other domains are
5888 passed on to the following routers.
5889
5890 The name of the router driver is &(dnslookup)&,
5891 and is specified by the &%driver%& option. Do not be confused by the fact that
5892 the name of this router instance is the same as the name of the driver. The
5893 instance name is arbitrary, but the name set in the &%driver%& option must be
5894 one of the driver modules that is in the Exim binary.
5895
5896 The &(dnslookup)& router routes addresses by looking up their domains in the
5897 DNS in order to obtain a list of hosts to which the address is routed. If the
5898 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5899 specified by the &%transport%& option. If the router does not find the domain
5900 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5901 the address fails and is bounced.
5902
5903 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5904 be entirely ignored. This option is present because a number of cases have been
5905 encountered where MX records in the DNS point to host names
5906 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5907 Completely ignoring these IP addresses causes Exim to fail to route the
5908 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5909 continue to try to deliver the message periodically until the address timed
5910 out.
5911 .code
5912 system_aliases:
5913   driver = redirect
5914   allow_fail
5915   allow_defer
5916   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5917 # user = exim
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920 .endd
5921 Control reaches this and subsequent routers only for addresses in the local
5922 domains. This router checks to see whether the local part is defined as an
5923 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5924 data that it looks up from that file. If no data is found for the local part,
5925 the value of the &%data%& option is empty, causing the address to be passed to
5926 the next router.
5927
5928 &_/etc/aliases_& is a conventional name for the system aliases file that is
5929 often used. That is why it is referenced by from the default configuration
5930 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5931 &_Local/Makefile_& before building Exim.
5932 .code
5933 userforward:
5934   driver = redirect
5935   check_local_user
5936 # local_part_suffix = +* : -*
5937 # local_part_suffix_optional
5938   file = $home/.forward
5939 # allow_filter
5940   no_verify
5941   no_expn
5942   check_ancestor
5943   file_transport = address_file
5944   pipe_transport = address_pipe
5945   reply_transport = address_reply
5946 .endd
5947 This is the most complicated router in the default configuration. It is another
5948 redirection router, but this time it is looking for forwarding data set up by
5949 individual users. The &%check_local_user%& setting specifies a check that the
5950 local part of the address is the login name of a local user. If it is not, the
5951 router is skipped. The two commented options that follow &%check_local_user%&,
5952 namely:
5953 .code
5954 # local_part_suffix = +* : -*
5955 # local_part_suffix_optional
5956 .endd
5957 .vindex "&$local_part_suffix$&"
5958 show how you can specify the recognition of local part suffixes. If the first
5959 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5960 by any sequence of characters, is removed from the local part and placed in the
5961 variable &$local_part_suffix$&. The second suffix option specifies that the
5962 presence of a suffix in the local part is optional. When a suffix is present,
5963 the check for a local login uses the local part with the suffix removed.
5964
5965 When a local user account is found, the file called &_.forward_& in the user's
5966 home directory is consulted. If it does not exist, or is empty, the router
5967 declines. Otherwise, the contents of &_.forward_& are interpreted as
5968 redirection data (see chapter &<<CHAPredirect>>& for more details).
5969
5970 .cindex "Sieve filter" "enabling in default router"
5971 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5972 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5973 is commented out by default), the contents of the file are interpreted as a set
5974 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5975 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5976 separate document entitled &'Exim's interfaces to mail filtering'&.
5977
5978 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5979 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5980 There are two reasons for doing this:
5981
5982 .olist
5983 Whether or not a local user has a &_.forward_& file is not really relevant when
5984 checking an address for validity; it makes sense not to waste resources doing
5985 unnecessary work.
5986 .next
5987 More importantly, when Exim is verifying addresses or handling an EXPN
5988 command during an SMTP session, it is running as the Exim user, not as root.
5989 The group is the Exim group, and no additional groups are set up.
5990 It may therefore not be possible for Exim to read users' &_.forward_& files at
5991 this time.
5992 .endlist
5993
5994 The setting of &%check_ancestor%& prevents the router from generating a new
5995 address that is the same as any previous address that was redirected. (This
5996 works round a problem concerning a bad interaction between aliasing and
5997 forwarding &-- see section &<<SECTredlocmai>>&).
5998
5999 The final three option settings specify the transports that are to be used when
6000 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6001 auto-reply, respectively. For example, if a &_.forward_& file contains
6002 .code
6003 a.nother@elsewhere.example, /home/spqr/archive
6004 .endd
6005 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6006 transport.
6007 .code
6008 localuser:
6009   driver = accept
6010   check_local_user
6011 # local_part_suffix = +* : -*
6012 # local_part_suffix_optional
6013   transport = local_delivery
6014 .endd
6015 The final router sets up delivery into local mailboxes, provided that the local
6016 part is the name of a local login, by accepting the address and assigning it to
6017 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6018 routers, so the address is bounced. The commented suffix settings fulfil the
6019 same purpose as they do for the &(userforward)& router.
6020
6021
6022 .section "Transport configuration" "SECID56"
6023 .cindex "default" "transports"
6024 .cindex "transports" "default"
6025 Transports define mechanisms for actually delivering messages. They operate
6026 only when referenced from routers, so the order in which they are defined does
6027 not matter. The transports section of the configuration starts with
6028 .code
6029 begin transports
6030 .endd
6031 One remote transport and four local transports are defined.
6032 .code
6033 remote_smtp:
6034   driver = smtp
6035   hosts_try_prdr = *
6036 .endd
6037 This transport is used for delivering messages over SMTP connections.
6038 The list of remote hosts comes from the router.
6039 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6040 It is negotiated between client and server
6041 and not expected to cause problems but can be disabled if needed.
6042 All other options are defaulted.
6043 .code
6044 local_delivery:
6045   driver = appendfile
6046   file = /var/mail/$local_part
6047   delivery_date_add
6048   envelope_to_add
6049   return_path_add
6050 # group = mail
6051 # mode = 0660
6052 .endd
6053 This &(appendfile)& transport is used for local delivery to user mailboxes in
6054 traditional BSD mailbox format. By default it runs under the uid and gid of the
6055 local user, which requires the sticky bit to be set on the &_/var/mail_&
6056 directory. Some systems use the alternative approach of running mail deliveries
6057 under a particular group instead of using the sticky bit. The commented options
6058 show how this can be done.
6059
6060 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6061 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6062 similarly-named options above.
6063 .code
6064 address_pipe:
6065   driver = pipe
6066   return_output
6067 .endd
6068 This transport is used for handling deliveries to pipes that are generated by
6069 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6070 option specifies that any output on stdout or stderr generated by the pipe is to
6071 be returned to the sender.
6072 .code
6073 address_file:
6074   driver = appendfile
6075   delivery_date_add
6076   envelope_to_add
6077   return_path_add
6078 .endd
6079 This transport is used for handling deliveries to files that are generated by
6080 redirection. The name of the file is not specified in this instance of
6081 &(appendfile)&, because it comes from the &(redirect)& router.
6082 .code
6083 address_reply:
6084   driver = autoreply
6085 .endd
6086 This transport is used for handling automatic replies generated by users'
6087 filter files.
6088
6089
6090
6091 .section "Default retry rule" "SECID57"
6092 .cindex "retry" "default rule"
6093 .cindex "default" "retry rule"
6094 The retry section of the configuration file contains rules which affect the way
6095 Exim retries deliveries that cannot be completed at the first attempt. It is
6096 introduced by the line
6097 .code
6098 begin retry
6099 .endd
6100 In the default configuration, there is just one rule, which applies to all
6101 errors:
6102 .code
6103 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6104 .endd
6105 This causes any temporarily failing address to be retried every 15 minutes for
6106 2 hours, then at intervals starting at one hour and increasing by a factor of
6107 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6108 is not delivered after 4 days of temporary failure, it is bounced.
6109
6110 If the retry section is removed from the configuration, or is empty (that is,
6111 if no retry rules are defined), Exim will not retry deliveries. This turns
6112 temporary errors into permanent errors.
6113
6114
6115 .section "Rewriting configuration" "SECID58"
6116 The rewriting section of the configuration, introduced by
6117 .code
6118 begin rewrite
6119 .endd
6120 contains rules for rewriting addresses in messages as they arrive. There are no
6121 rewriting rules in the default configuration file.
6122
6123
6124
6125 .section "Authenticators configuration" "SECTdefconfauth"
6126 .cindex "AUTH" "configuration"
6127 The authenticators section of the configuration, introduced by
6128 .code
6129 begin authenticators
6130 .endd
6131 defines mechanisms for the use of the SMTP AUTH command. The default
6132 configuration file contains two commented-out example authenticators
6133 which support plaintext username/password authentication using the
6134 standard PLAIN mechanism and the traditional but non-standard LOGIN
6135 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6136 to support most MUA software.
6137
6138 The example PLAIN authenticator looks like this:
6139 .code
6140 #PLAIN:
6141 #  driver                  = plaintext
6142 #  server_set_id           = $auth2
6143 #  server_prompts          = :
6144 #  server_condition        = Authentication is not yet configured
6145 #  server_advertise_condition = ${if def:tls_in_cipher }
6146 .endd
6147 And the example LOGIN authenticator looks like this:
6148 .code
6149 #LOGIN:
6150 #  driver                  = plaintext
6151 #  server_set_id           = $auth1
6152 #  server_prompts          = <| Username: | Password:
6153 #  server_condition        = Authentication is not yet configured
6154 #  server_advertise_condition = ${if def:tls_in_cipher }
6155 .endd
6156
6157 The &%server_set_id%& option makes Exim remember the authenticated username
6158 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6159 &%server_prompts%& option configures the &(plaintext)& authenticator so
6160 that it implements the details of the specific authentication mechanism,
6161 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6162 when Exim offers authentication to clients; in the examples, this is only
6163 when TLS or SSL has been started, so to enable the authenticators you also
6164 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6165
6166 The &%server_condition%& setting defines how to verify that the username and
6167 password are correct. In the examples it just produces an error message.
6168 To make the authenticators work, you can use a string expansion
6169 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6170
6171 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6172 usercode and password are in different positions.
6173 Chapter &<<CHAPplaintext>>& covers both.
6174
6175 .ecindex IIDconfiwal
6176
6177
6178
6179 . ////////////////////////////////////////////////////////////////////////////
6180 . ////////////////////////////////////////////////////////////////////////////
6181
6182 .chapter "Regular expressions" "CHAPregexp"
6183
6184 .cindex "regular expressions" "library"
6185 .cindex "PCRE"
6186 Exim supports the use of regular expressions in many of its options. It
6187 uses the PCRE regular expression library; this provides regular expression
6188 matching that is compatible with Perl 5. The syntax and semantics of
6189 regular expressions is discussed in many Perl reference books, and also in
6190 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6191 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6192
6193 The documentation for the syntax and semantics of the regular expressions that
6194 are supported by PCRE is included in the PCRE distribution, and no further
6195 description is included here. The PCRE functions are called from Exim using
6196 the default option settings (that is, with no PCRE options set), except that
6197 the PCRE_CASELESS option is set when the matching is required to be
6198 case-insensitive.
6199
6200 In most cases, when a regular expression is required in an Exim configuration,
6201 it has to start with a circumflex, in order to distinguish it from plain text
6202 or an &"ends with"& wildcard. In this example of a configuration setting, the
6203 second item in the colon-separated list is a regular expression.
6204 .code
6205 domains = a.b.c : ^\\d{3} : *.y.z : ...
6206 .endd
6207 The doubling of the backslash is required because of string expansion that
6208 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6209 of this issue, and a way of avoiding the need for doubling backslashes. The
6210 regular expression that is eventually used in this example contains just one
6211 backslash. The circumflex is included in the regular expression, and has the
6212 normal effect of &"anchoring"& it to the start of the string that is being
6213 matched.
6214
6215 There are, however, two cases where a circumflex is not required for the
6216 recognition of a regular expression: these are the &%match%& condition in a
6217 string expansion, and the &%matches%& condition in an Exim filter file. In
6218 these cases, the relevant string is always treated as a regular expression; if
6219 it does not start with a circumflex, the expression is not anchored, and can
6220 match anywhere in the subject string.
6221
6222 In all cases, if you want a regular expression to match at the end of a string,
6223 you must code the $ metacharacter to indicate this. For example:
6224 .code
6225 domains = ^\\d{3}\\.example
6226 .endd
6227 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6228 You need to use:
6229 .code
6230 domains = ^\\d{3}\\.example\$
6231 .endd
6232 if you want &'example'& to be the top-level domain. The backslash before the
6233 $ is needed because string expansion also interprets dollar characters.
6234
6235
6236
6237 . ////////////////////////////////////////////////////////////////////////////
6238 . ////////////////////////////////////////////////////////////////////////////
6239
6240 .chapter "File and database lookups" "CHAPfdlookup"
6241 .scindex IIDfidalo1 "file" "lookups"
6242 .scindex IIDfidalo2 "database" "lookups"
6243 .cindex "lookup" "description of"
6244 Exim can be configured to look up data in files or databases as it processes
6245 messages. Two different kinds of syntax are used:
6246
6247 .olist
6248 A string that is to be expanded may contain explicit lookup requests. These
6249 cause parts of the string to be replaced by data that is obtained from the
6250 lookup. Lookups of this type are conditional expansion items. Different results
6251 can be defined for the cases of lookup success and failure. See chapter
6252 &<<CHAPexpand>>&, where string expansions are described in detail.
6253 The key for the lookup is specified as part of the string expansion.
6254 .next
6255 Lists of domains, hosts, and email addresses can contain lookup requests as a
6256 way of avoiding excessively long linear lists. In this case, the data that is
6257 returned by the lookup is often (but not always) discarded; whether the lookup
6258 succeeds or fails is what really counts. These kinds of list are described in
6259 chapter &<<CHAPdomhosaddlists>>&.
6260 The key for the lookup is given by the context in which the list is expanded.
6261 .endlist
6262
6263 String expansions, lists, and lookups interact with each other in such a way
6264 that there is no order in which to describe any one of them that does not
6265 involve references to the others. Each of these three chapters makes more sense
6266 if you have read the other two first. If you are reading this for the first
6267 time, be aware that some of it will make a lot more sense after you have read
6268 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6269
6270 .section "Examples of different lookup syntax" "SECID60"
6271 It is easy to confuse the two different kinds of lookup, especially as the
6272 lists that may contain the second kind are always expanded before being
6273 processed as lists. Therefore, they may also contain lookups of the first kind.
6274 Be careful to distinguish between the following two examples:
6275 .code
6276 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6277 domains = lsearch;/some/file
6278 .endd
6279 The first uses a string expansion, the result of which must be a domain list.
6280 No strings have been specified for a successful or a failing lookup; the
6281 defaults in this case are the looked-up data and an empty string, respectively.
6282 The expansion takes place before the string is processed as a list, and the
6283 file that is searched could contain lines like this:
6284 .code
6285 192.168.3.4: domain1:domain2:...
6286 192.168.1.9: domain3:domain4:...
6287 .endd
6288 When the lookup succeeds, the result of the expansion is a list of domains (and
6289 possibly other types of item that are allowed in domain lists).
6290
6291 In the second example, the lookup is a single item in a domain list. It causes
6292 Exim to use a lookup to see if the domain that is being processed can be found
6293 in the file. The file could contains lines like this:
6294 .code
6295 domain1:
6296 domain2:
6297 .endd
6298 Any data that follows the keys is not relevant when checking that the domain
6299 matches the list item.
6300
6301 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6302 Consider a file containing lines like this:
6303 .code
6304 192.168.5.6: lsearch;/another/file
6305 .endd
6306 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6307 first &%domains%& setting above generates the second setting, which therefore
6308 causes a second lookup to occur.
6309
6310 The rest of this chapter describes the different lookup types that are
6311 available. Any of them can be used in any part of the configuration where a
6312 lookup is permitted.
6313
6314
6315 .section "Lookup types" "SECID61"
6316 .cindex "lookup" "types of"
6317 .cindex "single-key lookup" "definition of"
6318 Two different types of data lookup are implemented:
6319
6320 .ilist
6321 The &'single-key'& type requires the specification of a file in which to look,
6322 and a single key to search for. The key must be a non-empty string for the
6323 lookup to succeed. The lookup type determines how the file is searched.
6324 .next
6325 .cindex "query-style lookup" "definition of"
6326 The &'query-style'& type accepts a generalized database query. No particular
6327 key value is assumed by Exim for query-style lookups. You can use whichever
6328 Exim variables you need to construct the database query.
6329 .endlist
6330
6331 The code for each lookup type is in a separate source file that is included in
6332 the binary of Exim only if the corresponding compile-time option is set. The
6333 default settings in &_src/EDITME_& are:
6334 .code
6335 LOOKUP_DBM=yes
6336 LOOKUP_LSEARCH=yes
6337 .endd
6338 which means that only linear searching and DBM lookups are included by default.
6339 For some types of lookup (e.g. SQL databases), you need to install appropriate
6340 libraries and header files before building Exim.
6341
6342
6343
6344
6345 .section "Single-key lookup types" "SECTsinglekeylookups"
6346 .cindex "lookup" "single-key types"
6347 .cindex "single-key lookup" "list of types"
6348 The following single-key lookup types are implemented:
6349
6350 .ilist
6351 .cindex "cdb" "description of"
6352 .cindex "lookup" "cdb"
6353 .cindex "binary zero" "in lookup key"
6354 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6355 string without a terminating binary zero. The cdb format is designed for
6356 indexed files that are read frequently and never updated, except by total
6357 re-creation. As such, it is particularly suitable for large files containing
6358 aliases or other indexed data referenced by an MTA. Information about cdb can
6359 be found in several places:
6360 .display
6361 &url(http://www.pobox.com/~djb/cdb.html)
6362 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6363 &url(http://packages.debian.org/stable/utils/freecdb.html)
6364 .endd
6365 A cdb distribution is not needed in order to build Exim with cdb support,
6366 because the code for reading cdb files is included directly in Exim itself.
6367 However, no means of building or testing cdb files is provided with Exim, so
6368 you need to obtain a cdb distribution in order to do this.
6369 .next
6370 .cindex "DBM" "lookup type"
6371 .cindex "lookup" "dbm"
6372 .cindex "binary zero" "in lookup key"
6373 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6374 DBM file by looking up the record with the given key. A terminating binary
6375 zero is included in the key that is passed to the DBM library. See section
6376 &<<SECTdb>>& for a discussion of DBM libraries.
6377
6378 .cindex "Berkeley DB library" "file format"
6379 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6380 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6381 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6382 the DB_UNKNOWN option. This enables it to handle any of the types of database
6383 that the library supports, and can be useful for accessing DBM files created by
6384 other applications. (For earlier DB versions, DB_HASH is always used.)
6385 .next
6386 .cindex "lookup" "dbmjz"
6387 .cindex "lookup" "dbm &-- embedded NULs"
6388 .cindex "sasldb2"
6389 .cindex "dbmjz lookup type"
6390 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6391 interpreted as an Exim list; the elements of the list are joined together with
6392 ASCII NUL characters to form the lookup key.  An example usage would be to
6393 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6394 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6395 &(cram_md5)& authenticator.
6396 .next
6397 .cindex "lookup" "dbmnz"
6398 .cindex "lookup" "dbm &-- terminating zero"
6399 .cindex "binary zero" "in lookup key"
6400 .cindex "Courier"
6401 .cindex "&_/etc/userdbshadow.dat_&"
6402 .cindex "dbmnz lookup type"
6403 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6404 is not included in the key that is passed to the DBM library. You may need this
6405 if you want to look up data in files that are created by or shared with some
6406 other application that does not use terminating zeros. For example, you need to
6407 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6408 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6409 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6410 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6411 .next
6412 .cindex "lookup" "dsearch"
6413 .cindex "dsearch lookup type"
6414 &(dsearch)&: The given file must be a directory; this is searched for an entry
6415 whose name is the key by calling the &[lstat()]& function. The key may not
6416 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6417 the lookup is the name of the entry, which may be a file, directory,
6418 symbolic link, or any other kind of directory entry. An example of how this
6419 lookup can be used to support virtual domains is given in section
6420 &<<SECTvirtualdomains>>&.
6421 .next
6422 .cindex "lookup" "iplsearch"
6423 .cindex "iplsearch lookup type"
6424 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6425 terminated by a colon or white space or the end of the line. The keys in the
6426 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6427 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6428 being interpreted as a key terminator. For example:
6429 .code
6430 1.2.3.4:           data for 1.2.3.4
6431 192.168.0.0/16:    data for 192.168.0.0/16
6432 "abcd::cdab":      data for abcd::cdab
6433 "abcd:abcd::/32"   data for abcd:abcd::/32
6434 .endd
6435 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6436 file is searched linearly, using the CIDR masks where present, until a matching
6437 key is found. The first key that matches is used; there is no attempt to find a
6438 &"best"& match. Apart from the way the keys are matched, the processing for
6439 &(iplsearch)& is the same as for &(lsearch)&.
6440
6441 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6442 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6443 lookup types support only literal keys.
6444
6445 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6446 the implicit key is the host's IP address rather than its name (see section
6447 &<<SECThoslispatsikey>>&).
6448 .next
6449 .cindex "linear search"
6450 .cindex "lookup" "lsearch"
6451 .cindex "lsearch lookup type"
6452 .cindex "case sensitivity" "in lsearch lookup"
6453 &(lsearch)&: The given file is a text file that is searched linearly for a
6454 line beginning with the search key, terminated by a colon or white space or the
6455 end of the line. The search is case-insensitive; that is, upper and lower case
6456 letters are treated as the same. The first occurrence of the key that is found
6457 in the file is used.
6458
6459 White space between the key and the colon is permitted. The remainder of the
6460 line, with leading and trailing white space removed, is the data. This can be
6461 continued onto subsequent lines by starting them with any amount of white
6462 space, but only a single space character is included in the data at such a
6463 junction. If the data begins with a colon, the key must be terminated by a
6464 colon, for example:
6465 .code
6466 baduser:  :fail:
6467 .endd
6468 Empty lines and lines beginning with # are ignored, even if they occur in the
6469 middle of an item. This is the traditional textual format of alias files. Note
6470 that the keys in an &(lsearch)& file are literal strings. There is no
6471 wildcarding of any kind.
6472
6473 .cindex "lookup" "lsearch &-- colons in keys"
6474 .cindex "white space" "in lsearch key"
6475 In most &(lsearch)& files, keys are not required to contain colons or #
6476 characters, or white space. However, if you need this feature, it is available.
6477 If a key begins with a doublequote character, it is terminated only by a
6478 matching quote (or end of line), and the normal escaping rules apply to its
6479 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6480 quoted keys (exactly as for unquoted keys). There is no special handling of
6481 quotes for the data part of an &(lsearch)& line.
6482
6483 .next
6484 .cindex "NIS lookup type"
6485 .cindex "lookup" "NIS"
6486 .cindex "binary zero" "in lookup key"
6487 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6488 the given key, without a terminating binary zero. There is a variant called
6489 &(nis0)& which does include the terminating binary zero in the key. This is
6490 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6491 aliases; the full map names must be used.
6492
6493 .next
6494 .cindex "wildlsearch lookup type"
6495 .cindex "lookup" "wildlsearch"
6496 .cindex "nwildlsearch lookup type"
6497 .cindex "lookup" "nwildlsearch"
6498 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6499 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6500 the file may be wildcarded. The difference between these two lookup types is
6501 that for &(wildlsearch)&, each key in the file is string-expanded before being
6502 used, whereas for &(nwildlsearch)&, no expansion takes place.
6503
6504 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6505 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6506 file that are regular expressions can be made case-sensitive by the use of
6507 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6508
6509 . ==== As this is a nested list, any displays it contains must be indented
6510 . ==== as otherwise they are too far to the left.
6511
6512 .olist
6513 The string may begin with an asterisk to mean &"ends with"&. For example:
6514 .code
6515     *.a.b.c       data for anything.a.b.c
6516     *fish         data for anythingfish
6517 .endd
6518 .next
6519 The string may begin with a circumflex to indicate a regular expression. For
6520 example, for &(wildlsearch)&:
6521 .code
6522     ^\N\d+\.a\.b\N    data for <digits>.a.b
6523 .endd
6524 Note the use of &`\N`& to disable expansion of the contents of the regular
6525 expression. If you are using &(nwildlsearch)&, where the keys are not
6526 string-expanded, the equivalent entry is:
6527 .code
6528     ^\d+\.a\.b        data for <digits>.a.b
6529 .endd
6530 The case-insensitive flag is set at the start of compiling the regular
6531 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6532 For example, to make the entire pattern case-sensitive:
6533 .code
6534     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6535 .endd
6536
6537 If the regular expression contains white space or colon characters, you must
6538 either quote it (see &(lsearch)& above), or represent these characters in other
6539 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6540 colon. This may be easier than quoting, because if you quote, you have to
6541 escape all the backslashes inside the quotes.
6542
6543 &*Note*&: It is not possible to capture substrings in a regular expression
6544 match for later use, because the results of all lookups are cached. If a lookup
6545 is repeated, the result is taken from the cache, and no actual pattern matching
6546 takes place. The values of all the numeric variables are unset after a
6547 &((n)wildlsearch)& match.
6548
6549 .next
6550 Although I cannot see it being of much use, the general matching function that
6551 is used to implement &((n)wildlsearch)& means that the string may begin with a
6552 lookup name terminated by a semicolon, and followed by lookup data. For
6553 example:
6554 .code
6555     cdb;/some/file  data for keys that match the file
6556 .endd
6557 The data that is obtained from the nested lookup is discarded.
6558 .endlist olist
6559
6560 Keys that do not match any of these patterns are interpreted literally. The
6561 continuation rules for the data are the same as for &(lsearch)&, and keys may
6562 be followed by optional colons.
6563
6564 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6565 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6566 lookup types support only literal keys.
6567 .endlist ilist
6568
6569
6570 .section "Query-style lookup types" "SECID62"
6571 .cindex "lookup" "query-style types"
6572 .cindex "query-style lookup" "list of types"
6573 The supported query-style lookup types are listed below. Further details about
6574 many of them are given in later sections.
6575
6576 .ilist
6577 .cindex "DNS" "as a lookup type"
6578 .cindex "lookup" "DNS"
6579 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6580 are given in the supplied query. The resulting data is the contents of the
6581 records. See section &<<SECTdnsdb>>&.
6582 .next
6583 .cindex "InterBase lookup type"
6584 .cindex "lookup" "InterBase"
6585 &(ibase)&: This does a lookup in an InterBase database.
6586 .next
6587 .cindex "LDAP" "lookup type"
6588 .cindex "lookup" "LDAP"
6589 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6590 returns attributes from a single entry. There is a variant called &(ldapm)&
6591 that permits values from multiple entries to be returned. A third variant
6592 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6593 any attribute values. See section &<<SECTldap>>&.
6594 .next
6595 .cindex "MySQL" "lookup type"
6596 .cindex "lookup" "MySQL"
6597 &(mysql)&: The format of the query is an SQL statement that is passed to a
6598 MySQL database. See section &<<SECTsql>>&.
6599 .next
6600 .cindex "NIS+ lookup type"
6601 .cindex "lookup" "NIS+"
6602 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6603 the field to be returned. See section &<<SECTnisplus>>&.
6604 .next
6605 .cindex "Oracle" "lookup type"
6606 .cindex "lookup" "Oracle"
6607 &(oracle)&: The format of the query is an SQL statement that is passed to an
6608 Oracle database. See section &<<SECTsql>>&.
6609 .next
6610 .cindex "lookup" "passwd"
6611 .cindex "passwd lookup type"
6612 .cindex "&_/etc/passwd_&"
6613 &(passwd)& is a query-style lookup with queries that are just user names. The
6614 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6615 success, the result string is the same as you would get from an &(lsearch)&
6616 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6617 password value. For example:
6618 .code
6619 *:42:42:King Rat:/home/kr:/bin/bash
6620 .endd
6621 .next
6622 .cindex "PostgreSQL lookup type"
6623 .cindex "lookup" "PostgreSQL"
6624 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6625 PostgreSQL database. See section &<<SECTsql>>&.
6626
6627 .next
6628 .new
6629 .cindex "Redis lookup type"
6630 .cindex lookup Redis
6631 &(redis)&: The format of the query is an SQL statement that is passed to a
6632 Redis database. See section &<<SECTsql>>&.
6633 .wen
6634
6635 .next
6636 .cindex "sqlite lookup type"
6637 .cindex "lookup" "sqlite"
6638 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6639 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6640
6641 .next
6642 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6643 not likely to be useful in normal operation.
6644 .next
6645 .cindex "whoson lookup type"
6646 .cindex "lookup" "whoson"
6647 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6648 allows a server to check whether a particular (dynamically allocated) IP
6649 address is currently allocated to a known (trusted) user and, optionally, to
6650 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6651 at one time for &"POP before SMTP"& authentication, but that approach has been
6652 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6653 &"POP before SMTP"& checking using ACL statements such as
6654 .code
6655 require condition = \
6656   ${lookup whoson {$sender_host_address}{yes}{no}}
6657 .endd
6658 The query consists of a single IP address. The value returned is the name of
6659 the authenticated user, which is stored in the variable &$value$&. However, in
6660 this example, the data in &$value$& is not used; the result of the lookup is
6661 one of the fixed strings &"yes"& or &"no"&.
6662 .endlist
6663
6664
6665
6666 .section "Temporary errors in lookups" "SECID63"
6667 .cindex "lookup" "temporary error in"
6668 Lookup functions can return temporary error codes if the lookup cannot be
6669 completed. For example, an SQL or LDAP database might be unavailable. For this
6670 reason, it is not advisable to use a lookup that might do this for critical
6671 options such as a list of local domains.
6672
6673 When a lookup cannot be completed in a router or transport, delivery
6674 of the message (to the relevant address) is deferred, as for any other
6675 temporary error. In other circumstances Exim may assume the lookup has failed,
6676 or may give up altogether.
6677
6678
6679
6680 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6681 .cindex "wildcard lookups"
6682 .cindex "lookup" "default values"
6683 .cindex "lookup" "wildcard"
6684 .cindex "lookup" "* added to type"
6685 .cindex "default" "in single-key lookups"
6686 In this context, a &"default value"& is a value specified by the administrator
6687 that is to be used if a lookup fails.
6688
6689 &*Note:*& This section applies only to single-key lookups. For query-style
6690 lookups, the facilities of the query language must be used. An attempt to
6691 specify a default for a query-style lookup provokes an error.
6692
6693 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6694 and the initial lookup fails, the key &"*"& is looked up in the file to
6695 provide a default value. See also the section on partial matching below.
6696
6697 .cindex "*@ with single-key lookup"
6698 .cindex "lookup" "*@ added to type"
6699 .cindex "alias file" "per-domain default"
6700 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6701 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6702 character, a second lookup is done with everything before the last @ replaced
6703 by *. This makes it possible to provide per-domain defaults in alias files
6704 that include the domains in the keys. If the second lookup fails (or doesn't
6705 take place because there is no @ in the key), &"*"& is looked up.
6706 For example, a &(redirect)& router might contain:
6707 .code
6708 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6709 .endd
6710 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6711 looks up these keys, in this order:
6712 .code
6713 jane@eyre.example
6714 *@eyre.example
6715 *
6716 .endd
6717 The data is taken from whichever key it finds first. &*Note*&: In an
6718 &(lsearch)& file, this does not mean the first of these keys in the file. A
6719 complete scan is done for each key, and only if it is not found at all does
6720 Exim move on to try the next key.
6721
6722
6723
6724 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6725 .cindex "partial matching"
6726 .cindex "wildcard lookups"
6727 .cindex "lookup" "partial matching"
6728 .cindex "lookup" "wildcard"
6729 .cindex "asterisk" "in search type"
6730 The normal operation of a single-key lookup is to search the file for an exact
6731 match with the given key. However, in a number of situations where domains are
6732 being looked up, it is useful to be able to do partial matching. In this case,
6733 information in the file that has a key starting with &"*."& is matched by any
6734 domain that ends with the components that follow the full stop. For example, if
6735 a key in a DBM file is
6736 .code
6737 *.dates.fict.example
6738 .endd
6739 then when partial matching is enabled this is matched by (amongst others)
6740 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6741 by &'dates.fict.example'&, if that does not appear as a separate key in the
6742 file.
6743
6744 &*Note*&: Partial matching is not available for query-style lookups. It is
6745 also not available for any lookup items in address lists (see section
6746 &<<SECTaddresslist>>&).
6747
6748 Partial matching is implemented by doing a series of separate lookups using
6749 keys constructed by modifying the original subject key. This means that it can
6750 be used with any of the single-key lookup types, provided that
6751 partial matching keys
6752 beginning with a special prefix (default &"*."&) are included in the data file.
6753 Keys in the file that do not begin with the prefix are matched only by
6754 unmodified subject keys when partial matching is in use.
6755
6756 Partial matching is requested by adding the string &"partial-"& to the front of
6757 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6758 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6759 is added at the start of the subject key, and it is looked up again. If that
6760 fails, further lookups are tried with dot-separated components removed from the
6761 start of the subject key, one-by-one, and &"*."& added on the front of what
6762 remains.
6763
6764 A minimum number of two non-* components are required. This can be adjusted
6765 by including a number before the hyphen in the search type. For example,
6766 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6767 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6768 subject key is &'2250.dates.fict.example'& then the following keys are looked
6769 up when the minimum number of non-* components is two:
6770 .code
6771 2250.dates.fict.example
6772 *.2250.dates.fict.example
6773 *.dates.fict.example
6774 *.fict.example
6775 .endd
6776 As soon as one key in the sequence is successfully looked up, the lookup
6777 finishes.
6778
6779 .cindex "lookup" "partial matching &-- changing prefix"
6780 .cindex "prefix" "for partial matching"
6781 The use of &"*."& as the partial matching prefix is a default that can be
6782 changed. The motivation for this feature is to allow Exim to operate with file
6783 formats that are used by other MTAs. A different prefix can be supplied in
6784 parentheses instead of the hyphen after &"partial"&. For example:
6785 .code
6786 domains = partial(.)lsearch;/some/file
6787 .endd
6788 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6789 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6790 components is unchanged). The prefix may consist of any punctuation characters
6791 other than a closing parenthesis. It may be empty, for example:
6792 .code
6793 domains = partial1()cdb;/some/file
6794 .endd
6795 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6796 &`a.b.c`&, &`b.c`&, and &`c`&.
6797
6798 If &"partial0"& is specified, what happens at the end (when the lookup with
6799 just one non-wild component has failed, and the original key is shortened right
6800 down to the null string) depends on the prefix:
6801
6802 .ilist
6803 If the prefix has zero length, the whole lookup fails.
6804 .next
6805 If the prefix has length 1, a lookup for just the prefix is done. For
6806 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6807 .next
6808 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6809 remainder is looked up. With the default prefix, therefore, the final lookup is
6810 for &"*"& on its own.
6811 .next
6812 Otherwise, the whole prefix is looked up.
6813 .endlist
6814
6815
6816 If the search type ends in &"*"& or &"*@"& (see section
6817 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6818 this implies happens after all partial lookups have failed. If &"partial0"& is
6819 specified, adding &"*"& to the search type has no effect with the default
6820 prefix, because the &"*"& key is already included in the sequence of partial
6821 lookups. However, there might be a use for lookup types such as
6822 &"partial0(.)lsearch*"&.
6823
6824 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6825 in domain lists and the like. Partial matching works only in terms of
6826 dot-separated components; a key such as &`*fict.example`&
6827 in a database file is useless, because the asterisk in a partial matching
6828 subject key is always followed by a dot.
6829
6830
6831
6832
6833 .section "Lookup caching" "SECID64"
6834 .cindex "lookup" "caching"
6835 .cindex "caching" "lookup data"
6836 Exim caches all lookup results in order to avoid needless repetition of
6837 lookups. However, because (apart from the daemon) Exim operates as a collection
6838 of independent, short-lived processes, this caching applies only within a
6839 single Exim process. There is no inter-process lookup caching facility.
6840
6841 For single-key lookups, Exim keeps the relevant files open in case there is
6842 another lookup that needs them. In some types of configuration this can lead to
6843 many files being kept open for messages with many recipients. To avoid hitting
6844 the operating system limit on the number of simultaneously open files, Exim
6845 closes the least recently used file when it needs to open more files than its
6846 own internal limit, which can be changed via the &%lookup_open_max%& option.
6847
6848 The single-key lookup files are closed and the lookup caches are flushed at
6849 strategic points during delivery &-- for example, after all routing is
6850 complete.
6851
6852
6853
6854
6855 .section "Quoting lookup data" "SECID65"
6856 .cindex "lookup" "quoting"
6857 .cindex "quoting" "in lookups"
6858 When data from an incoming message is included in a query-style lookup, there
6859 is the possibility of special characters in the data messing up the syntax of
6860 the query. For example, a NIS+ query that contains
6861 .code
6862 [name=$local_part]
6863 .endd
6864 will be broken if the local part happens to contain a closing square bracket.
6865 For NIS+, data can be enclosed in double quotes like this:
6866 .code
6867 [name="$local_part"]
6868 .endd
6869 but this still leaves the problem of a double quote in the data. The rule for
6870 NIS+ is that double quotes must be doubled. Other lookup types have different
6871 rules, and to cope with the differing requirements, an expansion operator
6872 of the following form is provided:
6873 .code
6874 ${quote_<lookup-type>:<string>}
6875 .endd
6876 For example, the safest way to write the NIS+ query is
6877 .code
6878 [name="${quote_nisplus:$local_part}"]
6879 .endd
6880 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6881 operator can be used for all lookup types, but has no effect for single-key
6882 lookups, since no quoting is ever needed in their key strings.
6883
6884
6885
6886
6887 .section "More about dnsdb" "SECTdnsdb"
6888 .cindex "dnsdb lookup"
6889 .cindex "lookup" "dnsdb"
6890 .cindex "DNS" "as a lookup type"
6891 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6892 of a record type and a domain name, separated by an equals sign. For example,
6893 an expansion string could contain:
6894 .code
6895 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6896 .endd
6897 If the lookup succeeds, the result is placed in &$value$&, which in this case
6898 is used on its own as the result. If the lookup does not succeed, the
6899 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6900 &<<SECTforexpfai>>& for an explanation of what this means.
6901
6902 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6903 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6904 If no type is given, TXT is assumed.
6905
6906 For any record type, if multiple records are found, the data is returned as a
6907 concatenation, with newline as the default separator. The order, of course,
6908 depends on the DNS resolver. You can specify a different separator character
6909 between multiple records by putting a right angle-bracket followed immediately
6910 by the new separator at the start of the query. For example:
6911 .code
6912 ${lookup dnsdb{>: a=host1.example}}
6913 .endd
6914 It is permitted to specify a space as the separator character. Further
6915 white space is ignored.
6916 For lookup types that return multiple fields per record,
6917 an alternate field separator can be specified using a comma after the main
6918 separator character, followed immediately by the field separator.
6919
6920 .cindex "PTR record" "in &(dnsdb)& lookup"
6921 When the type is PTR,
6922 the data can be an IP address, written as normal; inversion and the addition of
6923 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6924 .code
6925 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6926 .endd
6927 If the data for a PTR record is not a syntactically valid IP address, it is not
6928 altered and nothing is added.
6929
6930 .cindex "MX record" "in &(dnsdb)& lookup"
6931 .cindex "SRV record" "in &(dnsdb)& lookup"
6932 For an MX lookup, both the preference value and the host name are returned for
6933 each record, separated by a space. For an SRV lookup, the priority, weight,
6934 port, and host name are returned for each record, separated by spaces.
6935 The field separator can be modified as above.
6936
6937 .cindex "TXT record" "in &(dnsdb)& lookup"
6938 .cindex "SPF record" "in &(dnsdb)& lookup"
6939 For TXT records with multiple items of data, only the first item is returned,
6940 unless a field separator is specified.
6941 To concatenate items without a separator, use a semicolon instead.
6942 For SPF records the
6943 default behaviour is to concatenate multiple items without using a separator.
6944 .code
6945 ${lookup dnsdb{>\n,: txt=a.b.example}}
6946 ${lookup dnsdb{>\n; txt=a.b.example}}
6947 ${lookup dnsdb{spf=example.org}}
6948 .endd
6949 It is permitted to specify a space as the separator character. Further
6950 white space is ignored.
6951
6952 .cindex "SOA record" "in &(dnsdb)& lookup"
6953 For an SOA lookup, while no result is obtained the lookup is redone with
6954 successively more leading components dropped from the given domain.
6955 Only the primary-nameserver field is returned unless a field separator is
6956 specified.
6957 .code
6958 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6959 .endd
6960
6961 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6962 .cindex "dnsdb modifiers"
6963 .cindex "modifiers" "dnsdb"
6964 .cindex "options" "dnsdb"
6965 Modifiers for &(dnsdb)& lookups are given by optional keywords,
6966 each followed by a comma,
6967 that may appear before the record type.
6968
6969 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6970 temporary DNS error for any of them, the behaviour is controlled by
6971 a defer-option modifier.
6972 The possible keywords are
6973 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6974 With &"strict"& behaviour, any temporary DNS error causes the
6975 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6976 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6977 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6978 error causes the whole lookup to defer only if none of the other lookups
6979 succeed. The default is &"lax"&, so the following lookups are equivalent:
6980 .code
6981 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6982 ${lookup dnsdb{a=one.host.com:two.host.com}}
6983 .endd
6984 Thus, in the default case, as long as at least one of the DNS lookups
6985 yields some data, the lookup succeeds.
6986
6987 .cindex "DNSSEC" "dns lookup"
6988 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6989 The possible keywords are
6990 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6991 With &"strict"& or &"lax"& DNSSEC information is requested
6992 with the lookup.
6993 With &"strict"& a response from the DNS resolver that
6994 is not labelled as authenticated data
6995 is treated as equivalent to a temporary DNS error.
6996 The default is &"never"&.
6997
6998 See also the &$lookup_dnssec_authenticated$& variable.
6999
7000 .cindex timeout "dns lookup"
7001 .cindex "DNS" timeout
7002 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7003 The form is &"retrans_VAL"& where VAL is an Exim time specification
7004 (e.g. &"5s"&).
7005 The default value is set by the main configuration option &%dns_retrans%&.
7006
7007 Retries for the dnsdb lookup can be controlled by a retry modifier.
7008 The form if &"retry_VAL"& where VAL is an integer.
7009 The default count is set by the main configuration option &%dns_retry%&.
7010
7011 .new
7012 .cindex cacheing "of dns lookup"
7013 .cindex TTL "of dns lookup"
7014 .cindex DNS TTL
7015 Dnsdb lookup results are cached within a single process (and its children).
7016 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7017 value of the set of returned DNS records.
7018 .wen
7019
7020
7021 .section "Pseudo dnsdb record types" "SECID66"
7022 .cindex "MX record" "in &(dnsdb)& lookup"
7023 By default, both the preference value and the host name are returned for
7024 each MX record, separated by a space. If you want only host names, you can use
7025 the pseudo-type MXH:
7026 .code
7027 ${lookup dnsdb{mxh=a.b.example}}
7028 .endd
7029 In this case, the preference values are omitted, and just the host names are
7030 returned.
7031
7032 .cindex "name server for enclosing domain"
7033 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7034 records on the given domain, but if none are found, it removes the first
7035 component of the domain name, and tries again. This process continues until NS
7036 records are found or there are no more components left (or there is a DNS
7037 error). In other words, it may return the name servers for a top-level domain,
7038 but it never returns the root name servers. If there are no NS records for the
7039 top-level domain, the lookup fails. Consider these examples:
7040 .code
7041 ${lookup dnsdb{zns=xxx.quercite.com}}
7042 ${lookup dnsdb{zns=xxx.edu}}
7043 .endd
7044 Assuming that in each case there are no NS records for the full domain name,
7045 the first returns the name servers for &%quercite.com%&, and the second returns
7046 the name servers for &%edu%&.
7047
7048 You should be careful about how you use this lookup because, unless the
7049 top-level domain does not exist, the lookup always returns some host names. The
7050 sort of use to which this might be put is for seeing if the name servers for a
7051 given domain are on a blacklist. You can probably assume that the name servers
7052 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7053 such a list.
7054
7055 .cindex "CSA" "in &(dnsdb)& lookup"
7056 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7057 records according to the CSA rules, which are described in section
7058 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7059 not sufficient because of the extra parent domain search behaviour of CSA. The
7060 result of a successful lookup such as:
7061 .code
7062 ${lookup dnsdb {csa=$sender_helo_name}}
7063 .endd
7064 has two space-separated fields: an authorization code and a target host name.
7065 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7066 authorization required but absent, or &"?"& for unknown.
7067
7068 .cindex "A+" "in &(dnsdb)& lookup"
7069 The pseudo-type A+ performs an AAAA
7070 and then an A lookup.  All results are returned; defer processing
7071 (see below) is handled separately for each lookup.  Example:
7072 .code
7073 ${lookup dnsdb {>; a+=$sender_helo_name}}
7074 .endd
7075
7076
7077 .section "Multiple dnsdb lookups" "SECID67"
7078 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7079 However, you can specify a list of domains or IP addresses in a single
7080 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7081 the default separator, but with the ability to change this. For example:
7082 .code
7083 ${lookup dnsdb{one.domain.com:two.domain.com}}
7084 ${lookup dnsdb{a=one.host.com:two.host.com}}
7085 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7086 .endd
7087 In order to retain backwards compatibility, there is one special case: if
7088 the lookup type is PTR and no change of separator is specified, Exim looks
7089 to see if the rest of the string is precisely one IPv6 address. In this
7090 case, it does not treat it as a list.
7091
7092 The data from each lookup is concatenated, with newline separators by default,
7093 in the same way that multiple DNS records for a single item are handled. A
7094 different separator can be specified, as described above.
7095
7096
7097
7098
7099 .section "More about LDAP" "SECTldap"
7100 .cindex "LDAP" "lookup, more about"
7101 .cindex "lookup" "LDAP"
7102 .cindex "Solaris" "LDAP"
7103 The original LDAP implementation came from the University of Michigan; this has
7104 become &"Open LDAP"&, and there are now two different releases. Another
7105 implementation comes from Netscape, and Solaris 7 and subsequent releases
7106 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7107 the lookup function level, their error handling is different. For this reason
7108 it is necessary to set a compile-time variable when building Exim with LDAP, to
7109 indicate which LDAP library is in use. One of the following should appear in
7110 your &_Local/Makefile_&:
7111 .code
7112 LDAP_LIB_TYPE=UMICHIGAN
7113 LDAP_LIB_TYPE=OPENLDAP1
7114 LDAP_LIB_TYPE=OPENLDAP2
7115 LDAP_LIB_TYPE=NETSCAPE
7116 LDAP_LIB_TYPE=SOLARIS
7117 .endd
7118 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7119 same interface as the University of Michigan version.
7120
7121 There are three LDAP lookup types in Exim. These behave slightly differently in
7122 the way they handle the results of a query:
7123
7124 .ilist
7125 &(ldap)& requires the result to contain just one entry; if there are more, it
7126 gives an error.
7127 .next
7128 &(ldapdn)& also requires the result to contain just one entry, but it is the
7129 Distinguished Name that is returned rather than any attribute values.
7130 .next
7131 &(ldapm)& permits the result to contain more than one entry; the attributes
7132 from all of them are returned.
7133 .endlist
7134
7135
7136 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7137 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7138 the data returned by a successful lookup is described in the next section.
7139 First we explain how LDAP queries are coded.
7140
7141
7142 .section "Format of LDAP queries" "SECTforldaque"
7143 .cindex "LDAP" "query format"
7144 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7145 the configuration of a &(redirect)& router one might have this setting:
7146 .code
7147 data = ${lookup ldap \
7148   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7149   c=UK?mailbox?base?}}
7150 .endd
7151 .cindex "LDAP" "with TLS"
7152 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7153 secure (encrypted) LDAP connections. The second of these ensures that an
7154 encrypted TLS connection is used.
7155
7156 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7157 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7158 See the &%ldap_start_tls%& option.
7159
7160 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7161 controlled. Every part of the TLS configuration can be configured by settings in
7162 &_exim.conf_&. Depending on the version of the client libraries installed on
7163 your system, some of the initialization may have required setting options in
7164 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7165 certificates. This revealed a nuance where the current UID that exim was
7166 running as could affect which config files it read. With Exim 4.83, these
7167 methods become optional, only taking effect if not specifically set in
7168 &_exim.conf_&.
7169
7170
7171 .section "LDAP quoting" "SECID68"
7172 .cindex "LDAP" "quoting"
7173 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7174 and the second because the LDAP query is represented as a URL. Furthermore,
7175 within an LDAP query, two different kinds of quoting are required. For this
7176 reason, there are two different LDAP-specific quoting operators.
7177
7178 The &%quote_ldap%& operator is designed for use on strings that are part of
7179 filter specifications. Conceptually, it first does the following conversions on
7180 the string:
7181 .code
7182 *   =>   \2A
7183 (   =>   \28
7184 )   =>   \29
7185 \   =>   \5C
7186 .endd
7187 in accordance with RFC 2254. The resulting string is then quoted according
7188 to the rules for URLs, that is, all non-alphanumeric characters except
7189 .code
7190 ! $ ' - . _ ( ) * +
7191 .endd
7192 are converted to their hex values, preceded by a percent sign. For example:
7193 .code
7194 ${quote_ldap: a(bc)*, a<yz>; }
7195 .endd
7196 yields
7197 .code
7198 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7199 .endd
7200 Removing the URL quoting, this is (with a leading and a trailing space):
7201 .code
7202 a\28bc\29\2A, a<yz>;
7203 .endd
7204 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7205 base DN specifications in queries. Conceptually, it first converts the string
7206 by inserting a backslash in front of any of the following characters:
7207 .code
7208 , + " \ < > ;
7209 .endd
7210 It also inserts a backslash before any leading spaces or # characters, and
7211 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7212 is then quoted according to the rules for URLs. For example:
7213 .code
7214 ${quote_ldap_dn: a(bc)*, a<yz>; }
7215 .endd
7216 yields
7217 .code
7218 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7219 .endd
7220 Removing the URL quoting, this is (with a trailing space):
7221 .code
7222 \ a(bc)*\, a\<yz\>\;\
7223 .endd
7224 There are some further comments about quoting in the section on LDAP
7225 authentication below.
7226
7227
7228 .section "LDAP connections" "SECID69"
7229 .cindex "LDAP" "connections"
7230 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7231 is in use, via a Unix domain socket. The example given above does not specify
7232 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7233 by starting it with
7234 .code
7235 ldap://<hostname>:<port>/...
7236 .endd
7237 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7238 used. When no server is specified in a query, a list of default servers is
7239 taken from the &%ldap_default_servers%& configuration option. This supplies a
7240 colon-separated list of servers which are tried in turn until one successfully
7241 handles a query, or there is a serious error. Successful handling either
7242 returns the requested data, or indicates that it does not exist. Serious errors
7243 are syntactical, or multiple values when only a single value is expected.
7244 Errors which cause the next server to be tried are connection failures, bind
7245 failures, and timeouts.
7246
7247 For each server name in the list, a port number can be given. The standard way
7248 of specifying a host and port is to use a colon separator (RFC 1738). Because
7249 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7250 doubled. For example
7251 .code
7252 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7253 .endd
7254 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7255 to the LDAP library with no server name, and the library's default (normally
7256 the local host) is used.
7257
7258 If you are using the OpenLDAP library, you can connect to an LDAP server using
7259 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7260 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7261 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7262 not available.
7263
7264 For this type of connection, instead of a host name for the server, a pathname
7265 for the socket is required, and the port number is not relevant. The pathname
7266 can be specified either as an item in &%ldap_default_servers%&, or inline in
7267 the query. In the former case, you can have settings such as
7268 .code
7269 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7270 .endd
7271 When the pathname is given in the query, you have to escape the slashes as
7272 &`%2F`& to fit in with the LDAP URL syntax. For example:
7273 .code
7274 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7275 .endd
7276 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7277 a pathname, it uses the Unix domain socket code, even if the query actually
7278 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7279 socket connection. This behaviour means that you can use a setting of
7280 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7281 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7282 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7283 backup host.
7284
7285 If an explicit &`ldapi`& type is given in a query when a host name is
7286 specified, an error is diagnosed. However, if there are more items in
7287 &%ldap_default_servers%&, they are tried. In other words:
7288
7289 .ilist
7290 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7291 interface.
7292 .next
7293 Using &`ldapi`& with a host name causes an error.
7294 .endlist
7295
7296
7297 Using &`ldapi`& with no host or path in the query, and no setting of
7298 &%ldap_default_servers%&, does whatever the library does by default.
7299
7300
7301
7302 .section "LDAP authentication and control information" "SECID70"
7303 .cindex "LDAP" "authentication"
7304 The LDAP URL syntax provides no way of passing authentication and other control
7305 information to the server. To make this possible, the URL in an LDAP query may
7306 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7307 spaces. If a value contains spaces it must be enclosed in double quotes, and
7308 when double quotes are used, backslash is interpreted in the usual way inside
7309 them. The following names are recognized:
7310 .display
7311 &`DEREFERENCE`&  set the dereferencing parameter
7312 &`NETTIME    `&  set a timeout for a network operation
7313 &`USER       `&  set the DN, for authenticating the LDAP bind
7314 &`PASS       `&  set the password, likewise
7315 &`REFERRALS  `&  set the referrals parameter
7316 &`SERVERS    `&  set alternate server list for this query only
7317 &`SIZE       `&  set the limit for the number of entries returned
7318 &`TIME       `&  set the maximum waiting time for a query
7319 .endd
7320 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7321 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7322 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7323 library from trying to follow referrals issued by the LDAP server.
7324
7325 .cindex LDAP timeout
7326 .cindex timeout "LDAP lookup"
7327 The name CONNECT is an obsolete name for NETTIME, retained for
7328 backwards compatibility. This timeout (specified as a number of seconds) is
7329 enforced from the client end for operations that can be carried out over a
7330 network. Specifically, it applies to network connections and calls to the
7331 &'ldap_result()'& function. If the value is greater than zero, it is used if
7332 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7333 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7334 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7335 Netscape SDK; for OpenLDAP no action is taken.
7336
7337 The TIME parameter (also a number of seconds) is passed to the server to
7338 set a server-side limit on the time taken to complete a search.
7339
7340 The SERVERS parameter allows you to specify an alternate list of ldap servers
7341 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7342 default list of ldap servers, and a single lookup can specify a single ldap
7343 server to use.  But when you need to do a lookup with a list of servers that is
7344 different than the default list (maybe different order, maybe a completely
7345 different set of servers), the SERVERS parameter allows you to specify this
7346 alternate list (colon-separated).
7347
7348 Here is an example of an LDAP query in an Exim lookup that uses some of these
7349 values. This is a single line, folded to fit on the page:
7350 .code
7351 ${lookup ldap
7352   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7353   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7354   {$value}fail}
7355 .endd
7356 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7357 any of the auxiliary data. Exim configuration settings that include lookups
7358 which contain password information should be preceded by &"hide"& to prevent
7359 non-admin users from using the &%-bP%& option to see their values.
7360
7361 The auxiliary data items may be given in any order. The default is no
7362 connection timeout (the system timeout is used), no user or password, no limit
7363 on the number of entries returned, and no time limit on queries.
7364
7365 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7366 removes any URL quoting that it may contain before passing it LDAP. Apparently
7367 some libraries do this for themselves, but some do not. Removing the URL
7368 quoting has two advantages:
7369
7370 .ilist
7371 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7372 DNs as with DNs inside actual queries.
7373 .next
7374 It permits spaces inside USER= DNs.
7375 .endlist
7376
7377 For example, a setting such as
7378 .code
7379 USER=cn=${quote_ldap_dn:$1}
7380 .endd
7381 should work even if &$1$& contains spaces.
7382
7383 Expanded data for the PASS= value should be quoted using the &%quote%&
7384 expansion operator, rather than the LDAP quote operators. The only reason this
7385 field needs quoting is to ensure that it conforms to the Exim syntax, which
7386 does not allow unquoted spaces. For example:
7387 .code
7388 PASS=${quote:$3}
7389 .endd
7390 The LDAP authentication mechanism can be used to check passwords as part of
7391 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7392 &<<CHAPexpand>>&.
7393
7394
7395
7396 .section "Format of data returned by LDAP" "SECID71"
7397 .cindex "LDAP" "returned data formats"
7398 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7399 as a sequence of values, for example
7400 .code
7401 cn=manager,o=University of Cambridge,c=UK
7402 .endd
7403 The &(ldap)& lookup type generates an error if more than one entry matches the
7404 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7405 the result between the data from different entries. It is possible for multiple
7406 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7407 you know that whatever values are returned all came from a single entry in the
7408 directory.
7409
7410 In the common case where you specify a single attribute in your LDAP query, the
7411 result is not quoted, and does not contain the attribute name. If the attribute
7412 has multiple values, they are separated by commas. Any comma that is
7413 part of an attribute's value is doubled.
7414
7415 If you specify multiple attributes, the result contains space-separated, quoted
7416 strings, each preceded by the attribute name and an equals sign. Within the
7417 quotes, the quote character, backslash, and newline are escaped with
7418 backslashes, and commas are used to separate multiple values for the attribute.
7419 Any commas in attribute values are doubled
7420 (permitting treatment of the values as a comma-separated list).
7421 Apart from the escaping, the string within quotes takes the same form as the
7422 output when a single attribute is requested. Specifying no attributes is the
7423 same as specifying all of an entry's attributes.
7424
7425 Here are some examples of the output format. The first line of each pair is an
7426 LDAP query, and the second is the data that is returned. The attribute called
7427 &%attr1%& has two values, one of them with an embedded comma, whereas
7428 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7429 (they have SUP &%attr%& in their schema definitions).
7430
7431 .code
7432 ldap:///o=base?attr1?sub?(uid=fred)
7433 value1.1,value1,,2
7434
7435 ldap:///o=base?attr2?sub?(uid=fred)
7436 value two
7437
7438 ldap:///o=base?attr?sub?(uid=fred)
7439 value1.1,value1,,2,value two
7440
7441 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7442 attr1="value1.1,value1,,2" attr2="value two"
7443
7444 ldap:///o=base??sub?(uid=fred)
7445 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7446 .endd
7447 You can
7448 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7449 results of LDAP lookups.
7450 The &%extract%& operator in string expansions can be used to pick out
7451 individual fields from data that consists of &'key'&=&'value'& pairs.
7452 The &%listextract%& operator should be used to pick out individual values
7453 of attributes, even when only a single value is expected.
7454 The doubling of embedded commas allows you to use the returned data as a
7455 comma separated list (using the "<," syntax for changing the input list separator).
7456
7457
7458
7459
7460 .section "More about NIS+" "SECTnisplus"
7461 .cindex "NIS+ lookup type"
7462 .cindex "lookup" "NIS+"
7463 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7464 and field name. If this is given, the result of a successful query is the
7465 contents of the named field; otherwise the result consists of a concatenation
7466 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7467 values containing spaces are quoted. For example, the query
7468 .code
7469 [name=mg1456],passwd.org_dir
7470 .endd
7471 might return the string
7472 .code
7473 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7474 home=/home/mg1456 shell=/bin/bash shadow=""
7475 .endd
7476 (split over two lines here to fit on the page), whereas
7477 .code
7478 [name=mg1456],passwd.org_dir:gcos
7479 .endd
7480 would just return
7481 .code
7482 Martin Guerre
7483 .endd
7484 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7485 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7486 operator is to double any quote characters within the text.
7487
7488
7489
7490 .section "SQL lookups" "SECTsql"
7491 .cindex "SQL lookup types"
7492 .cindex "MySQL" "lookup type"
7493 .cindex "PostgreSQL lookup type"
7494 .cindex "lookup" "MySQL"
7495 .cindex "lookup" "PostgreSQL"
7496 .cindex "Oracle" "lookup type"
7497 .cindex "lookup" "Oracle"
7498 .cindex "InterBase lookup type"
7499 .cindex "lookup" "InterBase"
7500 .cindex "Redis lookup type"
7501 .cindex lookup Redis
7502 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7503 and SQLite
7504 databases. Queries for these databases contain SQL statements, so an example
7505 might be
7506 .code
7507 ${lookup mysql{select mailbox from users where id='userx'}\
7508   {$value}fail}
7509 .endd
7510 If the result of the query contains more than one field, the data for each
7511 field in the row is returned, preceded by its name, so the result of
7512 .code
7513 ${lookup pgsql{select home,name from users where id='userx'}\
7514   {$value}}
7515 .endd
7516 might be
7517 .code
7518 home=/home/userx name="Mister X"
7519 .endd
7520 Empty values and values containing spaces are double quoted, with embedded
7521 quotes escaped by a backslash. If the result of the query contains just one
7522 field, the value is passed back verbatim, without a field name, for example:
7523 .code
7524 Mister X
7525 .endd
7526 If the result of the query yields more than one row, it is all concatenated,
7527 with a newline between the data for each row.
7528
7529
7530 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7531 .cindex "MySQL" "lookup type"
7532 .cindex "PostgreSQL lookup type"
7533 .cindex "lookup" "MySQL"
7534 .cindex "lookup" "PostgreSQL"
7535 .cindex "Oracle" "lookup type"
7536 .cindex "lookup" "Oracle"
7537 .cindex "InterBase lookup type"
7538 .cindex "lookup" "InterBase"
7539 .cindex "Redis lookup type"
7540 .cindex lookup Redis
7541 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7542 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7543 or &%redis_servers%&
7544 option (as appropriate) must be set to a colon-separated list of server
7545 information.
7546 (For MySQL and PostgreSQL, the global option need not be set if all
7547 queries contain their own server information &-- see section
7548 &<<SECTspeserque>>&.)
7549 For all but Redis
7550 each item in the list is a slash-separated list of four
7551 items: host name, database name, user name, and password. In the case of
7552 Oracle, the host name field is used for the &"service name"&, and the database
7553 name field is not used and should be empty. For example:
7554 .code
7555 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7556 .endd
7557 Because password data is sensitive, you should always precede the setting with
7558 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7559 option. Here is an example where two MySQL servers are listed:
7560 .code
7561 hide mysql_servers = localhost/users/root/secret:\
7562                      otherhost/users/root/othersecret
7563 .endd
7564 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7565 because this is a colon-separated list, the colon has to be doubled. For each
7566 query, these parameter groups are tried in order until a connection is made and
7567 a query is successfully processed. The result of a query may be that no data is
7568 found, but that is still a successful query. In other words, the list of
7569 servers provides a backup facility, not a list of different places to look.
7570
7571 .new
7572 For Redis the global option need not be specified if all queries contain their
7573 own server information &-- see section &<<SECTspeserque>>&.
7574 If specified, the option must be set to a colon-separated list of server
7575 information.
7576 Each item in the list is a slash-separated list of three items:
7577 host, database number, and password.
7578 .olist
7579 The host is required and may be either an IPv4 address and optional
7580 port number (separated by a colon, which needs doubling due to the
7581 higher-level list), or a Unix socket pathname enclosed in parentheses
7582 .next
7583 The database number is optional; if present that number is selected in the backend
7584 .next
7585 The password is optional; if present it is used to authenticate to the backend
7586 .endlist
7587 .wen
7588
7589 .new
7590 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7591 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7592 respectively, and the characters single-quote, double-quote, and backslash
7593 itself are escaped with backslashes.
7594
7595 The &%quote_redis%& expansion operator
7596 escapes whitespace and backslash characters with a backslash.
7597 .wen
7598
7599 .section "Specifying the server in the query" "SECTspeserque"
7600 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7601 it is possible to specify a list of servers with an individual query. This is
7602 done by starting the query with
7603 .display
7604 &`servers=`&&'server1:server2:server3:...'&&`;`&
7605 .endd
7606 Each item in the list may take one of two forms:
7607 .olist
7608 If it contains no slashes it is assumed to be just a host name. The appropriate
7609 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7610 of the same name, and the remaining parameters (database, user, password) are
7611 taken from there.
7612 .next
7613 If it contains any slashes, it is taken as a complete parameter set.
7614 .endlist
7615 The list of servers is used in exactly the same way as the global list.
7616 Once a connection to a server has happened and a query has been
7617 successfully executed, processing of the lookup ceases.
7618
7619 This feature is intended for use in master/slave situations where updates
7620 are occurring and you want to update the master rather than a slave. If the
7621 master is in the list as a backup for reading, you might have a global setting
7622 like this:
7623 .code
7624 mysql_servers = slave1/db/name/pw:\
7625                 slave2/db/name/pw:\
7626                 master/db/name/pw
7627 .endd
7628 In an updating lookup, you could then write:
7629 .code
7630 ${lookup mysql{servers=master; UPDATE ...} }
7631 .endd
7632 That query would then be sent only to the master server. If, on the other hand,
7633 the master is not to be used for reading, and so is not present in the global
7634 option, you can still update it by a query of this form:
7635 .code
7636 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7637 .endd
7638
7639
7640 .section "Special MySQL features" "SECID73"
7641 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7642 causes a connection to the server on the local host by means of a Unix domain
7643 socket. An alternate socket can be specified in parentheses.
7644 .new
7645 An option group name for MySQL option files can be specified in square brackets;
7646 the default value is &"exim"&.
7647 .wen
7648 The full syntax of each item in &%mysql_servers%& is:
7649 .display
7650 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7651   <&'database'&>/<&'user'&>/<&'password'&>
7652 .endd
7653 Any of the four sub-parts of the first field can be omitted. For normal use on
7654 the local host it can be left blank or set to just &"localhost"&.
7655
7656 No database need be supplied &-- but if it is absent here, it must be given in
7657 the queries.
7658
7659 If a MySQL query is issued that does not request any data (an insert, update,
7660 or delete command), the result of the lookup is the number of rows affected.
7661
7662 &*Warning*&: This can be misleading. If an update does not actually change
7663 anything (for example, setting a field to the value it already has), the result
7664 is zero because no rows are affected.
7665
7666
7667 .section "Special PostgreSQL features" "SECID74"
7668 PostgreSQL lookups can also use Unix domain socket connections to the database.
7669 This is usually faster and costs less CPU time than a TCP/IP connection.
7670 However it can be used only if the mail server runs on the same machine as the
7671 database server. A configuration line for PostgreSQL via Unix domain sockets
7672 looks like this:
7673 .code
7674 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7675 .endd
7676 In other words, instead of supplying a host name, a path to the socket is
7677 given. The path name is enclosed in parentheses so that its slashes aren't
7678 visually confused with the delimiters for the other server parameters.
7679
7680 If a PostgreSQL query is issued that does not request any data (an insert,
7681 update, or delete command), the result of the lookup is the number of rows
7682 affected.
7683
7684 .section "More about SQLite" "SECTsqlite"
7685 .cindex "lookup" "SQLite"
7686 .cindex "sqlite lookup type"
7687 SQLite is different to the other SQL lookups because a file name is required in
7688 addition to the SQL query. An SQLite database is a single file, and there is no
7689 daemon as in the other SQL databases. The interface to Exim requires the name
7690 of the file, as an absolute path, to be given at the start of the query. It is
7691 separated from the query by white space. This means that the path name cannot
7692 contain white space. Here is a lookup expansion example:
7693 .code
7694 ${lookup sqlite {/some/thing/sqlitedb \
7695   select name from aliases where id='userx';}}
7696 .endd
7697 In a list, the syntax is similar. For example:
7698 .code
7699 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7700    select * from relays where ip='$sender_host_address';
7701 .endd
7702 The only character affected by the &%quote_sqlite%& operator is a single
7703 quote, which it doubles.
7704
7705 .cindex timeout SQLite
7706 .cindex sqlite "lookup timeout"
7707 The SQLite library handles multiple simultaneous accesses to the database
7708 internally. Multiple readers are permitted, but only one process can
7709 update at once. Attempts to access the database while it is being updated
7710 are rejected after a timeout period, during which the SQLite library
7711 waits for the lock to be released. In Exim, the default timeout is set
7712 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7713 option.
7714 .ecindex IIDfidalo1
7715 .ecindex IIDfidalo2
7716
7717
7718 . ////////////////////////////////////////////////////////////////////////////
7719 . ////////////////////////////////////////////////////////////////////////////
7720
7721 .chapter "Domain, host, address, and local part lists" &&&
7722          "CHAPdomhosaddlists" &&&
7723          "Domain, host, and address lists"
7724 .scindex IIDdohoadli "lists of domains; hosts; etc."
7725 A number of Exim configuration options contain lists of domains, hosts,
7726 email addresses, or local parts. For example, the &%hold_domains%& option
7727 contains a list of domains whose delivery is currently suspended. These lists
7728 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7729 arguments to expansion conditions such as &%match_domain%&.
7730
7731 Each item in one of these lists is a pattern to be matched against a domain,
7732 host, email address, or local part, respectively. In the sections below, the
7733 different types of pattern for each case are described, but first we cover some
7734 general facilities that apply to all four kinds of list.
7735
7736 Note that other parts of Exim use a &'string list'& which does not
7737 support all the complexity available in
7738 domain, host, address and local part lists.
7739
7740
7741
7742 .section "Expansion of lists" "SECID75"
7743 .cindex "expansion" "of lists"
7744 Each list is expanded as a single string before it is used. The result of
7745 expansion must be a list, possibly containing empty items, which is split up
7746 into separate items for matching. By default, colon is the separator character,
7747 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7748 &<<SECTempitelis>>& for details of the list syntax; the second of these
7749 discusses the way to specify empty list items.
7750
7751
7752 If the string expansion is forced to fail, Exim behaves as if the item it is
7753 testing (domain, host, address, or local part) is not in the list. Other
7754 expansion failures cause temporary errors.
7755
7756 If an item in a list is a regular expression, backslashes, dollars and possibly
7757 other special characters in the expression must be protected against
7758 misinterpretation by the string expander. The easiest way to do this is to use
7759 the &`\N`& expansion feature to indicate that the contents of the regular
7760 expression should not be expanded. For example, in an ACL you might have:
7761 .code
7762 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7763                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7764 .endd
7765 The first item is a regular expression that is protected from expansion by
7766 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7767 senders based on the receiving domain.
7768
7769
7770
7771
7772 .section "Negated items in lists" "SECID76"
7773 .cindex "list" "negation"
7774 .cindex "negation" "in lists"
7775 Items in a list may be positive or negative. Negative items are indicated by a
7776 leading exclamation mark, which may be followed by optional white space. A list
7777 defines a set of items (domains, etc). When Exim processes one of these lists,
7778 it is trying to find out whether a domain, host, address, or local part
7779 (respectively) is in the set that is defined by the list. It works like this:
7780
7781 The list is scanned from left to right. If a positive item is matched, the
7782 subject that is being checked is in the set; if a negative item is matched, the
7783 subject is not in the set. If the end of the list is reached without the
7784 subject having matched any of the patterns, it is in the set if the last item
7785 was a negative one, but not if it was a positive one. For example, the list in
7786 .code
7787 domainlist relay_to_domains = !a.b.c : *.b.c
7788 .endd
7789 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7790 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7791 list is positive. However, if the setting were
7792 .code
7793 domainlist relay_to_domains = !a.b.c
7794 .endd
7795 then all domains other than &'a.b.c'& would match because the last item in the
7796 list is negative. In other words, a list that ends with a negative item behaves
7797 as if it had an extra item &`:*`& on the end.
7798
7799 Another way of thinking about positive and negative items in lists is to read
7800 the connector as &"or"& after a positive item and as &"and"& after a negative
7801 item.
7802
7803
7804
7805 .section "File names in lists" "SECTfilnamlis"
7806 .cindex "list" "file name in"
7807 If an item in a domain, host, address, or local part list is an absolute file
7808 name (beginning with a slash character), each line of the file is read and
7809 processed as if it were an independent item in the list, except that further
7810 file names are not allowed,
7811 and no expansion of the data from the file takes place.
7812 Empty lines in the file are ignored, and the file may also contain comment
7813 lines:
7814
7815 .ilist
7816 For domain and host lists, if a # character appears anywhere in a line of the
7817 file, it and all following characters are ignored.
7818 .next
7819 Because local parts may legitimately contain # characters, a comment in an
7820 address list or local part list file is recognized only if # is preceded by
7821 white space or the start of the line. For example:
7822 .code
7823 not#comment@x.y.z   # but this is a comment
7824 .endd
7825 .endlist
7826
7827 Putting a file name in a list has the same effect as inserting each line of the
7828 file as an item in the list (blank lines and comments excepted). However, there
7829 is one important difference: the file is read each time the list is processed,
7830 so if its contents vary over time, Exim's behaviour changes.
7831
7832 If a file name is preceded by an exclamation mark, the sense of any match
7833 within the file is inverted. For example, if
7834 .code
7835 hold_domains = !/etc/nohold-domains
7836 .endd
7837 and the file contains the lines
7838 .code
7839 !a.b.c
7840 *.b.c
7841 .endd
7842 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7843 any domain matching &`*.b.c`& is not.
7844
7845
7846
7847 .section "An lsearch file is not an out-of-line list" "SECID77"
7848 As will be described in the sections that follow, lookups can be used in lists
7849 to provide indexed methods of checking list membership. There has been some
7850 confusion about the way &(lsearch)& lookups work in lists. Because
7851 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7852 sometimes thought that it is allowed to contain wild cards and other kinds of
7853 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7854 always fixed strings, just as for any other single-key lookup type.
7855
7856 If you want to use a file to contain wild-card patterns that form part of a
7857 list, just give the file name on its own, without a search type, as described
7858 in the previous section. You could also use the &(wildlsearch)& or
7859 &(nwildlsearch)&, but there is no advantage in doing this.
7860
7861
7862
7863
7864 .section "Named lists" "SECTnamedlists"
7865 .cindex "named lists"
7866 .cindex "list" "named"
7867 A list of domains, hosts, email addresses, or local parts can be given a name
7868 which is then used to refer to the list elsewhere in the configuration. This is
7869 particularly convenient if the same list is required in several different
7870 places. It also allows lists to be given meaningful names, which can improve
7871 the readability of the configuration. For example, it is conventional to define
7872 a domain list called &'local_domains'& for all the domains that are handled
7873 locally on a host, using a configuration line such as
7874 .code
7875 domainlist local_domains = localhost:my.dom.example
7876 .endd
7877 Named lists are referenced by giving their name preceded by a plus sign, so,
7878 for example, a router that is intended to handle local domains would be
7879 configured with the line
7880 .code
7881 domains = +local_domains
7882 .endd
7883 The first router in a configuration is often one that handles all domains
7884 except the local ones, using a configuration with a negated item like this:
7885 .code
7886 dnslookup:
7887   driver = dnslookup
7888   domains = ! +local_domains
7889   transport = remote_smtp
7890   no_more
7891 .endd
7892 The four kinds of named list are created by configuration lines starting with
7893 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7894 respectively. Then there follows the name that you are defining, followed by an
7895 equals sign and the list itself. For example:
7896 .code
7897 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7898 addresslist bad_senders = cdb;/etc/badsenders
7899 .endd
7900 A named list may refer to other named lists:
7901 .code
7902 domainlist  dom1 = first.example : second.example
7903 domainlist  dom2 = +dom1 : third.example
7904 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7905 .endd
7906 &*Warning*&: If the last item in a referenced list is a negative one, the
7907 effect may not be what you intended, because the negation does not propagate
7908 out to the higher level. For example, consider:
7909 .code
7910 domainlist  dom1 = !a.b
7911 domainlist  dom2 = +dom1 : *.b
7912 .endd
7913 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7914 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7915 means it matches the second list as well. The effect is not the same as
7916 .code
7917 domainlist  dom2 = !a.b : *.b
7918 .endd
7919 where &'x.y'& does not match. It's best to avoid negation altogether in
7920 referenced lists if you can.
7921
7922 Named lists may have a performance advantage. When Exim is routing an
7923 address or checking an incoming message, it caches the result of tests on named
7924 lists. So, if you have a setting such as
7925 .code
7926 domains = +local_domains
7927 .endd
7928 on several of your routers
7929 or in several ACL statements,
7930 the actual test is done only for the first one. However, the caching works only
7931 if there are no expansions within the list itself or any sublists that it
7932 references. In other words, caching happens only for lists that are known to be
7933 the same each time they are referenced.
7934
7935 By default, there may be up to 16 named lists of each type. This limit can be
7936 extended by changing a compile-time variable. The use of domain and host lists
7937 is recommended for concepts such as local domains, relay domains, and relay
7938 hosts. The default configuration is set up like this.
7939
7940
7941
7942 .section "Named lists compared with macros" "SECID78"
7943 .cindex "list" "named compared with macro"
7944 .cindex "macro" "compared with named list"
7945 At first sight, named lists might seem to be no different from macros in the
7946 configuration file. However, macros are just textual substitutions. If you
7947 write
7948 .code
7949 ALIST = host1 : host2
7950 auth_advertise_hosts = !ALIST
7951 .endd
7952 it probably won't do what you want, because that is exactly the same as
7953 .code
7954 auth_advertise_hosts = !host1 : host2
7955 .endd
7956 Notice that the second host name is not negated. However, if you use a host
7957 list, and write
7958 .code
7959 hostlist alist = host1 : host2
7960 auth_advertise_hosts = ! +alist
7961 .endd
7962 the negation applies to the whole list, and so that is equivalent to
7963 .code
7964 auth_advertise_hosts = !host1 : !host2
7965 .endd
7966
7967
7968 .section "Named list caching" "SECID79"
7969 .cindex "list" "caching of named"
7970 .cindex "caching" "named lists"
7971 While processing a message, Exim caches the result of checking a named list if
7972 it is sure that the list is the same each time. In practice, this means that
7973 the cache operates only if the list contains no $ characters, which guarantees
7974 that it will not change when it is expanded. Sometimes, however, you may have
7975 an expanded list that you know will be the same each time within a given
7976 message. For example:
7977 .code
7978 domainlist special_domains = \
7979            ${lookup{$sender_host_address}cdb{/some/file}}
7980 .endd
7981 This provides a list of domains that depends only on the sending host's IP
7982 address. If this domain list is referenced a number of times (for example,
7983 in several ACL lines, or in several routers) the result of the check is not
7984 cached by default, because Exim does not know that it is going to be the
7985 same list each time.
7986
7987 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7988 cache the result anyway. For example:
7989 .code
7990 domainlist_cache special_domains = ${lookup{...
7991 .endd
7992 If you do this, you should be absolutely sure that caching is going to do
7993 the right thing in all cases. When in doubt, leave it out.
7994
7995
7996
7997 .section "Domain lists" "SECTdomainlist"
7998 .cindex "domain list" "patterns for"
7999 .cindex "list" "domain list"
8000 Domain lists contain patterns that are to be matched against a mail domain.
8001 The following types of item may appear in domain lists:
8002
8003 .ilist
8004 .cindex "primary host name"
8005 .cindex "host name" "matched in domain list"
8006 .oindex "&%primary_hostname%&"
8007 .cindex "domain list" "matching primary host name"
8008 .cindex "@ in a domain list"
8009 If a pattern consists of a single @ character, it matches the local host name,
8010 as set by the &%primary_hostname%& option (or defaulted). This makes it
8011 possible to use the same configuration file on several different hosts that
8012 differ only in their names.
8013 .next
8014 .cindex "@[] in a domain list"
8015 .cindex "domain list" "matching local IP interfaces"
8016 .cindex "domain literal"
8017 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8018 in square brackets (as in an email address that contains a domain literal), but
8019 only if that IP address is recognized as local for email routing purposes. The
8020 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8021 control which of a host's several IP addresses are treated as local.
8022 In today's Internet, the use of domain literals is controversial.
8023 .next
8024 .cindex "@mx_any"
8025 .cindex "@mx_primary"
8026 .cindex "@mx_secondary"
8027 .cindex "domain list" "matching MX pointers to local host"
8028 If a pattern consists of the string &`@mx_any`& it matches any domain that
8029 has an MX record pointing to the local host or to any host that is listed in
8030 .oindex "&%hosts_treat_as_local%&"
8031 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8032 are similar, except that the first matches only when a primary MX target is the
8033 local host, and the second only when no primary MX target is the local host,
8034 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8035 preference value &-- there may of course be more than one of them.
8036
8037 The MX lookup that takes place when matching a pattern of this type is
8038 performed with the resolver options for widening names turned off. Thus, for
8039 example, a single-component domain will &'not'& be expanded by adding the
8040 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8041 options of the &(dnslookup)& router for a discussion of domain widening.
8042
8043 Sometimes you may want to ignore certain IP addresses when using one of these
8044 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8045 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8046 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8047 on a router). For example:
8048 .code
8049 domains = @mx_any/ignore=127.0.0.1
8050 .endd
8051 This example matches any domain that has an MX record pointing to one of
8052 the local host's IP addresses other than 127.0.0.1.
8053
8054 The list of IP addresses is in fact processed by the same code that processes
8055 host lists, so it may contain CIDR-coded network specifications and it may also
8056 contain negative items.
8057
8058 Because the list of IP addresses is a sublist within a domain list, you have to
8059 be careful about delimiters if there is more than one address. Like any other
8060 list, the default delimiter can be changed. Thus, you might have:
8061 .code
8062 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8063           an.other.domain : ...
8064 .endd
8065 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8066 involved, it is easiest to change the delimiter for the main list as well:
8067 .code
8068 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8069           an.other.domain ? ...
8070 .endd
8071 .next
8072 .cindex "asterisk" "in domain list"
8073 .cindex "domain list" "asterisk in"
8074 .cindex "domain list" "matching &""ends with""&"
8075 If a pattern starts with an asterisk, the remaining characters of the pattern
8076 are compared with the terminating characters of the domain. The use of &"*"& in
8077 domain lists differs from its use in partial matching lookups. In a domain
8078 list, the character following the asterisk need not be a dot, whereas partial
8079 matching works only in terms of dot-separated components. For example, a domain
8080 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8081 &'cipher.key.ex'&.
8082
8083 .next
8084 .cindex "regular expressions" "in domain list"
8085 .cindex "domain list" "matching regular expression"
8086 If a pattern starts with a circumflex character, it is treated as a regular
8087 expression, and matched against the domain using a regular expression matching
8088 function. The circumflex is treated as part of the regular expression.
8089 Email domains are case-independent, so this regular expression match is by
8090 default case-independent, but you can make it case-dependent by starting it
8091 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8092 are given in chapter &<<CHAPregexp>>&.
8093
8094 &*Warning*&: Because domain lists are expanded before being processed, you
8095 must escape any backslash and dollar characters in the regular expression, or
8096 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8097 it is not to be expanded (unless you really do want to build a regular
8098 expression by expansion, of course).
8099 .next
8100 .cindex "lookup" "in domain list"
8101 .cindex "domain list" "matching by lookup"
8102 If a pattern starts with the name of a single-key lookup type followed by a
8103 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8104 must be a file name in a suitable format for the lookup type. For example, for
8105 &"cdb;"& it must be an absolute path:
8106 .code
8107 domains = cdb;/etc/mail/local_domains.cdb
8108 .endd
8109 The appropriate type of lookup is done on the file using the domain name as the
8110 key. In most cases, the data that is looked up is not used; Exim is interested
8111 only in whether or not the key is present in the file. However, when a lookup
8112 is used for the &%domains%& option on a router
8113 or a &%domains%& condition in an ACL statement, the data is preserved in the
8114 &$domain_data$& variable and can be referred to in other router options or
8115 other statements in the same ACL.
8116
8117 .next
8118 Any of the single-key lookup type names may be preceded by
8119 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8120 .code
8121 domains = partial-dbm;/partial/domains
8122 .endd
8123 This causes partial matching logic to be invoked; a description of how this
8124 works is given in section &<<SECTpartiallookup>>&.
8125
8126 .next
8127 .cindex "asterisk" "in lookup type"
8128 Any of the single-key lookup types may be followed by an asterisk. This causes
8129 a default lookup for a key consisting of a single asterisk to be done if the
8130 original lookup fails. This is not a useful feature when using a domain list to
8131 select particular domains (because any domain would match), but it might have
8132 value if the result of the lookup is being used via the &$domain_data$&
8133 expansion variable.
8134 .next
8135 If the pattern starts with the name of a query-style lookup type followed by a
8136 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8137 pattern must be an appropriate query for the lookup type, as described in
8138 chapter &<<CHAPfdlookup>>&. For example:
8139 .code
8140 hold_domains = mysql;select domain from holdlist \
8141   where domain = '${quote_mysql:$domain}';
8142 .endd
8143 In most cases, the data that is looked up is not used (so for an SQL query, for
8144 example, it doesn't matter what field you select). Exim is interested only in
8145 whether or not the query succeeds. However, when a lookup is used for the
8146 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8147 variable and can be referred to in other options.
8148 .next
8149 .cindex "domain list" "matching literal domain name"
8150 If none of the above cases apply, a caseless textual comparison is made
8151 between the pattern and the domain.
8152 .endlist
8153
8154 Here is an example that uses several different kinds of pattern:
8155 .code
8156 domainlist funny_domains = \
8157   @ : \
8158   lib.unseen.edu : \
8159   *.foundation.fict.example : \
8160   \N^[1-2]\d{3}\.fict\.example$\N : \
8161   partial-dbm;/opt/data/penguin/book : \
8162   nis;domains.byname : \
8163   nisplus;[name=$domain,status=local],domains.org_dir
8164 .endd
8165 There are obvious processing trade-offs among the various matching modes. Using
8166 an asterisk is faster than a regular expression, and listing a few names
8167 explicitly probably is too. The use of a file or database lookup is expensive,
8168 but may be the only option if hundreds of names are required. Because the
8169 patterns are tested in order, it makes sense to put the most commonly matched
8170 patterns earlier.
8171
8172
8173
8174 .section "Host lists" "SECThostlist"
8175 .cindex "host list" "patterns in"
8176 .cindex "list" "host list"
8177 Host lists are used to control what remote hosts are allowed to do. For
8178 example, some hosts may be allowed to use the local host as a relay, and some
8179 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8180 two different ways, by name or by IP address. In a host list, some types of
8181 pattern are matched to a host name, and some are matched to an IP address.
8182 You need to be particularly careful with this when single-key lookups are
8183 involved, to ensure that the right value is being used as the key.
8184
8185
8186 .section "Special host list patterns" "SECID80"
8187 .cindex "empty item in hosts list"
8188 .cindex "host list" "empty string in"
8189 If a host list item is the empty string, it matches only when no remote host is
8190 involved. This is the case when a message is being received from a local
8191 process using SMTP on the standard input, that is, when a TCP/IP connection is
8192 not used.
8193
8194 .cindex "asterisk" "in host list"
8195 The special pattern &"*"& in a host list matches any host or no host. Neither
8196 the IP address nor the name is actually inspected.
8197
8198
8199
8200 .section "Host list patterns that match by IP address" "SECThoslispatip"
8201 .cindex "host list" "matching IP addresses"
8202 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8203 the incoming address actually appears in the IPv6 host as
8204 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8205 list, it is converted into a traditional IPv4 address first. (Not all operating
8206 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8207 concerns.)
8208
8209 The following types of pattern in a host list check the remote host by
8210 inspecting its IP address:
8211
8212 .ilist
8213 If the pattern is a plain domain name (not a regular expression, not starting
8214 with *, not a lookup of any kind), Exim calls the operating system function
8215 to find the associated IP address(es). Exim uses the newer
8216 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8217 This typically causes a forward DNS lookup of the name. The result is compared
8218 with the IP address of the subject host.
8219
8220 If there is a temporary problem (such as a DNS timeout) with the host name
8221 lookup, a temporary error occurs. For example, if the list is being used in an
8222 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8223 temporary SMTP error code. If no IP address can be found for the host name,
8224 what happens is described in section &<<SECTbehipnot>>& below.
8225
8226 .next
8227 .cindex "@ in a host list"
8228 If the pattern is &"@"&, the primary host name is substituted and used as a
8229 domain name, as just described.
8230
8231 .next
8232 If the pattern is an IP address, it is matched against the IP address of the
8233 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8234 IPv6 addresses can be given in colon-separated format, but the colons have to
8235 be doubled so as not to be taken as item separators when the default list
8236 separator is used. IPv6 addresses are recognized even when Exim is compiled
8237 without IPv6 support. This means that if they appear in a host list on an
8238 IPv4-only host, Exim will not treat them as host names. They are just addresses
8239 that can never match a client host.
8240
8241 .next
8242 .cindex "@[] in a host list"
8243 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8244 the local host. For example, if the local host is an IPv4 host with one
8245 interface address 10.45.23.56, these two ACL statements have the same effect:
8246 .code
8247 accept hosts = 127.0.0.1 : 10.45.23.56
8248 accept hosts = @[]
8249 .endd
8250 .next
8251 .cindex "CIDR notation"
8252 If the pattern is an IP address followed by a slash and a mask length (for
8253 example 10.11.42.0/24), it is matched against the IP address of the subject
8254 host under the given mask. This allows, an entire network of hosts to be
8255 included (or excluded) by a single item. The mask uses CIDR notation; it
8256 specifies the number of address bits that must match, starting from the most
8257 significant end of the address.
8258
8259 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8260 of a range of addresses. It is the number of bits in the network portion of the
8261 address. The above example specifies a 24-bit netmask, so it matches all 256
8262 addresses in the 10.11.42.0 network. An item such as
8263 .code
8264 192.168.23.236/31
8265 .endd
8266 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8267 32 for an IPv4 address is the same as no mask at all; just a single address
8268 matches.
8269
8270 Here is another example which shows an IPv4 and an IPv6 network:
8271 .code
8272 recipient_unqualified_hosts = 192.168.0.0/16: \
8273                               3ffe::ffff::836f::::/48
8274 .endd
8275 The doubling of list separator characters applies only when these items
8276 appear inline in a host list. It is not required when indirecting via a file.
8277 For example:
8278 .code
8279 recipient_unqualified_hosts = /opt/exim/unqualnets
8280 .endd
8281 could make use of a file containing
8282 .code
8283 172.16.0.0/12
8284 3ffe:ffff:836f::/48
8285 .endd
8286 to have exactly the same effect as the previous example. When listing IPv6
8287 addresses inline, it is usually more convenient to use the facility for
8288 changing separator characters. This list contains the same two networks:
8289 .code
8290 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8291                                  3ffe:ffff:836f::/48
8292 .endd
8293 The separator is changed to semicolon by the leading &"<;"& at the start of the
8294 list.
8295 .endlist
8296
8297
8298
8299 .section "Host list patterns for single-key lookups by host address" &&&
8300          "SECThoslispatsikey"
8301 .cindex "host list" "lookup of IP address"
8302 When a host is to be identified by a single-key lookup of its complete IP
8303 address, the pattern takes this form:
8304 .display
8305 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8306 .endd
8307 For example:
8308 .code
8309 hosts_lookup = net-cdb;/hosts-by-ip.db
8310 .endd
8311 The text form of the IP address of the subject host is used as the lookup key.
8312 IPv6 addresses are converted to an unabbreviated form, using lower case
8313 letters, with dots as separators because colon is the key terminator in
8314 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8315 quoting the keys, but this is a facility that was added later.] The data
8316 returned by the lookup is not used.
8317
8318 .cindex "IP address" "masking"
8319 .cindex "host list" "masked IP address"
8320 Single-key lookups can also be performed using masked IP addresses, using
8321 patterns of this form:
8322 .display
8323 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8324 .endd
8325 For example:
8326 .code
8327 net24-dbm;/networks.db
8328 .endd
8329 The IP address of the subject host is masked using <&'number'&> as the mask
8330 length. A textual string is constructed from the masked value, followed by the
8331 mask, and this is used as the lookup key. For example, if the host's IP address
8332 is 192.168.34.6, the key that is looked up for the above example is
8333 &"192.168.34.0/24"&.
8334
8335 When an IPv6 address is converted to a string, dots are normally used instead
8336 of colons, so that keys in &(lsearch)& files need not contain colons (which
8337 terminate &(lsearch)& keys). This was implemented some time before the ability
8338 to quote keys was made available in &(lsearch)& files. However, the more
8339 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8340 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8341 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8342 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8343 addresses are always used.
8344
8345 Ideally, it would be nice to tidy up this anomalous situation by changing to
8346 colons in all cases, given that quoting is now available for &(lsearch)&.
8347 However, this would be an incompatible change that might break some existing
8348 configurations.
8349
8350 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8351 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8352 the former case the key strings include the mask value, whereas in the latter
8353 case the IP address is used on its own.
8354
8355
8356
8357 .section "Host list patterns that match by host name" "SECThoslispatnam"
8358 .cindex "host" "lookup failures"
8359 .cindex "unknown host name"
8360 .cindex "host list" "matching host name"
8361 There are several types of pattern that require Exim to know the name of the
8362 remote host. These are either wildcard patterns or lookups by name. (If a
8363 complete hostname is given without any wildcarding, it is used to find an IP
8364 address to match against, as described in section &<<SECThoslispatip>>&
8365 above.)
8366
8367 If the remote host name is not already known when Exim encounters one of these
8368 patterns, it has to be found from the IP address.
8369 Although many sites on the Internet are conscientious about maintaining reverse
8370 DNS data for their hosts, there are also many that do not do this.
8371 Consequently, a name cannot always be found, and this may lead to unwanted
8372 effects. Take care when configuring host lists with wildcarded name patterns.
8373 Consider what will happen if a name cannot be found.
8374
8375 Because of the problems of determining host names from IP addresses, matching
8376 against host names is not as common as matching against IP addresses.
8377
8378 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8379 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8380 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8381 are done can be changed by setting the &%host_lookup_order%& option. For
8382 security, once Exim has found one or more names, it looks up the IP addresses
8383 for these names and compares them with the IP address that it started with.
8384 Only those names whose IP addresses match are accepted. Any other names are
8385 discarded. If no names are left, Exim behaves as if the host name cannot be
8386 found. In the most common case there is only one name and one IP address.
8387
8388 There are some options that control what happens if a host name cannot be
8389 found. These are described in section &<<SECTbehipnot>>& below.
8390
8391 .cindex "host" "alias for"
8392 .cindex "alias for host"
8393 As a result of aliasing, hosts may have more than one name. When processing any
8394 of the following types of pattern, all the host's names are checked:
8395
8396 .ilist
8397 .cindex "asterisk" "in host list"
8398 If a pattern starts with &"*"& the remainder of the item must match the end of
8399 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8400 &'.b.c'&. This special simple form is provided because this is a very common
8401 requirement. Other kinds of wildcarding require the use of a regular
8402 expression.
8403 .next
8404 .cindex "regular expressions" "in host list"
8405 .cindex "host list" "regular expression in"
8406 If the item starts with &"^"& it is taken to be a regular expression which is
8407 matched against the host name. Host names are case-independent, so this regular
8408 expression match is by default case-independent, but you can make it
8409 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8410 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8411 example,
8412 .code
8413 ^(a|b)\.c\.d$
8414 .endd
8415 is a regular expression that matches either of the two hosts &'a.c.d'& or
8416 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8417 that backslash and dollar characters are not misinterpreted as part of the
8418 string expansion. The simplest way to do this is to use &`\N`& to mark that
8419 part of the string as non-expandable. For example:
8420 .code
8421 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8422 .endd
8423 &*Warning*&: If you want to match a complete host name, you must include the
8424 &`$`& terminating metacharacter in the regular expression, as in the above
8425 example. Without it, a match at the start of the host name is all that is
8426 required.
8427 .endlist
8428
8429
8430
8431
8432 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8433 .cindex "host" "lookup failures, permanent"
8434 While processing a host list, Exim may need to look up an IP address from a
8435 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8436 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8437 behaviour when it fails to find the information it is seeking is the same.
8438
8439 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8440 apply to temporary DNS errors, whose handling is described in the next section.
8441
8442 .cindex "&`+include_unknown`&"
8443 .cindex "&`+ignore_unknown`&"
8444 Exim parses a host list from left to right. If it encounters a permanent
8445 lookup failure in any item in the host list before it has found a match,
8446 Exim treats it as a failure and the default behavior is as if the host
8447 does not match the list. This may not always be what you want to happen.
8448 To change Exim's behaviour, the special items &`+include_unknown`& or
8449 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8450 not recognized in an indirected file).
8451
8452 .ilist
8453 If any item that follows &`+include_unknown`& requires information that
8454 cannot found, Exim behaves as if the host does match the list. For example,
8455 .code
8456 host_reject_connection = +include_unknown:*.enemy.ex
8457 .endd
8458 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8459 any hosts whose name it cannot find.
8460
8461 .next
8462 If any item that follows &`+ignore_unknown`& requires information that cannot
8463 be found, Exim ignores that item and proceeds to the rest of the list. For
8464 example:
8465 .code
8466 accept hosts = +ignore_unknown : friend.example : \
8467                192.168.4.5
8468 .endd
8469 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8470 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8471 name can be found for 192.168.4.5, it is rejected.
8472 .endlist
8473
8474 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8475 list. The effect of each one lasts until the next, or until the end of the
8476 list.
8477
8478 .section "Mixing wildcarded host names and addresses in host lists" &&&
8479          "SECTmixwilhos"
8480 .cindex "host list" "mixing names and addresses in"
8481
8482 This section explains the host/ip processing logic with the same concepts
8483 as the previous section, but specifically addresses what happens when a
8484 wildcarded hostname is one of the items in the hostlist.
8485
8486 .ilist
8487 If you have name lookups or wildcarded host names and
8488 IP addresses in the same host list, you should normally put the IP
8489 addresses first. For example, in an ACL you could have:
8490 .code
8491 accept hosts = 10.9.8.7 : *.friend.example
8492 .endd
8493 The reason you normally would order it this way lies in the
8494 left-to-right way that Exim processes lists.  It can test IP addresses
8495 without doing any DNS lookups, but when it reaches an item that requires
8496 a host name, it fails if it cannot find a host name to compare with the
8497 pattern. If the above list is given in the opposite order, the
8498 &%accept%& statement fails for a host whose name cannot be found, even
8499 if its IP address is 10.9.8.7.
8500
8501 .next
8502 If you really do want to do the name check first, and still recognize the IP
8503 address, you can rewrite the ACL like this:
8504 .code
8505 accept hosts = *.friend.example
8506 accept hosts = 10.9.8.7
8507 .endd
8508 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8509 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8510 &`+ignore_unknown`&, which was discussed in depth in the first example in
8511 this section.
8512 .endlist
8513
8514
8515 .section "Temporary DNS errors when looking up host information" &&&
8516          "SECTtemdnserr"
8517 .cindex "host" "lookup failures, temporary"
8518 .cindex "&`+include_defer`&"
8519 .cindex "&`+ignore_defer`&"
8520 A temporary DNS lookup failure normally causes a defer action (except when
8521 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8522 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8523 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8524 section. These options should be used with care, probably only in non-critical
8525 host lists such as whitelists.
8526
8527
8528
8529 .section "Host list patterns for single-key lookups by host name" &&&
8530          "SECThoslispatnamsk"
8531 .cindex "unknown host name"
8532 .cindex "host list" "matching host name"
8533 If a pattern is of the form
8534 .display
8535 <&'single-key-search-type'&>;<&'search-data'&>
8536 .endd
8537 for example
8538 .code
8539 dbm;/host/accept/list
8540 .endd
8541 a single-key lookup is performed, using the host name as its key. If the
8542 lookup succeeds, the host matches the item. The actual data that is looked up
8543 is not used.
8544
8545 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8546 keys in the file, not IP addresses. If you want to do lookups based on IP
8547 addresses, you must precede the search type with &"net-"& (see section
8548 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8549 two items in the same list, one doing an address lookup and one doing a name
8550 lookup, both using the same file.
8551
8552
8553
8554 .section "Host list patterns for query-style lookups" "SECID81"
8555 If a pattern is of the form
8556 .display
8557 <&'query-style-search-type'&>;<&'query'&>
8558 .endd
8559 the query is obeyed, and if it succeeds, the host matches the item. The actual
8560 data that is looked up is not used. The variables &$sender_host_address$& and
8561 &$sender_host_name$& can be used in the query. For example:
8562 .code
8563 hosts_lookup = pgsql;\
8564   select ip from hostlist where ip='$sender_host_address'
8565 .endd
8566 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8567 can use the &%sg%& expansion item to change this if you need to. If you want to
8568 use masked IP addresses in database queries, you can use the &%mask%& expansion
8569 operator.
8570
8571 If the query contains a reference to &$sender_host_name$&, Exim automatically
8572 looks up the host name if it has not already done so. (See section
8573 &<<SECThoslispatnam>>& for comments on finding host names.)
8574
8575 Historical note: prior to release 4.30, Exim would always attempt to find a
8576 host name before running the query, unless the search type was preceded by
8577 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8578 still recognized for query-style lookups, but its presence or absence has no
8579 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8580 See section &<<SECThoslispatsikey>>&.)
8581
8582
8583
8584
8585
8586 .section "Address lists" "SECTaddresslist"
8587 .cindex "list" "address list"
8588 .cindex "address list" "empty item"
8589 .cindex "address list" "patterns"
8590 Address lists contain patterns that are matched against mail addresses. There
8591 is one special case to be considered: the sender address of a bounce message is
8592 always empty. You can test for this by providing an empty item in an address
8593 list. For example, you can set up a router to process bounce messages by
8594 using this option setting:
8595 .code
8596 senders = :
8597 .endd
8598 The presence of the colon creates an empty item. If you do not provide any
8599 data, the list is empty and matches nothing. The empty sender can also be
8600 detected by a regular expression that matches an empty string,
8601 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8602
8603 Non-empty items in an address list can be straightforward email addresses. For
8604 example:
8605 .code
8606 senders = jbc@askone.example : hs@anacreon.example
8607 .endd
8608 A certain amount of wildcarding is permitted. If a pattern contains an @
8609 character, but is not a regular expression and does not begin with a
8610 semicolon-terminated lookup type (described below), the local part of the
8611 subject address is compared with the local part of the pattern, which may start
8612 with an asterisk. If the local parts match, the domain is checked in exactly
8613 the same way as for a pattern in a domain list. For example, the domain can be
8614 wildcarded, refer to a named list, or be a lookup:
8615 .code
8616 deny senders = *@*.spamming.site:\
8617                *@+hostile_domains:\
8618                bozo@partial-lsearch;/list/of/dodgy/sites:\
8619                *@dbm;/bad/domains.db
8620 .endd
8621 .cindex "local part" "starting with !"
8622 .cindex "address list" "local part starting with !"
8623 If a local part that begins with an exclamation mark is required, it has to be
8624 specified using a regular expression, because otherwise the exclamation mark is
8625 treated as a sign of negation, as is standard in lists.
8626
8627 If a non-empty pattern that is not a regular expression or a lookup does not
8628 contain an @ character, it is matched against the domain part of the subject
8629 address. The only two formats that are recognized this way are a literal
8630 domain, or a domain pattern that starts with *. In both these cases, the effect
8631 is the same as if &`*@`& preceded the pattern. For example:
8632 .code
8633 deny senders = enemy.domain : *.enemy.domain
8634 .endd
8635
8636 The following kinds of more complicated address list pattern can match any
8637 address, including the empty address that is characteristic of bounce message
8638 senders:
8639
8640 .ilist
8641 .cindex "regular expressions" "in address list"
8642 .cindex "address list" "regular expression in"
8643 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8644 done against the complete address, with the pattern as the regular expression.
8645 You must take care that backslash and dollar characters are not misinterpreted
8646 as part of the string expansion. The simplest way to do this is to use &`\N`&
8647 to mark that part of the string as non-expandable. For example:
8648 .code
8649 deny senders = \N^.*this.*@example\.com$\N : \
8650                \N^\d{8}.+@spamhaus.example$\N : ...
8651 .endd
8652 The &`\N`& sequences are removed by the expansion, so these items do indeed
8653 start with &"^"& by the time they are being interpreted as address patterns.
8654
8655 .next
8656 .cindex "address list" "lookup for complete address"
8657 Complete addresses can be looked up by using a pattern that starts with a
8658 lookup type terminated by a semicolon, followed by the data for the lookup. For
8659 example:
8660 .code
8661 deny senders = cdb;/etc/blocked.senders : \
8662   mysql;select address from blocked where \
8663   address='${quote_mysql:$sender_address}'
8664 .endd
8665 Both query-style and single-key lookup types can be used. For a single-key
8666 lookup type, Exim uses the complete address as the key. However, empty keys are
8667 not supported for single-key lookups, so a match against the empty address
8668 always fails. This restriction does not apply to query-style lookups.
8669
8670 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8671 cannot be used, and is ignored if specified, with an entry being written to the
8672 panic log.
8673 .cindex "*@ with single-key lookup"
8674 However, you can configure lookup defaults, as described in section
8675 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8676 default. For example, with this lookup:
8677 .code
8678 accept senders = lsearch*@;/some/file
8679 .endd
8680 the file could contains lines like this:
8681 .code
8682 user1@domain1.example
8683 *@domain2.example
8684 .endd
8685 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8686 that are tried is:
8687 .code
8688 nimrod@jaeger.example
8689 *@jaeger.example
8690 *
8691 .endd
8692 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8693 would mean that every address matches, thus rendering the test useless.
8694
8695 &*Warning 2*&: Do not confuse these two kinds of item:
8696 .code
8697 deny recipients = dbm*@;/some/file
8698 deny recipients = *@dbm;/some/file
8699 .endd
8700 The first does a whole address lookup, with defaulting, as just described,
8701 because it starts with a lookup type. The second matches the local part and
8702 domain independently, as described in a bullet point below.
8703 .endlist
8704
8705
8706 The following kinds of address list pattern can match only non-empty addresses.
8707 If the subject address is empty, a match against any of these pattern types
8708 always fails.
8709
8710
8711 .ilist
8712 .cindex "@@ with single-key lookup"
8713 .cindex "address list" "@@ lookup type"
8714 .cindex "address list" "split local part and domain"
8715 If a pattern starts with &"@@"& followed by a single-key lookup item
8716 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8717 split into a local part and a domain. The domain is looked up in the file. If
8718 it is not found, there is no match. If it is found, the data that is looked up
8719 from the file is treated as a colon-separated list of local part patterns, each
8720 of which is matched against the subject local part in turn.
8721
8722 .cindex "asterisk" "in address list"
8723 The lookup may be a partial one, and/or one involving a search for a default
8724 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8725 patterns that are looked up can be regular expressions or begin with &"*"&, or
8726 even be further lookups. They may also be independently negated. For example,
8727 with
8728 .code
8729 deny senders = @@dbm;/etc/reject-by-domain
8730 .endd
8731 the data from which the DBM file is built could contain lines like
8732 .code
8733 baddomain.com:  !postmaster : *
8734 .endd
8735 to reject all senders except &%postmaster%& from that domain.
8736
8737 .cindex "local part" "starting with !"
8738 If a local part that actually begins with an exclamation mark is required, it
8739 has to be specified using a regular expression. In &(lsearch)& files, an entry
8740 may be split over several lines by indenting the second and subsequent lines,
8741 but the separating colon must still be included at line breaks. White space
8742 surrounding the colons is ignored. For example:
8743 .code
8744 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8745   spammer3 : spammer4
8746 .endd
8747 As in all colon-separated lists in Exim, a colon can be included in an item by
8748 doubling.
8749
8750 If the last item in the list starts with a right angle-bracket, the remainder
8751 of the item is taken as a new key to look up in order to obtain a continuation
8752 list of local parts. The new key can be any sequence of characters. Thus one
8753 might have entries like
8754 .code
8755 aol.com: spammer1 : spammer 2 : >*
8756 xyz.com: spammer3 : >*
8757 *:       ^\d{8}$
8758 .endd
8759 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8760 local parts for all domains, in addition to the specific local parts listed for
8761 each domain. Of course, using this feature costs another lookup each time a
8762 chain is followed, but the effort needed to maintain the data is reduced.
8763
8764 .cindex "loop" "in lookups"
8765 It is possible to construct loops using this facility, and in order to catch
8766 them, the chains may be no more than fifty items long.
8767
8768 .next
8769 The @@<&'lookup'&> style of item can also be used with a query-style
8770 lookup, but in this case, the chaining facility is not available. The lookup
8771 can only return a single list of local parts.
8772 .endlist
8773
8774 &*Warning*&: There is an important difference between the address list items
8775 in these two examples:
8776 .code
8777 senders = +my_list
8778 senders = *@+my_list
8779 .endd
8780 In the first one, &`my_list`& is a named address list, whereas in the second
8781 example it is a named domain list.
8782
8783
8784
8785
8786 .section "Case of letters in address lists" "SECTcasletadd"
8787 .cindex "case of local parts"
8788 .cindex "address list" "case forcing"
8789 .cindex "case forcing in address lists"
8790 Domains in email addresses are always handled caselessly, but for local parts
8791 case may be significant on some systems (see &%caseful_local_part%& for how
8792 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8793 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8794 blocking lists should be done in a case-independent manner. Since most address
8795 lists in Exim are used for this kind of control, Exim attempts to do this by
8796 default.
8797
8798 The domain portion of an address is always lowercased before matching it to an
8799 address list. The local part is lowercased by default, and any string
8800 comparisons that take place are done caselessly. This means that the data in
8801 the address list itself, in files included as plain file names, and in any file
8802 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8803 keys in files that are looked up by a search type other than &(lsearch)& (which
8804 works caselessly) must be in lower case, because these lookups are not
8805 case-independent.
8806
8807 .cindex "&`+caseful`&"
8808 To allow for the possibility of caseful address list matching, if an item in
8809 an address list is the string &"+caseful"&, the original case of the local
8810 part is restored for any comparisons that follow, and string comparisons are no
8811 longer case-independent. This does not affect the domain, which remains in
8812 lower case. However, although independent matches on the domain alone are still
8813 performed caselessly, regular expressions that match against an entire address
8814 become case-sensitive after &"+caseful"& has been seen.
8815
8816
8817
8818 .section "Local part lists" "SECTlocparlis"
8819 .cindex "list" "local part list"
8820 .cindex "local part" "list"
8821 Case-sensitivity in local part lists is handled in the same way as for address
8822 lists, as just described. The &"+caseful"& item can be used if required. In a
8823 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8824 set false, the subject is lowercased and the matching is initially
8825 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8826 matching in the local part list, but not elsewhere in the router. If
8827 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8828 option is case-sensitive from the start.
8829
8830 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8831 comments are handled in the same way as address lists &-- they are recognized
8832 only if the # is preceded by white space or the start of the line.
8833 Otherwise, local part lists are matched in the same way as domain lists, except
8834 that the special items that refer to the local host (&`@`&, &`@[]`&,
8835 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8836 Refer to section &<<SECTdomainlist>>& for details of the other available item
8837 types.
8838 .ecindex IIDdohoadli
8839
8840
8841
8842
8843 . ////////////////////////////////////////////////////////////////////////////
8844 . ////////////////////////////////////////////////////////////////////////////
8845
8846 .chapter "String expansions" "CHAPexpand"
8847 .scindex IIDstrexp "expansion" "of strings"
8848 Many strings in Exim's run time configuration are expanded before use. Some of
8849 them are expanded every time they are used; others are expanded only once.
8850
8851 When a string is being expanded it is copied verbatim from left to right except
8852 when a dollar or backslash character is encountered. A dollar specifies the
8853 start of a portion of the string that is interpreted and replaced as described
8854 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8855 escape character, as described in the following section.
8856
8857 Whether a string is expanded depends upon the context.  Usually this is solely
8858 dependent upon the option for which a value is sought; in this documentation,
8859 options for which string expansion is performed are marked with &dagger; after
8860 the data type.  ACL rules always expand strings.  A couple of expansion
8861 conditions do not expand some of the brace-delimited branches, for security
8862 reasons.
8863
8864
8865
8866 .section "Literal text in expanded strings" "SECTlittext"
8867 .cindex "expansion" "including literal text"
8868 An uninterpreted dollar can be included in an expanded string by putting a
8869 backslash in front of it. A backslash can be used to prevent any special
8870 character being treated specially in an expansion, including backslash itself.
8871 If the string appears in quotes in the configuration file, two backslashes are
8872 required because the quotes themselves cause interpretation of backslashes when
8873 the string is read in (see section &<<SECTstrings>>&).
8874
8875 .cindex "expansion" "non-expandable substrings"
8876 A portion of the string can specified as non-expandable by placing it between
8877 two occurrences of &`\N`&. This is particularly useful for protecting regular
8878 expressions, which often contain backslashes and dollar signs. For example:
8879 .code
8880 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8881 .endd
8882 On encountering the first &`\N`&, the expander copies subsequent characters
8883 without interpretation until it reaches the next &`\N`& or the end of the
8884 string.
8885
8886
8887
8888 .section "Character escape sequences in expanded strings" "SECID82"
8889 .cindex "expansion" "escape sequences"
8890 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8891 expanded string is recognized as an escape sequence for the character newline,
8892 carriage return, or tab, respectively. A backslash followed by up to three
8893 octal digits is recognized as an octal encoding for a single character, and a
8894 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8895 encoding.
8896
8897 These escape sequences are also recognized in quoted strings when they are read
8898 in. Their interpretation in expansions as well is useful for unquoted strings,
8899 and for other cases such as looked-up strings that are then expanded.
8900
8901
8902 .section "Testing string expansions" "SECID83"
8903 .cindex "expansion" "testing"
8904 .cindex "testing" "string expansion"
8905 .oindex "&%-be%&"
8906 Many expansions can be tested by calling Exim with the &%-be%& option. This
8907 takes the command arguments, or lines from the standard input if there are no
8908 arguments, runs them through the string expansion code, and writes the results
8909 to the standard output. Variables based on configuration values are set up, but
8910 since no message is being processed, variables such as &$local_part$& have no
8911 value. Nevertheless the &%-be%& option can be useful for checking out file and
8912 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8913 and &%nhash%&.
8914
8915 Exim gives up its root privilege when it is called with the &%-be%& option, and
8916 instead runs under the uid and gid it was called with, to prevent users from
8917 using &%-be%& for reading files to which they do not have access.
8918
8919 .oindex "&%-bem%&"
8920 If you want to test expansions that include variables whose values are taken
8921 from a message, there are two other options that can be used. The &%-bem%&
8922 option is like &%-be%& except that it is followed by a file name. The file is
8923 read as a message before doing the test expansions. For example:
8924 .code
8925 exim -bem /tmp/test.message '$h_subject:'
8926 .endd
8927 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8928 Exim message identifier. For example:
8929 .code
8930 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8931 .endd
8932 This loads the message from Exim's spool before doing the test expansions, and
8933 is therefore restricted to admin users.
8934
8935
8936 .section "Forced expansion failure" "SECTforexpfai"
8937 .cindex "expansion" "forced failure"
8938 A number of expansions that are described in the following section have
8939 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8940 (which are sometimes called &"curly brackets"&). Which of the two strings is
8941 used depends on some condition that is evaluated as part of the expansion. If,
8942 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8943 the entire string expansion fails in a way that can be detected by the code
8944 that requested the expansion. This is called &"forced expansion failure"&, and
8945 its consequences depend on the circumstances. In some cases it is no different
8946 from any other expansion failure, but in others a different action may be
8947 taken. Such variations are mentioned in the documentation of the option that is
8948 being expanded.
8949
8950
8951
8952
8953 .section "Expansion items" "SECTexpansionitems"
8954 The following items are recognized in expanded strings. White space may be used
8955 between sub-items that are keywords or substrings enclosed in braces inside an
8956 outer set of braces, to improve readability. &*Warning*&: Within braces,
8957 white space is significant.
8958
8959 .vlist
8960 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8961 .cindex "expansion" "variables"
8962 Substitute the contents of the named variable, for example:
8963 .code
8964 $local_part
8965 ${domain}
8966 .endd
8967 The second form can be used to separate the name from subsequent alphanumeric
8968 characters. This form (using braces) is available only for variables; it does
8969 &'not'& apply to message headers. The names of the variables are given in
8970 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8971 given, the expansion fails.
8972
8973 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8974 .cindex "expansion" "operators"
8975 The string is first itself expanded, and then the operation specified by
8976 <&'op'&> is applied to it. For example:
8977 .code
8978 ${lc:$local_part}
8979 .endd
8980 The string starts with the first character after the colon, which may be
8981 leading white space. A list of operators is given in section &<<SECTexpop>>&
8982 below. The operator notation is used for simple expansion items that have just
8983 one argument, because it reduces the number of braces and therefore makes the
8984 string easier to understand.
8985
8986 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8987 This item inserts &"basic"& header lines. It is described with the &%header%&
8988 expansion item below.
8989
8990
8991 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8992 .cindex "expansion" "calling an acl"
8993 .cindex "&%acl%&" "call from expansion"
8994 The name and zero to nine argument strings are first expanded separately.  The expanded
8995 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8996 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8997 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8998 and may use the variables; if another acl expansion is used the values
8999 are restored after it returns.  If the ACL sets
9000 a value using a "message =" modifier and returns accept or deny, the value becomes
9001 the result of the expansion.
9002 If no message is set and the ACL returns accept or deny
9003 the expansion result is an empty string.
9004 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9005
9006
9007 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9008        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9009 .cindex "expansion" "extracting cerificate fields"
9010 .cindex "&%certextract%&" "certificate fields"
9011 .cindex "certificate" "extracting fields"
9012 The <&'certificate'&> must be a variable of type certificate.
9013 The field name is expanded and used to retrieve the relevant field from
9014 the certificate.  Supported fields are:
9015 .display
9016 &`version        `&
9017 &`serial_number  `&
9018 &`subject        `& RFC4514 DN
9019 &`issuer         `& RFC4514 DN
9020 &`notbefore      `& time
9021 &`notafter       `& time
9022 &`sig_algorithm  `&
9023 &`signature      `&
9024 &`subj_altname   `& tagged list
9025 &`ocsp_uri       `& list
9026 &`crl_uri        `& list
9027 .endd
9028 If the field is found,
9029 <&'string2'&> is expanded, and replaces the whole item;
9030 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9031 variable &$value$& contains the value that has been extracted. Afterwards, it
9032 is restored to any previous value it might have had.
9033
9034 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9035 key is not found. If {<&'string2'&>} is also omitted, the value that was
9036 extracted is used.
9037
9038 Some field names take optional modifiers, appended and separated by commas.
9039
9040 The field selectors marked as "RFC4514" above
9041 output a Distinguished Name string which is
9042 not quite
9043 parseable by Exim as a comma-separated tagged list
9044 (the exceptions being elements containing commas).
9045 RDN elements of a single type may be selected by
9046 a modifier of the type label; if so the expansion
9047 result is a list (newline-separated by default).
9048 The separator may be changed by another modifier of
9049 a right angle-bracket followed immediately by the new separator.
9050 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9051
9052 The field selectors marked as "time" above
9053 take an optional modifier of "int"
9054 for which the result is the number of seconds since epoch.
9055 Otherwise the result is a human-readable string
9056 in the timezone selected by the main "timezone" option.
9057
9058 The field selectors marked as "list" above return a list,
9059 newline-separated by default,
9060 (embedded separator characters in elements are doubled).
9061 The separator may be changed by a modifier of
9062 a right angle-bracket followed immediately by the new separator.
9063
9064 The field selectors marked as "tagged" above
9065 prefix each list element with a type string and an equals sign.
9066 Elements of only one type may be selected by a modifier
9067 which is one of "dns", "uri" or "mail";
9068 if so the element tags are omitted.
9069
9070 If not otherwise noted field values are presented in human-readable form.
9071
9072 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9073        {*&<&'arg'&>&*}...}*&"
9074 .cindex &%dlfunc%&
9075 This expansion dynamically loads and then calls a locally-written C function.
9076 This functionality is available only if Exim is compiled with
9077 .code
9078 EXPAND_DLFUNC=yes
9079 .endd
9080 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9081 object so that it doesn't reload the same object file in the same Exim process
9082 (but of course Exim does start new processes frequently).
9083
9084 There may be from zero to eight arguments to the function. When compiling
9085 a local function that is to be called in this way, &_local_scan.h_& should be
9086 included. The Exim variables and functions that are defined by that API
9087 are also available for dynamically loaded functions. The function itself
9088 must have the following type:
9089 .code
9090 int dlfunction(uschar **yield, int argc, uschar *argv[])
9091 .endd
9092 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9093 function should return one of the following values:
9094
9095 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9096 into the expanded string that is being built.
9097
9098 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9099 from &'yield'&, if it is set.
9100
9101 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9102 taken from &'yield'& if it is set.
9103
9104 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9105
9106 When compiling a function that is to be used in this way with gcc,
9107 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9108 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9109
9110
9111 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9112 .cindex "expansion" "extracting value from environment"
9113 .cindex "environment" "value from"
9114 The key is first expanded separately, and leading and trailing white space
9115 removed.
9116 This is then searched for as a name in the environment.
9117 If a variable is found then its value is placed in &$value$&
9118 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9119
9120 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9121 appear, for example:
9122 .code
9123 ${env{USER}{$value} fail }
9124 .endd
9125 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9126 {<&'string1'&>} must be present for &"fail"& to be recognized.
9127
9128 If {<&'string2'&>} is omitted an empty string is substituted on
9129 search failure.
9130 If {<&'string1'&>} is omitted the search result is substituted on
9131 search success.
9132
9133
9134 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9135        {*&<&'string3'&>&*}}*&"
9136 .cindex "expansion" "extracting substrings by key"
9137 .cindex "&%extract%&" "substrings by key"
9138 The key and <&'string1'&> are first expanded separately. Leading and trailing
9139 white space is removed from the key (but not from any of the strings). The key
9140 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9141 form:
9142 .display
9143 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9144 .endd
9145 .vindex "&$value$&"
9146 where the equals signs and spaces (but not both) are optional. If any of the
9147 values contain white space, they must be enclosed in double quotes, and any
9148 values that are enclosed in double quotes are subject to escape processing as
9149 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9150 for the value that corresponds to the key. The search is case-insensitive. If
9151 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9152 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9153 variable &$value$& contains the value that has been extracted. Afterwards, it
9154 is restored to any previous value it might have had.
9155
9156 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9157 key is not found. If {<&'string2'&>} is also omitted, the value that was
9158 extracted is used. Thus, for example, these two expansions are identical, and
9159 yield &"2001"&:
9160 .code
9161 ${extract{gid}{uid=1984 gid=2001}}
9162 ${extract{gid}{uid=1984 gid=2001}{$value}}
9163 .endd
9164 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9165 appear, for example:
9166 .code
9167 ${extract{Z}{A=... B=...}{$value} fail }
9168 .endd
9169 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9170 {<&'string2'&>} must be present for &"fail"& to be recognized.
9171
9172
9173 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9174         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9175 .cindex "expansion" "extracting substrings by number"
9176 .cindex "&%extract%&" "substrings by number"
9177 The <&'number'&> argument must consist entirely of decimal digits,
9178 apart from leading and trailing white space, which is ignored.
9179 This is what distinguishes this form of &%extract%& from the previous kind. It
9180 behaves in the same way, except that, instead of extracting a named field, it
9181 extracts from <&'string1'&> the field whose number is given as the first
9182 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9183 <&'string3'&> as before.
9184
9185 The fields in the string are separated by any one of the characters in the
9186 separator string. These may include space or tab characters.
9187 The first field is numbered one. If the number is negative, the fields are
9188 counted from the end of the string, with the rightmost one numbered -1. If the
9189 number given is zero, the entire string is returned. If the modulus of the
9190 number is greater than the number of fields in the string, the result is the
9191 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9192 provided. For example:
9193 .code
9194 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9195 .endd
9196 yields &"42"&, and
9197 .code
9198 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9199 .endd
9200 yields &"99"&. Two successive separators mean that the field between them is
9201 empty (for example, the fifth field above).
9202
9203
9204 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9205 .cindex "list" "selecting by condition"
9206 .cindex "expansion" "selecting from list by condition"
9207 .vindex "&$item$&"
9208 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9209 default, but the separator can be changed in the usual way. For each item
9210 in this list, its value is place in &$item$&, and then the condition is
9211 evaluated. If the condition is true, &$item$& is added to the output as an
9212 item in a new list; if the condition is false, the item is discarded. The
9213 separator used for the output list is the same as the one used for the
9214 input, but a separator setting is not included in the output. For example:
9215 .code
9216 ${filter{a:b:c}{!eq{$item}{b}}
9217 .endd
9218 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9219 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9220
9221
9222 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9223 .cindex "hash function" "textual"
9224 .cindex "expansion" "textual hash"
9225 This is a textual hashing function, and was the first to be implemented in
9226 early versions of Exim. In current releases, there are other hashing functions
9227 (numeric, MD5, and SHA-1), which are described below.
9228
9229 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9230 <&'n'&>. If you are using fixed values for these numbers, that is, if
9231 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9232 use the simpler operator notation that avoids some of the braces:
9233 .code
9234 ${hash_<n>_<m>:<string>}
9235 .endd
9236 The second number is optional (in both notations). If <&'n'&> is greater than
9237 or equal to the length of the string, the expansion item returns the string.
9238 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9239 function to the string. The new string consists of characters taken from the
9240 first <&'m'&> characters of the string
9241 .code
9242 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9243 .endd
9244 If <&'m'&> is not present the value 26 is used, so that only lower case
9245 letters appear. For example:
9246 .display
9247 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9248 &`$hash{5}{monty}}           `&   yields  &`monty`&
9249 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9250 .endd
9251
9252 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9253         &*$h_*&<&'header&~name'&>&*:*&" &&&
9254        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9255         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9256        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9257         &*$rh_*&<&'header&~name'&>&*:*&"
9258 .cindex "expansion" "header insertion"
9259 .vindex "&$header_$&"
9260 .vindex "&$bheader_$&"
9261 .vindex "&$rheader_$&"
9262 .cindex "header lines" "in expansion strings"
9263 .cindex "header lines" "character sets"
9264 .cindex "header lines" "decoding"
9265 Substitute the contents of the named message header line, for example
9266 .code
9267 $header_reply-to:
9268 .endd
9269 The newline that terminates a header line is not included in the expansion, but
9270 internal newlines (caused by splitting the header line over several physical
9271 lines) may be present.
9272
9273 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9274 the data in the header line is interpreted.
9275
9276 .ilist
9277 .cindex "white space" "in header lines"
9278 &%rheader%& gives the original &"raw"& content of the header line, with no
9279 processing at all, and without the removal of leading and trailing white space.
9280
9281 .next
9282 .cindex "base64 encoding" "in header lines"
9283 &%bheader%& removes leading and trailing white space, and then decodes base64
9284 or quoted-printable MIME &"words"& within the header text, but does no
9285 character set translation. If decoding of what looks superficially like a MIME
9286 &"word"& fails, the raw string is returned. If decoding
9287 .cindex "binary zero" "in header line"
9288 produces a binary zero character, it is replaced by a question mark &-- this is
9289 what Exim does for binary zeros that are actually received in header lines.
9290
9291 .next
9292 &%header%& tries to translate the string as decoded by &%bheader%& to a
9293 standard character set. This is an attempt to produce the same string as would
9294 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9295 returned. Translation is attempted only on operating systems that support the
9296 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9297 a system Makefile or in &_Local/Makefile_&.
9298 .endlist ilist
9299
9300 In a filter file, the target character set for &%header%& can be specified by a
9301 command of the following form:
9302 .code
9303 headers charset "UTF-8"
9304 .endd
9305 This command affects all references to &$h_$& (or &$header_$&) expansions in
9306 subsequently obeyed filter commands. In the absence of this command, the target
9307 character set in a filter is taken from the setting of the &%headers_charset%&
9308 option in the runtime configuration. The value of this option defaults to the
9309 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9310 ISO-8859-1.
9311
9312 Header names follow the syntax of RFC 2822, which states that they may contain
9313 any printing characters except space and colon. Consequently, curly brackets
9314 &'do not'& terminate header names, and should not be used to enclose them as
9315 if they were variables. Attempting to do so causes a syntax error.
9316
9317 Only header lines that are common to all copies of a message are visible to
9318 this mechanism. These are the original header lines that are received with the
9319 message, and any that are added by an ACL statement or by a system
9320 filter. Header lines that are added to a particular copy of a message by a
9321 router or transport are not accessible.
9322
9323 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9324 before the DATA ACL, because the header structure is not set up until the
9325 message is received. Header lines that are added in a RCPT ACL (for example)
9326 are saved until the message's incoming header lines are available, at which
9327 point they are added. When a DATA ACL is running, however, header lines added
9328 by earlier ACLs are visible.
9329
9330 Upper case and lower case letters are synonymous in header names. If the
9331 following character is white space, the terminating colon may be omitted, but
9332 this is not recommended, because you may then forget it when it is needed. When
9333 white space terminates the header name, this white space is included in the
9334 expanded string.  If the message does not contain the given header, the
9335 expansion item is replaced by an empty string. (See the &%def%& condition in
9336 section &<<SECTexpcond>>& for a means of testing for the existence of a
9337 header.)
9338
9339 If there is more than one header with the same name, they are all concatenated
9340 to form the substitution string, up to a maximum length of 64K. Unless
9341 &%rheader%& is being used, leading and trailing white space is removed from
9342 each header before concatenation, and a completely empty header is ignored. A
9343 newline character is then inserted between non-empty headers, but there is no
9344 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9345 those headers that contain lists of addresses, a comma is also inserted at the
9346 junctions between headers. This does not happen for the &%rheader%& expansion.
9347
9348
9349 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9350 .cindex "expansion" "hmac hashing"
9351 .cindex &%hmac%&
9352 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9353 shared secret and some text into a message authentication code, as specified in
9354 RFC 2104. This differs from &`${md5:secret_text...}`& or
9355 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9356 cryptographic hash, allowing for authentication that is not possible with MD5
9357 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9358 present. For example:
9359 .code
9360 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9361 .endd
9362 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9363 produces:
9364 .code
9365 dd97e3ba5d1a61b5006108f8c8252953
9366 .endd
9367 As an example of how this might be used, you might put in the main part of
9368 an Exim configuration:
9369 .code
9370 SPAMSCAN_SECRET=cohgheeLei2thahw
9371 .endd
9372 In a router or a transport you could then have:
9373 .code
9374 headers_add = \
9375   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9376   ${hmac{md5}{SPAMSCAN_SECRET}\
9377   {${primary_hostname},${message_exim_id},$h_message-id:}}
9378 .endd
9379 Then given a message, you can check where it was scanned by looking at the
9380 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9381 this header line is authentic by recomputing the authentication code from the
9382 host name, message ID and the &'Message-id:'& header line. This can be done
9383 using Exim's &%-be%& option, or by other means, for example by using the
9384 &'hmac_md5_hex()'& function in Perl.
9385
9386
9387 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9388 .cindex "expansion" "conditional"
9389 .cindex "&%if%&, expansion item"
9390 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9391 item; otherwise <&'string2'&> is used. The available conditions are described
9392 in section &<<SECTexpcond>>& below. For example:
9393 .code
9394 ${if eq {$local_part}{postmaster} {yes}{no} }
9395 .endd
9396 The second string need not be present; if it is not and the condition is not
9397 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9398 be present instead of the second string (without any curly brackets). In this
9399 case, the expansion is forced to fail if the condition is not true (see section
9400 &<<SECTforexpfai>>&).
9401
9402 If both strings are omitted, the result is the string &`true`& if the condition
9403 is true, and the empty string if the condition is false. This makes it less
9404 cumbersome to write custom ACL and router conditions. For example, instead of
9405 .code
9406 condition = ${if >{$acl_m4}{3}{true}{false}}
9407 .endd
9408 you can use
9409 .code
9410 condition = ${if >{$acl_m4}{3}}
9411 .endd
9412
9413
9414
9415 .new
9416 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9417 .cindex expansion "imap folder"
9418 .cindex "&%imapfolder%& expansion item"
9419 This item converts a (possibly multilevel, or with non-ASCII characters)
9420 folder specification to a Maildir name for filesystem use.
9421 For information on internationalisation support see &<<SECTi18nMDA>>&.
9422 .wen
9423
9424
9425
9426 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9427 .cindex "expansion" "string truncation"
9428 .cindex "&%length%& expansion item"
9429 The &%length%& item is used to extract the initial portion of a string. Both
9430 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9431 you are using a fixed value for the number, that is, if <&'string1'&> does not
9432 change when expanded, you can use the simpler operator notation that avoids
9433 some of the braces:
9434 .code
9435 ${length_<n>:<string>}
9436 .endd
9437 The result of this item is either the first <&'n'&> characters or the whole
9438 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9439 &%strlen%&, which gives the length of a string.
9440
9441
9442 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9443         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9444 .cindex "expansion" "extracting list elements by number"
9445 .cindex "&%listextract%&" "extract list elements by number"
9446 .cindex "list" "extracting elements by number"
9447 The <&'number'&> argument must consist entirely of decimal digits,
9448 apart from an optional leading minus,
9449 and leading and trailing white space (which is ignored).
9450
9451 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9452 default, but the separator can be changed in the usual way.
9453
9454 The first field of the list is numbered one.
9455 If the number is negative, the fields are
9456 counted from the end of the list, with the rightmost one numbered -1.
9457 The numbered element of the list is extracted and placed in &$value$&,
9458 then <&'string2'&> is expanded as the result.
9459
9460 If the modulus of the
9461 number is zero or greater than the number of fields in the string,
9462 the result is the expansion of <&'string3'&>.
9463
9464 For example:
9465 .code
9466 ${listextract{2}{x:42:99}}
9467 .endd
9468 yields &"42"&, and
9469 .code
9470 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9471 .endd
9472 yields &"result: 42"&.
9473
9474 If {<&'string3'&>} is omitted, an empty string is used for string3.
9475 If {<&'string2'&>} is also omitted, the value that was
9476 extracted is used.
9477 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9478
9479
9480 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9481         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9482 This is the first of one of two different types of lookup item, which are both
9483 described in the next item.
9484
9485 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9486         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9487 .cindex "expansion" "lookup in"
9488 .cindex "file" "lookups"
9489 .cindex "lookup" "in expanded string"
9490 The two forms of lookup item specify data lookups in files and databases, as
9491 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9492 lookups, and the second is used for query-style lookups. The <&'key'&>,
9493 <&'file'&>, and <&'query'&> strings are expanded before use.
9494
9495 If there is any white space in a lookup item which is part of a filter command,
9496 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9497 other place where white space is significant, the lookup item must be enclosed
9498 in double quotes. The use of data lookups in users' filter files may be locked
9499 out by the system administrator.
9500
9501 .vindex "&$value$&"
9502 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9503 During its expansion, the variable &$value$& contains the data returned by the
9504 lookup. Afterwards it reverts to the value it had previously (at the outer
9505 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9506 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9507 string on failure. If <&'string2'&> is provided, it can itself be a nested
9508 lookup, thus providing a mechanism for looking up a default value when the
9509 original lookup fails.
9510
9511 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9512 data for the outer lookup while the parameters of the second lookup are
9513 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9514 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9515 appear, and in this case, if the lookup fails, the entire expansion is forced
9516 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9517 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9518 successful lookup, and nothing in the case of failure.
9519
9520 For single-key lookups, the string &"partial"& is permitted to precede the
9521 search type in order to do partial matching, and * or *@ may follow a search
9522 type to request default lookups if the key does not match (see sections
9523 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9524
9525 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9526 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9527 and non-wild parts of the key during the expansion of the replacement text.
9528 They return to their previous values at the end of the lookup item.
9529
9530 This example looks up the postmaster alias in the conventional alias file:
9531 .code
9532 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9533 .endd
9534 This example uses NIS+ to look up the full name of the user corresponding to
9535 the local part of an address, forcing the expansion to fail if it is not found:
9536 .code
9537 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9538   {$value}fail}
9539 .endd
9540
9541
9542 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9543 .cindex "expansion" "list creation"
9544 .vindex "&$item$&"
9545 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9546 default, but the separator can be changed in the usual way. For each item
9547 in this list, its value is place in &$item$&, and then <&'string2'&> is
9548 expanded and added to the output as an item in a new list. The separator used
9549 for the output list is the same as the one used for the input, but a separator
9550 setting is not included in the output. For example:
9551 .code
9552 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9553 .endd
9554 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9555 value of &$item$& is restored to what it was before. See also the &*filter*&
9556 and &*reduce*& expansion items.
9557
9558 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9559 .cindex "expansion" "numeric hash"
9560 .cindex "hash function" "numeric"
9561 The three strings are expanded; the first two must yield numbers. Call them
9562 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9563 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9564 can use the simpler operator notation that avoids some of the braces:
9565 .code
9566 ${nhash_<n>_<m>:<string>}
9567 .endd
9568 The second number is optional (in both notations). If there is only one number,
9569 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9570 processed by a div/mod hash function that returns two numbers, separated by a
9571 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9572 example,
9573 .code
9574 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9575 .endd
9576 returns the string &"6/33"&.
9577
9578
9579
9580 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9581 .cindex "Perl" "use in expanded string"
9582 .cindex "expansion" "calling Perl from"
9583 This item is available only if Exim has been built to include an embedded Perl
9584 interpreter. The subroutine name and the arguments are first separately
9585 expanded, and then the Perl subroutine is called with those arguments. No
9586 additional arguments need be given; the maximum number permitted, including the
9587 name of the subroutine, is nine.
9588
9589 The return value of the subroutine is inserted into the expanded string, unless
9590 the return value is &%undef%&. In that case, the expansion fails in the same
9591 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9592 Whatever you return is evaluated in a scalar context. For example, if you
9593 return the name of a Perl vector, the return value is the size of the vector,
9594 not its contents.
9595
9596 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9597 with the error message that was passed to &%die%&. More details of the embedded
9598 Perl facility are given in chapter &<<CHAPperl>>&.
9599
9600 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9601 out the use of this expansion item in filter files.
9602
9603
9604 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9605 .cindex "&%prvs%& expansion item"
9606 The first argument is a complete email address and the second is secret
9607 keystring. The third argument, specifying a key number, is optional. If absent,
9608 it defaults to 0. The result of the expansion is a prvs-signed email address,
9609 to be typically used with the &%return_path%& option on an &(smtp)& transport
9610 as part of a bounce address tag validation (BATV) scheme. For more discussion
9611 and an example, see section &<<SECTverifyPRVS>>&.
9612
9613 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9614         {*&<&'string'&>&*}}*&"
9615 .cindex "&%prvscheck%& expansion item"
9616 This expansion item is the complement of the &%prvs%& item. It is used for
9617 checking prvs-signed addresses. If the expansion of the first argument does not
9618 yield a syntactically valid prvs-signed address, the whole item expands to the
9619 empty string. When the first argument does expand to a syntactically valid
9620 prvs-signed address, the second argument is expanded, with the prvs-decoded
9621 version of the address and the key number extracted from the address in the
9622 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9623
9624 These two variables can be used in the expansion of the second argument to
9625 retrieve the secret. The validity of the prvs-signed address is then checked
9626 against the secret. The result is stored in the variable &$prvscheck_result$&,
9627 which is empty for failure or &"1"& for success.
9628
9629 The third argument is optional; if it is missing, it defaults to an empty
9630 string. This argument is now expanded. If the result is an empty string, the
9631 result of the expansion is the decoded version of the address. This is the case
9632 whether or not the signature was valid. Otherwise, the result of the expansion
9633 is the expansion of the third argument.
9634
9635 All three variables can be used in the expansion of the third argument.
9636 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9637 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9638
9639 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9640 .cindex "expansion" "inserting an entire file"
9641 .cindex "file" "inserting into expansion"
9642 .cindex "&%readfile%& expansion item"
9643 The file name and end-of-line string are first expanded separately. The file is
9644 then read, and its contents replace the entire item. All newline characters in
9645 the file are replaced by the end-of-line string if it is present. Otherwise,
9646 newlines are left in the string.
9647 String expansion is not applied to the contents of the file. If you want this,
9648 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9649 the string expansion fails.
9650
9651 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9652 locks out the use of this expansion item in filter files.
9653
9654
9655
9656 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9657         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9658 .cindex "expansion" "inserting from a socket"
9659 .cindex "socket, use of in expansion"
9660 .cindex "&%readsocket%& expansion item"
9661 This item inserts data from a Unix domain or TCP socket into the expanded
9662 string. The minimal way of using it uses just two arguments, as in these
9663 examples:
9664 .code
9665 ${readsocket{/socket/name}{request string}}
9666 ${readsocket{inet:some.host:1234}{request string}}
9667 .endd
9668 For a Unix domain socket, the first substring must be the path to the socket.
9669 For an Internet socket, the first substring must contain &`inet:`& followed by
9670 a host name or IP address, followed by a colon and a port, which can be a
9671 number or the name of a TCP port in &_/etc/services_&. An IP address may
9672 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9673 example:
9674 .code
9675 ${readsocket{inet:[::1]:1234}{request string}}
9676 .endd
9677 Only a single host name may be given, but if looking it up yields more than
9678 one IP address, they are each tried in turn until a connection is made. For
9679 both kinds of socket, Exim makes a connection, writes the request string
9680 unless it is an empty string; and no terminating NUL is ever sent)
9681 and reads from the socket until an end-of-file
9682 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9683 extend what can be done. Firstly, you can vary the timeout. For example:
9684 .code
9685 ${readsocket{/socket/name}{request string}{3s}}
9686 .endd
9687 A fourth argument allows you to change any newlines that are in the data
9688 that is read, in the same way as for &%readfile%& (see above). This example
9689 turns them into spaces:
9690 .code
9691 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9692 .endd
9693 As with all expansions, the substrings are expanded before the processing
9694 happens. Errors in these sub-expansions cause the expansion to fail. In
9695 addition, the following errors can occur:
9696
9697 .ilist
9698 Failure to create a socket file descriptor;
9699 .next
9700 Failure to connect the socket;
9701 .next
9702 Failure to write the request string;
9703 .next
9704 Timeout on reading from the socket.
9705 .endlist
9706
9707 By default, any of these errors causes the expansion to fail. However, if
9708 you supply a fifth substring, it is expanded and used when any of the above
9709 errors occurs. For example:
9710 .code
9711 ${readsocket{/socket/name}{request string}{3s}{\n}\
9712   {socket failure}}
9713 .endd
9714 You can test for the existence of a Unix domain socket by wrapping this
9715 expansion in &`${if exists`&, but there is a race condition between that test
9716 and the actual opening of the socket, so it is safer to use the fifth argument
9717 if you want to be absolutely sure of avoiding an expansion error for a
9718 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9719
9720 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9721 locks out the use of this expansion item in filter files.
9722
9723
9724 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9725 .cindex "expansion" "reducing a list to a scalar"
9726 .cindex "list" "reducing to a scalar"
9727 .vindex "&$value$&"
9728 .vindex "&$item$&"
9729 This operation reduces a list to a single, scalar string. After expansion,
9730 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9731 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9732 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9733 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9734 them. The result of that expansion is assigned to &$value$& before the next
9735 iteration. When the end of the list is reached, the final value of &$value$& is
9736 added to the expansion output. The &*reduce*& expansion item can be used in a
9737 number of ways. For example, to add up a list of numbers:
9738 .code
9739 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9740 .endd
9741 The result of that expansion would be &`6`&. The maximum of a list of numbers
9742 can be found:
9743 .code
9744 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9745 .endd
9746 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9747 restored to what they were before. See also the &*filter*& and &*map*&
9748 expansion items.
9749
9750 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9751 This item inserts &"raw"& header lines. It is described with the &%header%&
9752 expansion item above.
9753
9754 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9755         {*&<&'string2'&>&*}}*&"
9756 .cindex "expansion" "running a command"
9757 .cindex "&%run%& expansion item"
9758 The command and its arguments are first expanded as one string. The string is
9759 split apart into individual arguments by spaces, and then the command is run
9760 in a separate process, but under the same uid and gid.  As in other command
9761 executions from Exim, a shell is not used by default. If the command requires
9762 a shell, you must explicitly code it.
9763
9764 Since the arguments are split by spaces, when there is a variable expansion
9765 which has an empty result, it will cause the situation that the argument will
9766 simply be omitted when the program is actually executed by Exim. If the
9767 script/program requires a specific number of arguments and the expanded
9768 variable could possibly result in this empty expansion, the variable must be
9769 quoted. This is more difficult if the expanded variable itself could result
9770 in a string containing quotes, because it would interfere with the quotes
9771 around the command arguments. A possible guard against this is to wrap the
9772 variable in the &%sg%& operator to change any quote marks to some other
9773 character.
9774
9775 The standard input for the command exists, but is empty. The standard output
9776 and standard error are set to the same file descriptor.
9777 .cindex "return code" "from &%run%& expansion"
9778 .vindex "&$value$&"
9779 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9780 and replaces the entire item; during this expansion, the standard output/error
9781 from the command is in the variable &$value$&. If the command fails,
9782 <&'string2'&>, if present, is expanded and used. Once again, during the
9783 expansion, the standard output/error from the command is in the variable
9784 &$value$&.
9785
9786 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9787 can be the word &"fail"& (not in braces) to force expansion failure if the
9788 command does not succeed. If both strings are omitted, the result is contents
9789 of the standard output/error on success, and nothing on failure.
9790
9791 .vindex "&$run_in_acl$&"
9792 The standard output/error of the command is put in the variable &$value$&.
9793 In this ACL example, the output of a command is logged for the admin to
9794 troubleshoot:
9795 .code
9796 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9797       log_message  = Output of id: $value
9798 .endd
9799 If the command requires shell idioms, such as the > redirect operator, the
9800 shell must be invoked directly, such as with:
9801 .code
9802 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9803 .endd
9804
9805 .vindex "&$runrc$&"
9806 The return code from the command is put in the variable &$runrc$&, and this
9807 remains set afterwards, so in a filter file you can do things like this:
9808 .code
9809 if "${run{x y z}{}}$runrc" is 1 then ...
9810   elif $runrc is 2 then ...
9811   ...
9812 endif
9813 .endd
9814 If execution of the command fails (for example, the command does not exist),
9815 the return code is 127 &-- the same code that shells use for non-existent
9816 commands.
9817
9818 &*Warning*&: In a router or transport, you cannot assume the order in which
9819 option values are expanded, except for those preconditions whose order of
9820 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9821 by the expansion of one option, and use it in another.
9822
9823 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9824 out the use of this expansion item in filter files.
9825
9826
9827 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9828 .cindex "expansion" "string substitution"
9829 .cindex "&%sg%& expansion item"
9830 This item works like Perl's substitution operator (s) with the global (/g)
9831 option; hence its name. However, unlike the Perl equivalent, Exim does not
9832 modify the subject string; instead it returns the modified string for insertion
9833 into the overall expansion. The item takes three arguments: the subject string,
9834 a regular expression, and a substitution string. For example:
9835 .code
9836 ${sg{abcdefabcdef}{abc}{xyz}}
9837 .endd
9838 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9839 if any $ or \ characters are required in the regular expression or in the
9840 substitution string, they have to be escaped. For example:
9841 .code
9842 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9843 .endd
9844 yields &"defabc"&, and
9845 .code
9846 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9847 .endd
9848 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9849 the regular expression from string expansion.
9850
9851
9852
9853 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9854 .cindex sorting "a list"
9855 .cindex list sorting
9856 .cindex expansion "list sorting"
9857 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9858 default, but the separator can be changed in the usual way.
9859 The <&'comparator'&> argument is interpreted as the operator
9860 of a two-argument expansion condition.
9861 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9862 The comparison should return true when applied to two values
9863 if the first value should sort before the second value.
9864 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9865 the element being placed in &$item$&,
9866 to give values for comparison.
9867
9868 The item result is a sorted list,
9869 with the original list separator,
9870 of the list elements (in full) of the original.
9871
9872 Examples:
9873 .code
9874 ${sort{3:2:1:4}{<}{$item}}
9875 .endd
9876 sorts a list of numbers, and
9877 .code
9878 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9879 .endd
9880 will sort an MX lookup into priority order.
9881
9882
9883 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9884 .cindex "&%substr%& expansion item"
9885 .cindex "substring extraction"
9886 .cindex "expansion" "substring extraction"
9887 The three strings are expanded; the first two must yield numbers. Call them
9888 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9889 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9890 can use the simpler operator notation that avoids some of the braces:
9891 .code
9892 ${substr_<n>_<m>:<string>}
9893 .endd
9894 The second number is optional (in both notations).
9895 If it is absent in the simpler format, the preceding underscore must also be
9896 omitted.
9897
9898 The &%substr%& item can be used to extract more general substrings than
9899 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9900 length required. For example
9901 .code
9902 ${substr{3}{2}{$local_part}}
9903 .endd
9904 If the starting offset is greater than the string length the result is the
9905 null string; if the length plus starting offset is greater than the string
9906 length, the result is the right-hand part of the string, starting from the
9907 given offset. The first character in the string has offset zero.
9908
9909 The &%substr%& expansion item can take negative offset values to count
9910 from the right-hand end of its operand. The last character is offset -1, the
9911 second-last is offset -2, and so on. Thus, for example,
9912 .code
9913 ${substr{-5}{2}{1234567}}
9914 .endd
9915 yields &"34"&. If the absolute value of a negative offset is greater than the
9916 length of the string, the substring starts at the beginning of the string, and
9917 the length is reduced by the amount of overshoot. Thus, for example,
9918 .code
9919 ${substr{-5}{2}{12}}
9920 .endd
9921 yields an empty string, but
9922 .code
9923 ${substr{-3}{2}{12}}
9924 .endd
9925 yields &"1"&.
9926
9927 When the second number is omitted from &%substr%&, the remainder of the string
9928 is taken if the offset is positive. If it is negative, all characters in the
9929 string preceding the offset point are taken. For example, an offset of -1 and
9930 no length, as in these semantically identical examples:
9931 .code
9932 ${substr_-1:abcde}
9933 ${substr{-1}{abcde}}
9934 .endd
9935 yields all but the last character of the string, that is, &"abcd"&.
9936
9937
9938
9939 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9940         {*&<&'replacements'&>&*}}*&"
9941 .cindex "expansion" "character translation"
9942 .cindex "&%tr%& expansion item"
9943 This item does single-character translation on its subject string. The second
9944 argument is a list of characters to be translated in the subject string. Each
9945 matching character is replaced by the corresponding character from the
9946 replacement list. For example
9947 .code
9948 ${tr{abcdea}{ac}{13}}
9949 .endd
9950 yields &`1b3de1`&. If there are duplicates in the second character string, the
9951 last occurrence is used. If the third string is shorter than the second, its
9952 last character is replicated. However, if it is empty, no translation takes
9953 place.
9954 .endlist
9955
9956
9957
9958 .section "Expansion operators" "SECTexpop"
9959 .cindex "expansion" "operators"
9960 For expansion items that perform transformations on a single argument string,
9961 the &"operator"& notation is used because it is simpler and uses fewer braces.
9962 The substring is first expanded before the operation is applied to it. The
9963 following operations can be performed:
9964
9965 .vlist
9966 .vitem &*${address:*&<&'string'&>&*}*&
9967 .cindex "expansion" "RFC 2822 address handling"
9968 .cindex "&%address%& expansion item"
9969 The string is interpreted as an RFC 2822 address, as it might appear in a
9970 header line, and the effective address is extracted from it. If the string does
9971 not parse successfully, the result is empty.
9972
9973
9974 .vitem &*${addresses:*&<&'string'&>&*}*&
9975 .cindex "expansion" "RFC 2822 address handling"
9976 .cindex "&%addresses%& expansion item"
9977 The string (after expansion) is interpreted as a list of addresses in RFC
9978 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9979 operative address (&'local-part@domain'&) is extracted from each item, and the
9980 result of the expansion is a colon-separated list, with appropriate
9981 doubling of colons should any happen to be present in the email addresses.
9982 Syntactically invalid RFC2822 address items are omitted from the output.
9983
9984 It is possible to specify a character other than colon for the output
9985 separator by starting the string with > followed by the new separator
9986 character. For example:
9987 .code
9988 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9989 .endd
9990 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9991 expansion item, which extracts the working address from a single RFC2822
9992 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9993 processing lists.
9994
9995 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9996 a strict interpretation of header line formatting.  Exim parses the bare,
9997 unquoted portion of an email address and if it finds a comma, treats it as an
9998 email address separator. For the example header line:
9999 .code
10000 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10001 .endd
10002 The first example below demonstrates that Q-encoded email addresses are parsed
10003 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10004 It does not see the comma because it's still encoded as "=2C".  The second
10005 example below is passed the contents of &`$header_from:`&, meaning it gets
10006 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10007 The third example shows that the presence of a comma is skipped when it is
10008 quoted.
10009 .code
10010 # exim -be '${addresses:From: \
10011 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10012 user@example.com
10013 # exim -be '${addresses:From: Last, First <user@example.com>}'
10014 Last:user@example.com
10015 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10016 user@example.com
10017 .endd
10018
10019 .vitem &*${base62:*&<&'digits'&>&*}*&
10020 .cindex "&%base62%& expansion item"
10021 .cindex "expansion" "conversion to base 62"
10022 The string must consist entirely of decimal digits. The number is converted to
10023 base 62 and output as a string of six characters, including leading zeros. In
10024 the few operating environments where Exim uses base 36 instead of base 62 for
10025 its message identifiers (because those systems do not have case-sensitive file
10026 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10027 be absolutely clear: this is &'not'& base64 encoding.
10028
10029 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10030 .cindex "&%base62d%& expansion item"
10031 .cindex "expansion" "conversion to base 62"
10032 The string must consist entirely of base-62 digits, or, in operating
10033 environments where Exim uses base 36 instead of base 62 for its message
10034 identifiers, base-36 digits. The number is converted to decimal and output as a
10035 string.
10036
10037 .new
10038 .vitem &*${base64:*&<&'string'&>&*}*&
10039 .cindex "expansion" "base64 encoding"
10040 .cindex "base64 encoding" "in string expansion"
10041 .cindex "&%base64%& expansion item"
10042 .cindex certificate "base64 of DER"
10043 This operator converts a string into one that is base64 encoded.
10044
10045 If the string is a single variable of type certificate,
10046 returns the base64 encoding of the DER form of the certificate.
10047
10048
10049 .vitem &*${base64d:*&<&'string'&>&*}*&
10050 .cindex "expansion" "base64 decoding"
10051 .cindex "base64 decoding" "in string expansion"
10052 .cindex "&%base64d%& expansion item"
10053 This operator converts a base64-encoded string into the un-coded form.
10054 .wen
10055
10056
10057 .vitem &*${domain:*&<&'string'&>&*}*&
10058 .cindex "domain" "extraction"
10059 .cindex "expansion" "domain extraction"
10060 The string is interpreted as an RFC 2822 address and the domain is extracted
10061 from it. If the string does not parse successfully, the result is empty.
10062
10063
10064 .vitem &*${escape:*&<&'string'&>&*}*&
10065 .cindex "expansion" "escaping non-printing characters"
10066 .cindex "&%escape%& expansion item"
10067 If the string contains any non-printing characters, they are converted to
10068 escape sequences starting with a backslash. Whether characters with the most
10069 significant bit set (so-called &"8-bit characters"&) count as printing or not
10070 is controlled by the &%print_topbitchars%& option.
10071
10072
10073 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10074 .cindex "expansion" "expression evaluation"
10075 .cindex "expansion" "arithmetic expression"
10076 .cindex "&%eval%& expansion item"
10077 These items supports simple arithmetic and bitwise logical operations in
10078 expansion strings. The string (after expansion) must be a conventional
10079 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10080 logical operators, and parentheses. All operations are carried out using
10081 integer arithmetic. The operator priorities are as follows (the same as in the
10082 C programming language):
10083 .table2 70pt 300pt
10084 .irow &'highest:'& "not (~), negate (-)"
10085 .irow ""   "multiply (*), divide (/), remainder (%)"
10086 .irow ""   "plus (+), minus (-)"
10087 .irow ""   "shift-left (<<), shift-right (>>)"
10088 .irow ""   "and (&&)"
10089 .irow ""   "xor (^)"
10090 .irow &'lowest:'&  "or (|)"
10091 .endtable
10092 Binary operators with the same priority are evaluated from left to right. White
10093 space is permitted before or after operators.
10094
10095 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10096 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10097 decimal, even if they start with a leading zero; hexadecimal numbers are not
10098 permitted. This can be useful when processing numbers extracted from dates or
10099 times, which often do have leading zeros.
10100
10101 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10102 or 1024*1024*1024,
10103 respectively. Negative numbers are supported. The result of the computation is
10104 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10105
10106 .display
10107 &`${eval:1+1}            `&  yields 2
10108 &`${eval:1+2*3}          `&  yields 7
10109 &`${eval:(1+2)*3}        `&  yields 9
10110 &`${eval:2+42%5}         `&  yields 4
10111 &`${eval:0xc&amp;5}          `&  yields 4
10112 &`${eval:0xc|5}          `&  yields 13
10113 &`${eval:0xc^5}          `&  yields 9
10114 &`${eval:0xc>>1}         `&  yields 6
10115 &`${eval:0xc<<1}         `&  yields 24
10116 &`${eval:~255&amp;0x1234}    `&  yields 4608
10117 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10118 .endd
10119
10120 As a more realistic example, in an ACL you might have
10121 .code
10122 deny   message = Too many bad recipients
10123        condition =                    \
10124          ${if and {                   \
10125            {>{$rcpt_count}{10}}       \
10126            {                          \
10127            <                          \
10128              {$recipients_count}      \
10129              {${eval:$rcpt_count/2}}  \
10130            }                          \
10131          }{yes}{no}}
10132 .endd
10133 The condition is true if there have been more than 10 RCPT commands and
10134 fewer than half of them have resulted in a valid recipient.
10135
10136
10137 .vitem &*${expand:*&<&'string'&>&*}*&
10138 .cindex "expansion" "re-expansion of substring"
10139 The &%expand%& operator causes a string to be expanded for a second time. For
10140 example,
10141 .code
10142 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10143 .endd
10144 first looks up a string in a file while expanding the operand for &%expand%&,
10145 and then re-expands what it has found.
10146
10147
10148 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10149 .cindex "Unicode"
10150 .cindex "UTF-8" "conversion from"
10151 .cindex "expansion" "UTF-8 conversion"
10152 .cindex "&%from_utf8%& expansion item"
10153 The world is slowly moving towards Unicode, although there are no standards for
10154 email yet. However, other applications (including some databases) are starting
10155 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10156 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10157 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10158 the result is an undefined sequence of bytes.
10159
10160 Unicode code points with values less than 256 are compatible with ASCII and
10161 ISO-8859-1 (also known as Latin-1).
10162 For example, character 169 is the copyright symbol in both cases, though the
10163 way it is encoded is different. In UTF-8, more than one byte is needed for
10164 characters with code values greater than 127, whereas ISO-8859-1 is a
10165 single-byte encoding (but thereby limited to 256 characters). This makes
10166 translation from UTF-8 to ISO-8859-1 straightforward.
10167
10168
10169 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10170 .cindex "hash function" "textual"
10171 .cindex "expansion" "textual hash"
10172 The &%hash%& operator is a simpler interface to the hashing function that can
10173 be used when the two parameters are fixed numbers (as opposed to strings that
10174 change when expanded). The effect is the same as
10175 .code
10176 ${hash{<n>}{<m>}{<string>}}
10177 .endd
10178 See the description of the general &%hash%& item above for details. The
10179 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10180
10181
10182
10183 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10184 .cindex "base64 encoding" "conversion from hex"
10185 .cindex "expansion" "hex to base64"
10186 .cindex "&%hex2b64%& expansion item"
10187 This operator converts a hex string into one that is base64 encoded. This can
10188 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10189
10190
10191
10192 .vitem &*${hexquote:*&<&'string'&>&*}*&
10193 .cindex "quoting" "hex-encoded unprintable characters"
10194 .cindex "&%hexquote%& expansion item"
10195 This operator converts non-printable characters in a string into a hex
10196 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10197 as is, and other byte values are converted to &`\xNN`&, for example a
10198 byte value 127 is converted to &`\x7f`&.
10199
10200
10201 .new
10202 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10203 .cindex "&%ipv6denorm%& expansion item"
10204 .cindex "IP address" normalisation
10205 This expands an IPv6 address to a full eight-element colon-separated set
10206 of hex digits including leading zeroes.
10207 A trailing ipv4-style dotted-decimal set is converted to hex.
10208 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10209
10210 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10211 .cindex "&%ipv6norm%& expansion item"
10212 .cindex "IP address" normalisation
10213 .cindex "IP address" "canonical form"
10214 This converts an IPv6 address to canonical form.
10215 Leading zeroes of groups are omitted, and the longest
10216 set of zero-valued groups is replaced with a double colon.
10217 A trailing ipv4-style dotted-decimal set is converted to hex.
10218 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10219 .wen
10220
10221
10222 .vitem &*${lc:*&<&'string'&>&*}*&
10223 .cindex "case forcing in strings"
10224 .cindex "string" "case forcing"
10225 .cindex "lower casing"
10226 .cindex "expansion" "case forcing"
10227 .cindex "&%lc%& expansion item"
10228 This forces the letters in the string into lower-case, for example:
10229 .code
10230 ${lc:$local_part}
10231 .endd
10232
10233 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10234 .cindex "expansion" "string truncation"
10235 .cindex "&%length%& expansion item"
10236 The &%length%& operator is a simpler interface to the &%length%& function that
10237 can be used when the parameter is a fixed number (as opposed to a string that
10238 changes when expanded). The effect is the same as
10239 .code
10240 ${length{<number>}{<string>}}
10241 .endd
10242 See the description of the general &%length%& item above for details. Note that
10243 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10244 when &%length%& is used as an operator.
10245
10246
10247 .vitem &*${listcount:*&<&'string'&>&*}*&
10248 .cindex "expansion" "list item count"
10249 .cindex "list" "item count"
10250 .cindex "list" "count of items"
10251 .cindex "&%listcount%& expansion item"
10252 The string is interpreted as a list and the number of items is returned.
10253
10254
10255 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10256 .cindex "expansion" "named list"
10257 .cindex "&%listnamed%& expansion item"
10258 The name is interpreted as a named list and the content of the list is returned,
10259 expanding any referenced lists, re-quoting as needed for colon-separation.
10260 If the optional type is given it must be one of "a", "d", "h" or "l"
10261 and selects address-, domain-, host- or localpart- lists to search among respectively.
10262 Otherwise all types are searched in an undefined order and the first
10263 matching list is returned.
10264
10265
10266 .vitem &*${local_part:*&<&'string'&>&*}*&
10267 .cindex "expansion" "local part extraction"
10268 .cindex "&%local_part%& expansion item"
10269 The string is interpreted as an RFC 2822 address and the local part is
10270 extracted from it. If the string does not parse successfully, the result is
10271 empty.
10272
10273
10274 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10275 .cindex "masked IP address"
10276 .cindex "IP address" "masking"
10277 .cindex "CIDR notation"
10278 .cindex "expansion" "IP address masking"
10279 .cindex "&%mask%& expansion item"
10280 If the form of the string to be operated on is not an IP address followed by a
10281 slash and an integer (that is, a network address in CIDR notation), the
10282 expansion fails. Otherwise, this operator converts the IP address to binary,
10283 masks off the least significant bits according to the bit count, and converts
10284 the result back to text, with mask appended. For example,
10285 .code
10286 ${mask:10.111.131.206/28}
10287 .endd
10288 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10289 be mostly used for looking up masked addresses in files, the result for an IPv6
10290 address uses dots to separate components instead of colons, because colon
10291 terminates a key string in lsearch files. So, for example,
10292 .code
10293 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10294 .endd
10295 returns the string
10296 .code
10297 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10298 .endd
10299 Letters in IPv6 addresses are always output in lower case.
10300
10301
10302 .vitem &*${md5:*&<&'string'&>&*}*&
10303 .cindex "MD5 hash"
10304 .cindex "expansion" "MD5 hash"
10305 .cindex certificate fingerprint
10306 .cindex "&%md5%& expansion item"
10307 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10308 as a 32-digit hexadecimal number, in which any letters are in lower case.
10309
10310 If the string is a single variable of type certificate,
10311 returns the MD5 hash fingerprint of the certificate.
10312
10313
10314 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10315 .cindex "expansion" "numeric hash"
10316 .cindex "hash function" "numeric"
10317 The &%nhash%& operator is a simpler interface to the numeric hashing function
10318 that can be used when the two parameters are fixed numbers (as opposed to
10319 strings that change when expanded). The effect is the same as
10320 .code
10321 ${nhash{<n>}{<m>}{<string>}}
10322 .endd
10323 See the description of the general &%nhash%& item above for details.
10324
10325
10326 .vitem &*${quote:*&<&'string'&>&*}*&
10327 .cindex "quoting" "in string expansions"
10328 .cindex "expansion" "quoting"
10329 .cindex "&%quote%& expansion item"
10330 The &%quote%& operator puts its argument into double quotes if it
10331 is an empty string or
10332 contains anything other than letters, digits, underscores, dots, and hyphens.
10333 Any occurrences of double quotes and backslashes are escaped with a backslash.
10334 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10335 respectively For example,
10336 .code
10337 ${quote:ab"*"cd}
10338 .endd
10339 becomes
10340 .code
10341 "ab\"*\"cd"
10342 .endd
10343 The place where this is useful is when the argument is a substitution from a
10344 variable or a message header.
10345
10346 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10347 .cindex "&%quote_local_part%& expansion item"
10348 This operator is like &%quote%&, except that it quotes the string only if
10349 required to do so by the rules of RFC 2822 for quoting local parts. For
10350 example, a plus sign would not cause quoting (but it would for &%quote%&).
10351 If you are creating a new email address from the contents of &$local_part$&
10352 (or any other unknown data), you should always use this operator.
10353
10354
10355 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10356 .cindex "quoting" "lookup-specific"
10357 This operator applies lookup-specific quoting rules to the string. Each
10358 query-style lookup type has its own quoting rules which are described with
10359 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10360 .code
10361 ${quote_ldap:two * two}
10362 .endd
10363 returns
10364 .code
10365 two%20%5C2A%20two
10366 .endd
10367 For single-key lookup types, no quoting is ever necessary and this operator
10368 yields an unchanged string.
10369
10370
10371 .vitem &*${randint:*&<&'n'&>&*}*&
10372 .cindex "random number"
10373 This operator returns a somewhat random number which is less than the
10374 supplied number and is at least 0.  The quality of this randomness depends
10375 on how Exim was built; the values are not suitable for keying material.
10376 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10377 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10378 for versions of GnuTLS with that function.
10379 Otherwise, the implementation may be arc4random(), random() seeded by
10380 srandomdev() or srandom(), or a custom implementation even weaker than
10381 random().
10382
10383
10384 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10385 .cindex "expansion" "IP address"
10386 This operator reverses an IP address; for IPv4 addresses, the result is in
10387 dotted-quad decimal form, while for IPv6 addresses the result is in
10388 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10389 for DNS.  For example,
10390 .code
10391 ${reverse_ip:192.0.2.4}
10392 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10393 .endd
10394 returns
10395 .code
10396 4.2.0.192
10397 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
10398 .endd
10399
10400
10401 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10402 .cindex "expansion" "RFC 2047"
10403 .cindex "RFC 2047" "expansion operator"
10404 .cindex "&%rfc2047%& expansion item"
10405 This operator encodes text according to the rules of RFC 2047. This is an
10406 encoding that is used in header lines to encode non-ASCII characters. It is
10407 assumed that the input string is in the encoding specified by the
10408 &%headers_charset%& option, which gets its default at build time. If the string
10409 contains only characters in the range 33&--126, and no instances of the
10410 characters
10411 .code
10412 ? = ( ) < > @ , ; : \ " . [ ] _
10413 .endd
10414 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10415 string, using as many &"encoded words"& as necessary to encode all the
10416 characters.
10417
10418
10419 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10420 .cindex "expansion" "RFC 2047"
10421 .cindex "RFC 2047" "decoding"
10422 .cindex "&%rfc2047d%& expansion item"
10423 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10424 bytes are replaced by question marks. Characters are converted into the
10425 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10426 not recognized unless &%check_rfc2047_length%& is set false.
10427
10428 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10429 access a header line, RFC 2047 decoding is done automatically. You do not need
10430 to use this operator as well.
10431
10432
10433
10434 .vitem &*${rxquote:*&<&'string'&>&*}*&
10435 .cindex "quoting" "in regular expressions"
10436 .cindex "regular expressions" "quoting"
10437 .cindex "&%rxquote%& expansion item"
10438 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10439 characters in its argument. This is useful when substituting the values of
10440 variables or headers inside regular expressions.
10441
10442
10443 .vitem &*${sha1:*&<&'string'&>&*}*&
10444 .cindex "SHA-1 hash"
10445 .cindex "expansion" "SHA-1 hashing"
10446 .cindex certificate fingerprint
10447 .cindex "&%sha2%& expansion item"
10448 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10449 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10450
10451 If the string is a single variable of type certificate,
10452 returns the SHA-1 hash fingerprint of the certificate.
10453
10454
10455 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10456 .cindex "SHA-256 hash"
10457 .cindex certificate fingerprint
10458 .cindex "expansion" "SHA-256 hashing"
10459 .cindex "&%sha256%& expansion item"
10460 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10461 certificate,
10462 and returns
10463 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10464 Only arguments which are a single variable of certificate type are supported.
10465
10466
10467 .vitem &*${stat:*&<&'string'&>&*}*&
10468 .cindex "expansion" "statting a file"
10469 .cindex "file" "extracting characteristics"
10470 .cindex "&%stat%& expansion item"
10471 The string, after expansion, must be a file path. A call to the &[stat()]&
10472 function is made for this path. If &[stat()]& fails, an error occurs and the
10473 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10474 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10475 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10476 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10477 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10478 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10479 can extract individual fields using the &%extract%& expansion item.
10480
10481 The use of the &%stat%& expansion in users' filter files can be locked out by
10482 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10483 systems for files larger than 2GB.
10484
10485 .vitem &*${str2b64:*&<&'string'&>&*}*&
10486 .cindex "&%str2b64%& expansion item"
10487 .new
10488 Now deprecated, a synonym for the &%base64%& expansion operator.
10489 .wen
10490
10491
10492
10493 .vitem &*${strlen:*&<&'string'&>&*}*&
10494 .cindex "expansion" "string length"
10495 .cindex "string" "length in expansion"
10496 .cindex "&%strlen%& expansion item"
10497 The item is replace by the length of the expanded string, expressed as a
10498 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10499
10500
10501 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10502 .cindex "&%substr%& expansion item"
10503 .cindex "substring extraction"
10504 .cindex "expansion" "substring expansion"
10505 The &%substr%& operator is a simpler interface to the &%substr%& function that
10506 can be used when the two parameters are fixed numbers (as opposed to strings
10507 that change when expanded). The effect is the same as
10508 .code
10509 ${substr{<start>}{<length>}{<string>}}
10510 .endd
10511 See the description of the general &%substr%& item above for details. The
10512 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10513
10514 .vitem &*${time_eval:*&<&'string'&>&*}*&
10515 .cindex "&%time_eval%& expansion item"
10516 .cindex "time interval" "decoding"
10517 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10518 seconds.
10519
10520 .vitem &*${time_interval:*&<&'string'&>&*}*&
10521 .cindex "&%time_interval%& expansion item"
10522 .cindex "time interval" "formatting"
10523 The argument (after sub-expansion) must be a sequence of decimal digits that
10524 represents an interval of time as a number of seconds. It is converted into a
10525 number of larger units and output in Exim's normal time format, for example,
10526 &`1w3d4h2m6s`&.
10527
10528 .vitem &*${uc:*&<&'string'&>&*}*&
10529 .cindex "case forcing in strings"
10530 .cindex "string" "case forcing"
10531 .cindex "upper casing"
10532 .cindex "expansion" "case forcing"
10533 .cindex "&%uc%& expansion item"
10534 This forces the letters in the string into upper-case.
10535
10536 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10537 .cindex "correction of invalid utf-8 sequences in strings"
10538 .cindex "utf-8" "utf-8 sequences"
10539 .cindex "incorrect utf-8"
10540 .cindex "expansion" "utf-8 forcing"
10541 .cindex "&%utf8clean%& expansion item"
10542 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10543
10544 .new
10545 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10546        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10547        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10548        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10549 .cindex expansion UTF-8
10550 .cindex UTF-8 expansion
10551 .cindex EAI
10552 .cindex internationalisation
10553 .cindex "&%utf8_domain_to_alabel%& expansion item"
10554 .cindex "&%utf8_domain_from_alabel%& expansion item"
10555 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10556 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10557 These convert EAI mail name components between UTF-8 and a-label forms.
10558 For information on internationalisation support see &<<SECTi18nMTA>>&.
10559 .wen
10560 .endlist
10561
10562
10563
10564
10565
10566
10567 .section "Expansion conditions" "SECTexpcond"
10568 .scindex IIDexpcond "expansion" "conditions"
10569 The following conditions are available for testing by the &%${if%& construct
10570 while expanding strings:
10571
10572 .vlist
10573 .vitem &*!*&<&'condition'&>
10574 .cindex "expansion" "negating a condition"
10575 .cindex "negation" "in expansion condition"
10576 Preceding any condition with an exclamation mark negates the result of the
10577 condition.
10578
10579 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10580 .cindex "numeric comparison"
10581 .cindex "expansion" "numeric comparison"
10582 There are a number of symbolic operators for doing numeric comparisons. They
10583 are:
10584 .display
10585 &`=   `&   equal
10586 &`==  `&   equal
10587 &`>   `&   greater
10588 &`>=  `&   greater or equal
10589 &`<   `&   less
10590 &`<=  `&   less or equal
10591 .endd
10592 For example:
10593 .code
10594 ${if >{$message_size}{10M} ...
10595 .endd
10596 Note that the general negation operator provides for inequality testing. The
10597 two strings must take the form of optionally signed decimal integers,
10598 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10599 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10600 As a special case, the numerical value of an empty string is taken as
10601 zero.
10602
10603 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10604 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10605 10M, not if 10M is larger than &$message_size$&.
10606
10607
10608 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10609         {*&<&'arg2'&>&*}...}*&
10610 .cindex "expansion" "calling an acl"
10611 .cindex "&%acl%&" "expansion condition"
10612 The name and zero to nine argument strings are first expanded separately.  The expanded
10613 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10614 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10615 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10616 and may use the variables; if another acl expansion is used the values
10617 are restored after it returns.  If the ACL sets
10618 a value using a "message =" modifier the variable $value becomes
10619 the result of the expansion, otherwise it is empty.
10620 If the ACL returns accept the condition is true; if deny, false.
10621 If the ACL returns defer the result is a forced-fail.
10622
10623 .vitem &*bool&~{*&<&'string'&>&*}*&
10624 .cindex "expansion" "boolean parsing"
10625 .cindex "&%bool%& expansion condition"
10626 This condition turns a string holding a true or false representation into
10627 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10628 (case-insensitively); also integer numbers map to true if non-zero,
10629 false if zero.
10630 An empty string is treated as false.
10631 Leading and trailing whitespace is ignored;
10632 thus a string consisting only of whitespace is false.
10633 All other string values will result in expansion failure.
10634
10635 When combined with ACL variables, this expansion condition will let you
10636 make decisions in one place and act on those decisions in another place.
10637 For example:
10638 .code
10639 ${if bool{$acl_m_privileged_sender} ...
10640 .endd
10641
10642
10643 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10644 .cindex "expansion" "boolean parsing"
10645 .cindex "&%bool_lax%& expansion condition"
10646 Like &%bool%&, this condition turns a string into a boolean state.  But
10647 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10648 loose definition that the Router &%condition%& option uses.  The empty string
10649 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10650 true.  Leading and trailing whitespace is ignored.
10651
10652 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10653
10654 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10655 .cindex "expansion" "encrypted comparison"
10656 .cindex "encrypted strings, comparing"
10657 .cindex "&%crypteq%& expansion condition"
10658 This condition is included in the Exim binary if it is built to support any
10659 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10660 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10661 included in the binary.
10662
10663 The &%crypteq%& condition has two arguments. The first is encrypted and
10664 compared against the second, which is already encrypted. The second string may
10665 be in the LDAP form for storing encrypted strings, which starts with the
10666 encryption type in curly brackets, followed by the data. If the second string
10667 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10668 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10669 Typically this will be a field from a password file. An example of an encrypted
10670 string in LDAP form is:
10671 .code
10672 {md5}CY9rzUYh03PK3k6DJie09g==
10673 .endd
10674 If such a string appears directly in an expansion, the curly brackets have to
10675 be quoted, because they are part of the expansion syntax. For example:
10676 .code
10677 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10678 .endd
10679 The following encryption types (whose names are matched case-independently) are
10680 supported:
10681
10682 .ilist
10683 .cindex "MD5 hash"
10684 .cindex "base64 encoding" "in encrypted password"
10685 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10686 printable characters to compare with the remainder of the second string. If the
10687 length of the comparison string is 24, Exim assumes that it is base64 encoded
10688 (as in the above example). If the length is 32, Exim assumes that it is a
10689 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10690 comparison fails.
10691
10692 .next
10693 .cindex "SHA-1 hash"
10694 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10695 printable characters to compare with the remainder of the second string. If the
10696 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10697 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10698 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10699
10700 .next
10701 .cindex "&[crypt()]&"
10702 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10703 only the first eight characters of the password. However, in modern operating
10704 systems this is no longer true, and in many cases the entire password is used,
10705 whatever its length.
10706
10707 .next
10708 .cindex "&[crypt16()]&"
10709 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10710 use up to 16 characters of the password in some operating systems. Again, in
10711 modern operating systems, more characters may be used.
10712 .endlist
10713 Exim has its own version of &[crypt16()]&, which is just a double call to
10714 &[crypt()]&. For operating systems that have their own version, setting
10715 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10716 operating system version instead of its own. This option is set by default in
10717 the OS-dependent &_Makefile_& for those operating systems that are known to
10718 support &[crypt16()]&.
10719
10720 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10721 it was not using the same algorithm as some operating systems' versions. It
10722 turns out that as well as &[crypt16()]& there is a function called
10723 &[bigcrypt()]& in some operating systems. This may or may not use the same
10724 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10725
10726 However, since there is now a move away from the traditional &[crypt()]&
10727 functions towards using SHA1 and other algorithms, tidying up this area of
10728 Exim is seen as very low priority.
10729
10730 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10731 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10732 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10733 default is &`{crypt}`&. Whatever the default, you can always use either
10734 function by specifying it explicitly in curly brackets.
10735
10736 .vitem &*def:*&<&'variable&~name'&>
10737 .cindex "expansion" "checking for empty variable"
10738 .cindex "&%def%& expansion condition"
10739 The &%def%& condition must be followed by the name of one of the expansion
10740 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10741 variable does not contain the empty string. For example:
10742 .code
10743 ${if def:sender_ident {from $sender_ident}}
10744 .endd
10745 Note that the variable name is given without a leading &%$%& character. If the
10746 variable does not exist, the expansion fails.
10747
10748 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10749         &~&*def:h_*&<&'header&~name'&>&*:*&"
10750 .cindex "expansion" "checking header line existence"
10751 This condition is true if a message is being processed and the named header
10752 exists in the message. For example,
10753 .code
10754 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10755 .endd
10756 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10757 the header name must be terminated by a colon if white space does not follow.
10758
10759 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10760        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10761 .cindex "string" "comparison"
10762 .cindex "expansion" "string comparison"
10763 .cindex "&%eq%& expansion condition"
10764 .cindex "&%eqi%& expansion condition"
10765 The two substrings are first expanded. The condition is true if the two
10766 resulting strings are identical. For &%eq%& the comparison includes the case of
10767 letters, whereas for &%eqi%& the comparison is case-independent.
10768
10769 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10770 .cindex "expansion" "file existence test"
10771 .cindex "file" "existence test"
10772 .cindex "&%exists%&, expansion condition"
10773 The substring is first expanded and then interpreted as an absolute path. The
10774 condition is true if the named file (or directory) exists. The existence test
10775 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10776 users' filter files may be locked out by the system administrator.
10777
10778 .vitem &*first_delivery*&
10779 .cindex "delivery" "first"
10780 .cindex "first delivery"
10781 .cindex "expansion" "first delivery test"
10782 .cindex "&%first_delivery%& expansion condition"
10783 This condition, which has no data, is true during a message's first delivery
10784 attempt. It is false during any subsequent delivery attempts.
10785
10786
10787 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10788        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10789 .cindex "list" "iterative conditions"
10790 .cindex "expansion" "&*forall*& condition"
10791 .cindex "expansion" "&*forany*& condition"
10792 .vindex "&$item$&"
10793 These conditions iterate over a list. The first argument is expanded to form
10794 the list. By default, the list separator is a colon, but it can be changed by
10795 the normal method. The second argument is interpreted as a condition that is to
10796 be applied to each item in the list in turn. During the interpretation of the
10797 condition, the current list item is placed in a variable called &$item$&.
10798 .ilist
10799 For &*forany*&, interpretation stops if the condition is true for any item, and
10800 the result of the whole condition is true. If the condition is false for all
10801 items in the list, the overall condition is false.
10802 .next
10803 For &*forall*&, interpretation stops if the condition is false for any item,
10804 and the result of the whole condition is false. If the condition is true for
10805 all items in the list, the overall condition is true.
10806 .endlist
10807 Note that negation of &*forany*& means that the condition must be false for all
10808 items for the overall condition to succeed, and negation of &*forall*& means
10809 that the condition must be false for at least one item. In this example, the
10810 list separator is changed to a comma:
10811 .code
10812 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10813 .endd
10814 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10815 being processed, to enable these expansion items to be nested.
10816
10817 To scan a named list, expand it with the &*listnamed*& operator.
10818
10819
10820 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10821        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10822 .cindex "string" "comparison"
10823 .cindex "expansion" "string comparison"
10824 .cindex "&%ge%& expansion condition"
10825 .cindex "&%gei%& expansion condition"
10826 The two substrings are first expanded. The condition is true if the first
10827 string is lexically greater than or equal to the second string. For &%ge%& the
10828 comparison includes the case of letters, whereas for &%gei%& the comparison is
10829 case-independent.
10830
10831 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10832        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10833 .cindex "string" "comparison"
10834 .cindex "expansion" "string comparison"
10835 .cindex "&%gt%& expansion condition"
10836 .cindex "&%gti%& expansion condition"
10837 The two substrings are first expanded. The condition is true if the first
10838 string is lexically greater than the second string. For &%gt%& the comparison
10839 includes the case of letters, whereas for &%gti%& the comparison is
10840 case-independent.
10841
10842 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10843        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10844 .cindex "string" "comparison"
10845 .cindex "list" "iterative conditions"
10846 Both strings are expanded; the second string is treated as a list of simple
10847 strings; if the first string is a member of the second, then the condition
10848 is true.
10849
10850 These are simpler to use versions of the more powerful &*forany*& condition.
10851 Examples, and the &*forany*& equivalents:
10852 .code
10853 ${if inlist{needle}{foo:needle:bar}}
10854   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10855 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10856   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10857 .endd
10858
10859 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10860        &*isip4&~{*&<&'string'&>&*}*& &&&
10861        &*isip6&~{*&<&'string'&>&*}*&
10862 .cindex "IP address" "testing string format"
10863 .cindex "string" "testing for IP address"
10864 .cindex "&%isip%& expansion condition"
10865 .cindex "&%isip4%& expansion condition"
10866 .cindex "&%isip6%& expansion condition"
10867 The substring is first expanded, and then tested to see if it has the form of
10868 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10869 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10870
10871 For an IPv4 address, the test is for four dot-separated components, each of
10872 which consists of from one to three digits. For an IPv6 address, up to eight
10873 colon-separated components are permitted, each containing from one to four
10874 hexadecimal digits. There may be fewer than eight components if an empty
10875 component (adjacent colons) is present. Only one empty component is permitted.
10876
10877 &*Note*&: The checks are just on the form of the address; actual numerical
10878 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10879 check. The main use of these tests is to distinguish between IP addresses and
10880 host names, or between IPv4 and IPv6 addresses. For example, you could use
10881 .code
10882 ${if isip4{$sender_host_address}...
10883 .endd
10884 to test which IP version an incoming SMTP connection is using.
10885
10886 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10887 .cindex "LDAP" "use for authentication"
10888 .cindex "expansion" "LDAP authentication test"
10889 .cindex "&%ldapauth%& expansion condition"
10890 This condition supports user authentication using LDAP. See section
10891 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10892 queries. For this use, the query must contain a user name and password. The
10893 query itself is not used, and can be empty. The condition is true if the
10894 password is not empty, and the user name and password are accepted by the LDAP
10895 server. An empty password is rejected without calling LDAP because LDAP binds
10896 with an empty password are considered anonymous regardless of the username, and
10897 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10898 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10899 this can be used.
10900
10901
10902 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10903        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10904 .cindex "string" "comparison"
10905 .cindex "expansion" "string comparison"
10906 .cindex "&%le%& expansion condition"
10907 .cindex "&%lei%& expansion condition"
10908 The two substrings are first expanded. The condition is true if the first
10909 string is lexically less than or equal to the second string. For &%le%& the
10910 comparison includes the case of letters, whereas for &%lei%& the comparison is
10911 case-independent.
10912
10913 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10914        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10915 .cindex "string" "comparison"
10916 .cindex "expansion" "string comparison"
10917 .cindex "&%lt%& expansion condition"
10918 .cindex "&%lti%& expansion condition"
10919 The two substrings are first expanded. The condition is true if the first
10920 string is lexically less than the second string. For &%lt%& the comparison
10921 includes the case of letters, whereas for &%lti%& the comparison is
10922 case-independent.
10923
10924
10925 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10926 .cindex "expansion" "regular expression comparison"
10927 .cindex "regular expressions" "match in expanded string"
10928 .cindex "&%match%& expansion condition"
10929 The two substrings are first expanded. The second is then treated as a regular
10930 expression and applied to the first. Because of the pre-expansion, if the
10931 regular expression contains dollar, or backslash characters, they must be
10932 escaped. Care must also be taken if the regular expression contains braces
10933 (curly brackets). A closing brace must be escaped so that it is not taken as a
10934 premature termination of <&'string2'&>. The easiest approach is to use the
10935 &`\N`& feature to disable expansion of the regular expression.
10936 For example,
10937 .code
10938 ${if match {$local_part}{\N^\d{3}\N} ...
10939 .endd
10940 If the whole expansion string is in double quotes, further escaping of
10941 backslashes is also required.
10942
10943 The condition is true if the regular expression match succeeds.
10944 The regular expression is not required to begin with a circumflex
10945 metacharacter, but if there is no circumflex, the expression is not anchored,
10946 and it may match anywhere in the subject, not just at the start. If you want
10947 the pattern to match at the end of the subject, you must include the &`$`&
10948 metacharacter at an appropriate point.
10949
10950 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10951 At the start of an &%if%& expansion the values of the numeric variable
10952 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10953 succeeds causes them to be reset to the substrings of that condition and they
10954 will have these values during the expansion of the success string. At the end
10955 of the &%if%& expansion, the previous values are restored. After testing a
10956 combination of conditions using &%or%&, the subsequent values of the numeric
10957 variables are those of the condition that succeeded.
10958
10959 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10960 .cindex "&%match_address%& expansion condition"
10961 See &*match_local_part*&.
10962
10963 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10964 .cindex "&%match_domain%& expansion condition"
10965 See &*match_local_part*&.
10966
10967 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10968 .cindex "&%match_ip%& expansion condition"
10969 This condition matches an IP address to a list of IP address patterns. It must
10970 be followed by two argument strings. The first (after expansion) must be an IP
10971 address or an empty string. The second (not expanded) is a restricted host
10972 list that can match only an IP address, not a host name. For example:
10973 .code
10974 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10975 .endd
10976 The specific types of host list item that are permitted in the list are:
10977
10978 .ilist
10979 An IP address, optionally with a CIDR mask.
10980 .next
10981 A single asterisk, which matches any IP address.
10982 .next
10983 An empty item, which matches only if the IP address is empty. This could be
10984 useful for testing for a locally submitted message or one from specific hosts
10985 in a single test such as
10986 . ==== As this is a nested list, any displays it contains must be indented
10987 . ==== as otherwise they are too far to the left. This comment applies to
10988 . ==== the use of xmlto plus fop. There's no problem when formatting with
10989 . ==== sdop, with or without the extra indent.
10990 .code
10991   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10992 .endd
10993 where the first item in the list is the empty string.
10994 .next
10995 The item @[] matches any of the local host's interface addresses.
10996 .next
10997 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10998 even if &`net-`& is not specified. There is never any attempt to turn the IP
10999 address into a host name. The most common type of linear search for
11000 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11001 masks. For example:
11002 .code
11003   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11004 .endd
11005 It is of course possible to use other kinds of lookup, and in such a case, you
11006 do need to specify the &`net-`& prefix if you want to specify a specific
11007 address mask, for example:
11008 .code
11009   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11010 .endd
11011 However, unless you are combining a &%match_ip%& condition with others, it is
11012 just as easy to use the fact that a lookup is itself a condition, and write:
11013 .code
11014   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11015 .endd
11016 .endlist ilist
11017
11018 Note that <&'string2'&> is not itself subject to string expansion, unless
11019 Exim was built with the EXPAND_LISTMATCH_RHS option.
11020
11021 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11022
11023 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11024 .cindex "domain list" "in expansion condition"
11025 .cindex "address list" "in expansion condition"
11026 .cindex "local part" "list, in expansion condition"
11027 .cindex "&%match_local_part%& expansion condition"
11028 This condition, together with &%match_address%& and &%match_domain%&, make it
11029 possible to test domain, address, and local part lists within expansions. Each
11030 condition requires two arguments: an item and a list to match. A trivial
11031 example is:
11032 .code
11033 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11034 .endd
11035 In each case, the second argument may contain any of the allowable items for a
11036 list of the appropriate type. Also, because the second argument (after
11037 expansion) is a standard form of list, it is possible to refer to a named list.
11038 Thus, you can use conditions like this:
11039 .code
11040 ${if match_domain{$domain}{+local_domains}{...
11041 .endd
11042 .cindex "&`+caseful`&"
11043 For address lists, the matching starts off caselessly, but the &`+caseful`&
11044 item can be used, as in all address lists, to cause subsequent items to
11045 have their local parts matched casefully. Domains are always matched
11046 caselessly.
11047
11048 Note that <&'string2'&> is not itself subject to string expansion, unless
11049 Exim was built with the EXPAND_LISTMATCH_RHS option.
11050
11051 &*Note*&: Host lists are &'not'& supported in this way. This is because
11052 hosts have two identities: a name and an IP address, and it is not clear
11053 how to specify cleanly how such a test would work. However, IP addresses can be
11054 matched using &%match_ip%&.
11055
11056 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11057 .cindex "PAM authentication"
11058 .cindex "AUTH" "with PAM"
11059 .cindex "Solaris" "PAM support"
11060 .cindex "expansion" "PAM authentication test"
11061 .cindex "&%pam%& expansion condition"
11062 &'Pluggable Authentication Modules'&
11063 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11064 available in the latest releases of Solaris and in some GNU/Linux
11065 distributions. The Exim support, which is intended for use in conjunction with
11066 the SMTP AUTH command, is available only if Exim is compiled with
11067 .code
11068 SUPPORT_PAM=yes
11069 .endd
11070 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11071 in some releases of GNU/Linux &%-ldl%& is also needed.
11072
11073 The argument string is first expanded, and the result must be a
11074 colon-separated list of strings. Leading and trailing white space is ignored.
11075 The PAM module is initialized with the service name &"exim"& and the user name
11076 taken from the first item in the colon-separated data string (<&'string1'&>).
11077 The remaining items in the data string are passed over in response to requests
11078 from the authentication function. In the simple case there will only be one
11079 request, for a password, so the data consists of just two strings.
11080
11081 There can be problems if any of the strings are permitted to contain colon
11082 characters. In the usual way, these have to be doubled to avoid being taken as
11083 separators. If the data is being inserted from a variable, the &%sg%& expansion
11084 item can be used to double any existing colons. For example, the configuration
11085 of a LOGIN authenticator might contain this setting:
11086 .code
11087 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11088 .endd
11089 For a PLAIN authenticator you could use:
11090 .code
11091 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11092 .endd
11093 In some operating systems, PAM authentication can be done only from a process
11094 running as root. Since Exim is running as the Exim user when receiving
11095 messages, this means that PAM cannot be used directly in those systems.
11096 A patched version of the &'pam_unix'& module that comes with the
11097 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11098 The patched module allows one special uid/gid combination, in addition to root,
11099 to authenticate. If you build the patched module to allow the Exim user and
11100 group, PAM can then be used from an Exim authenticator.
11101
11102
11103 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11104 .cindex "&'pwcheck'& daemon"
11105 .cindex "Cyrus"
11106 .cindex "expansion" "&'pwcheck'& authentication test"
11107 .cindex "&%pwcheck%& expansion condition"
11108 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11109 This is one way of making it possible for passwords to be checked by a process
11110 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11111 deprecated. Its replacement is &'saslauthd'& (see below).
11112
11113 The pwcheck support is not included in Exim by default. You need to specify
11114 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11115 building Exim. For example:
11116 .code
11117 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11118 .endd
11119 You do not need to install the full Cyrus software suite in order to use
11120 the pwcheck daemon. You can compile and install just the daemon alone
11121 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11122 access to the &_/var/pwcheck_& directory.
11123
11124 The &%pwcheck%& condition takes one argument, which must be the user name and
11125 password, separated by a colon. For example, in a LOGIN authenticator
11126 configuration, you might have this:
11127 .code
11128 server_condition = ${if pwcheck{$auth1:$auth2}}
11129 .endd
11130 Again, for a PLAIN authenticator configuration, this would be:
11131 .code
11132 server_condition = ${if pwcheck{$auth2:$auth3}}
11133 .endd
11134 .vitem &*queue_running*&
11135 .cindex "queue runner" "detecting when delivering from"
11136 .cindex "expansion" "queue runner test"
11137 .cindex "&%queue_running%& expansion condition"
11138 This condition, which has no data, is true during delivery attempts that are
11139 initiated by queue runner processes, and false otherwise.
11140
11141
11142 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11143 .cindex "Radius"
11144 .cindex "expansion" "Radius authentication"
11145 .cindex "&%radius%& expansion condition"
11146 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11147 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11148 the Radius client configuration file in order to build Exim with Radius
11149 support.
11150
11151 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11152 library, using the original API. If you are using release 0.4.0 or later of
11153 this library, you need to set
11154 .code
11155 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11156 .endd
11157 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11158 &%libradius%& library that comes with FreeBSD. To do this, set
11159 .code
11160 RADIUS_LIB_TYPE=RADLIB
11161 .endd
11162 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11163 You may also have to supply a suitable setting in EXTRALIBS so that the
11164 Radius library can be found when Exim is linked.
11165
11166 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11167 Radius client library, which calls the Radius server. The condition is true if
11168 the authentication is successful. For example:
11169 .code
11170 server_condition = ${if radius{<arguments>}}
11171 .endd
11172
11173
11174 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11175         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11176 .cindex "&'saslauthd'& daemon"
11177 .cindex "Cyrus"
11178 .cindex "expansion" "&'saslauthd'& authentication test"
11179 .cindex "&%saslauthd%& expansion condition"
11180 This condition supports user authentication using the Cyrus &'saslauthd'&
11181 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11182 Using this daemon is one way of making it possible for passwords to be checked
11183 by a process that is not running as root.
11184
11185 The saslauthd support is not included in Exim by default. You need to specify
11186 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11187 building Exim. For example:
11188 .code
11189 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11190 .endd
11191 You do not need to install the full Cyrus software suite in order to use
11192 the saslauthd daemon. You can compile and install just the daemon alone
11193 from the Cyrus SASL library.
11194
11195 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11196 two are mandatory. For example:
11197 .code
11198 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11199 .endd
11200 The service and the realm are optional (which is why the arguments are enclosed
11201 in their own set of braces). For details of the meaning of the service and
11202 realm, and how to run the daemon, consult the Cyrus documentation.
11203 .endlist vlist
11204
11205
11206
11207 .section "Combining expansion conditions" "SECID84"
11208 .cindex "expansion" "combining conditions"
11209 Several conditions can be tested at once by combining them using the &%and%&
11210 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11211 conditions on their own, and precede their lists of sub-conditions. Each
11212 sub-condition must be enclosed in braces within the overall braces that contain
11213 the list. No repetition of &%if%& is used.
11214
11215
11216 .vlist
11217 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11218 .cindex "&""or""& expansion condition"
11219 .cindex "expansion" "&""or""& of conditions"
11220 The sub-conditions are evaluated from left to right. The condition is true if
11221 any one of the sub-conditions is true.
11222 For example,
11223 .code
11224 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11225 .endd
11226 When a true sub-condition is found, the following ones are parsed but not
11227 evaluated. If there are several &"match"& sub-conditions the values of the
11228 numeric variables afterwards are taken from the first one that succeeds.
11229
11230 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11231 .cindex "&""and""& expansion condition"
11232 .cindex "expansion" "&""and""& of conditions"
11233 The sub-conditions are evaluated from left to right. The condition is true if
11234 all of the sub-conditions are true. If there are several &"match"&
11235 sub-conditions, the values of the numeric variables afterwards are taken from
11236 the last one. When a false sub-condition is found, the following ones are
11237 parsed but not evaluated.
11238 .endlist
11239 .ecindex IIDexpcond
11240
11241
11242
11243
11244 .section "Expansion variables" "SECTexpvar"
11245 .cindex "expansion" "variables, list of"
11246 This section contains an alphabetical list of all the expansion variables. Some
11247 of them are available only when Exim is compiled with specific options such as
11248 support for TLS or the content scanning extension.
11249
11250 .vlist
11251 .vitem "&$0$&, &$1$&, etc"
11252 .cindex "numerical variables (&$1$& &$2$& etc)"
11253 When a &%match%& expansion condition succeeds, these variables contain the
11254 captured substrings identified by the regular expression during subsequent
11255 processing of the success string of the containing &%if%& expansion item.
11256 In the expansion condition case
11257 they do not retain their values afterwards; in fact, their previous
11258 values are restored at the end of processing an &%if%& item. The numerical
11259 variables may also be set externally by some other matching process which
11260 precedes the expansion of the string. For example, the commands available in
11261 Exim filter files include an &%if%& command with its own regular expression
11262 matching condition.
11263
11264 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11265 Within an acl condition, expansion condition or expansion item
11266 any arguments are copied to these variables,
11267 any unused variables being made empty.
11268
11269 .vitem "&$acl_c...$&"
11270 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11271 can be given any name that starts with &$acl_c$& and is at least six characters
11272 long, but the sixth character must be either a digit or an underscore. For
11273 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11274 variables persist throughout the lifetime of an SMTP connection. They can be
11275 used to pass information between ACLs and between different invocations of the
11276 same ACL. When a message is received, the values of these variables are saved
11277 with the message, and can be accessed by filters, routers, and transports
11278 during subsequent delivery.
11279
11280 .vitem "&$acl_m...$&"
11281 These variables are like the &$acl_c...$& variables, except that their values
11282 are reset after a message has been received. Thus, if several messages are
11283 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11284 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11285 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11286 message is received, the values of these variables are saved with the message,
11287 and can be accessed by filters, routers, and transports during subsequent
11288 delivery.
11289
11290 .vitem &$acl_narg$&
11291 Within an acl condition, expansion condition or expansion item
11292 this variable has the number of arguments.
11293
11294 .vitem &$acl_verify_message$&
11295 .vindex "&$acl_verify_message$&"
11296 After an address verification has failed, this variable contains the failure
11297 message. It retains its value for use in subsequent modifiers. The message can
11298 be preserved by coding like this:
11299 .code
11300 warn !verify = sender
11301      set acl_m0 = $acl_verify_message
11302 .endd
11303 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11304 &%log_message%& modifiers, to include information about the verification
11305 failure.
11306
11307 .vitem &$address_data$&
11308 .vindex "&$address_data$&"
11309 This variable is set by means of the &%address_data%& option in routers. The
11310 value then remains with the address while it is processed by subsequent routers
11311 and eventually a transport. If the transport is handling multiple addresses,
11312 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11313 for more details. &*Note*&: The contents of &$address_data$& are visible in
11314 user filter files.
11315
11316 If &$address_data$& is set when the routers are called from an ACL to verify
11317 a recipient address, the final value is still in the variable for subsequent
11318 conditions and modifiers of the ACL statement. If routing the address caused it
11319 to be redirected to just one address, the child address is also routed as part
11320 of the verification, and in this case the final value of &$address_data$& is
11321 from the child's routing.
11322
11323 If &$address_data$& is set when the routers are called from an ACL to verify a
11324 sender address, the final value is also preserved, but this time in
11325 &$sender_address_data$&, to distinguish it from data from a recipient
11326 address.
11327
11328 In both cases (recipient and sender verification), the value does not persist
11329 after the end of the current ACL statement. If you want to preserve
11330 these values for longer, you can save them in ACL variables.
11331
11332 .vitem &$address_file$&
11333 .vindex "&$address_file$&"
11334 When, as a result of aliasing, forwarding, or filtering, a message is directed
11335 to a specific file, this variable holds the name of the file when the transport
11336 is running. At other times, the variable is empty. For example, using the
11337 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11338 .code
11339 /home/r2d2/savemail
11340 .endd
11341 then when the &(address_file)& transport is running, &$address_file$&
11342 contains the text string &`/home/r2d2/savemail`&.
11343 .cindex "Sieve filter" "value of &$address_file$&"
11344 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11345 then up to the transport configuration to generate an appropriate absolute path
11346 to the relevant file.
11347
11348 .vitem &$address_pipe$&
11349 .vindex "&$address_pipe$&"
11350 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11351 this variable holds the pipe command when the transport is running.
11352
11353 .vitem "&$auth1$& &-- &$auth3$&"
11354 .vindex "&$auth1$&, &$auth2$&, etc"
11355 These variables are used in SMTP authenticators (see chapters
11356 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11357
11358 .vitem &$authenticated_id$&
11359 .cindex "authentication" "id"
11360 .vindex "&$authenticated_id$&"
11361 When a server successfully authenticates a client it may be configured to
11362 preserve some of the authentication information in the variable
11363 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11364 user/password authenticator configuration might preserve the user name for use
11365 in the routers. Note that this is not the same information that is saved in
11366 &$sender_host_authenticated$&.
11367 When a message is submitted locally (that is, not over a TCP connection)
11368 the value of &$authenticated_id$& is normally the login name of the calling
11369 process. However, a trusted user can override this by means of the &%-oMai%&
11370 command line option.
11371
11372 .vitem &$authenticated_fail_id$&
11373 .cindex "authentication" "fail" "id"
11374 .vindex "&$authenticated_fail_id$&"
11375 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11376 will contain the failed authentication id. If more than one authentication
11377 id is attempted, it will contain only the last one. The variable is
11378 available for processing in the ACL's, generally the quit or notquit ACL.
11379 A message to a local recipient could still be accepted without requiring
11380 authentication, which means this variable could also be visible in all of
11381 the ACL's as well.
11382
11383
11384 .vitem &$authenticated_sender$&
11385 .cindex "sender" "authenticated"
11386 .cindex "authentication" "sender"
11387 .cindex "AUTH" "on MAIL command"
11388 .vindex "&$authenticated_sender$&"
11389 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11390 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11391 described in section &<<SECTauthparamail>>&. Unless the data is the string
11392 &"<>"&, it is set as the authenticated sender of the message, and the value is
11393 available during delivery in the &$authenticated_sender$& variable. If the
11394 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11395
11396 .vindex "&$qualify_domain$&"
11397 When a message is submitted locally (that is, not over a TCP connection), the
11398 value of &$authenticated_sender$& is an address constructed from the login
11399 name of the calling process and &$qualify_domain$&, except that a trusted user
11400 can override this by means of the &%-oMas%& command line option.
11401
11402
11403 .vitem &$authentication_failed$&
11404 .cindex "authentication" "failure"
11405 .vindex "&$authentication_failed$&"
11406 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11407 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11408 possible to distinguish between &"did not try to authenticate"&
11409 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11410 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11411 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11412 negative response to an AUTH command, including (for example) an attempt to use
11413 an undefined mechanism.
11414
11415 .vitem &$av_failed$&
11416 .cindex "content scanning" "AV scanner failure"
11417 This variable is available when Exim is compiled with the content-scanning
11418 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11419 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11420 the ACL malware condition.
11421
11422 .vitem &$body_linecount$&
11423 .cindex "message body" "line count"
11424 .cindex "body of message" "line count"
11425 .vindex "&$body_linecount$&"
11426 When a message is being received or delivered, this variable contains the
11427 number of lines in the message's body. See also &$message_linecount$&.
11428
11429 .vitem &$body_zerocount$&
11430 .cindex "message body" "binary zero count"
11431 .cindex "body of message" "binary zero count"
11432 .cindex "binary zero" "in message body"
11433 .vindex "&$body_zerocount$&"
11434 When a message is being received or delivered, this variable contains the
11435 number of binary zero bytes (ASCII NULs) in the message's body.
11436
11437 .vitem &$bounce_recipient$&
11438 .vindex "&$bounce_recipient$&"
11439 This is set to the recipient address of a bounce message while Exim is creating
11440 it. It is useful if a customized bounce message text file is in use (see
11441 chapter &<<CHAPemsgcust>>&).
11442
11443 .vitem &$bounce_return_size_limit$&
11444 .vindex "&$bounce_return_size_limit$&"
11445 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11446 up to a multiple of 1000. It is useful when a customized error message text
11447 file is in use (see chapter &<<CHAPemsgcust>>&).
11448
11449 .vitem &$caller_gid$&
11450 .cindex "gid (group id)" "caller"
11451 .vindex "&$caller_gid$&"
11452 The real group id under which the process that called Exim was running. This is
11453 not the same as the group id of the originator of a message (see
11454 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11455 incarnation normally contains the Exim gid.
11456
11457 .vitem &$caller_uid$&
11458 .cindex "uid (user id)" "caller"
11459 .vindex "&$caller_uid$&"
11460 The real user id under which the process that called Exim was running. This is
11461 not the same as the user id of the originator of a message (see
11462 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11463 incarnation normally contains the Exim uid.
11464
11465 .vitem &$callout_address$&
11466 .vindex "&$callout_address$&"
11467 After a callout for verification, spamd or malware daemon service, the
11468 address that was connected to.
11469
11470 .vitem &$compile_number$&
11471 .vindex "&$compile_number$&"
11472 The building process for Exim keeps a count of the number
11473 of times it has been compiled. This serves to distinguish different
11474 compilations of the same version of the program.
11475
11476 .vitem &$config_dir$&
11477 .vindex "&$config_dir$&"
11478 The directory name of the main configuration file. That is, the content of
11479 &$config_file$& with the last component stripped. The value does not
11480 contain the trailing slash. If &$config_file$& does not contain a slash,
11481 &$config_dir$& is ".".
11482
11483 .vitem &$config_file$&
11484 .vindex "&$config_file$&"
11485 The name of the main configuration file Exim is using.
11486
11487 .vitem &$demime_errorlevel$&
11488 .vindex "&$demime_errorlevel$&"
11489 This variable is available when Exim is compiled with
11490 the content-scanning extension and the obsolete &%demime%& condition. For
11491 details, see section &<<SECTdemimecond>>&.
11492
11493 .vitem &$demime_reason$&
11494 .vindex "&$demime_reason$&"
11495 This variable is available when Exim is compiled with the
11496 content-scanning extension and the obsolete &%demime%& condition. For details,
11497 see section &<<SECTdemimecond>>&.
11498
11499 .vitem &$dkim_cur_signer$& &&&
11500        &$dkim_verify_status$& &&&
11501        &$dkim_verify_reason$& &&&
11502        &$dkim_domain$& &&&
11503        &$dkim_identity$& &&&
11504        &$dkim_selector$& &&&
11505        &$dkim_algo$& &&&
11506        &$dkim_canon_body$& &&&
11507        &$dkim_canon_headers$& &&&
11508        &$dkim_copiedheaders$& &&&
11509        &$dkim_bodylength$& &&&
11510        &$dkim_created$& &&&
11511        &$dkim_expires$& &&&
11512        &$dkim_headernames$& &&&
11513        &$dkim_key_testing$& &&&
11514        &$dkim_key_nosubdomains$& &&&
11515        &$dkim_key_srvtype$& &&&
11516        &$dkim_key_granularity$& &&&
11517        &$dkim_key_notes$& &&&
11518        &$dkim_key_length$&
11519 These variables are only available within the DKIM ACL.
11520 For details see chapter &<<CHAPdkim>>&.
11521
11522 .vitem &$dkim_signers$&
11523 .vindex &$dkim_signers$&
11524 When a message has been received this variable contains
11525 a colon-separated list of signer domains and identities for the message.
11526 For details see chapter &<<CHAPdkim>>&.
11527
11528 .vitem &$dnslist_domain$& &&&
11529        &$dnslist_matched$& &&&
11530        &$dnslist_text$& &&&
11531        &$dnslist_value$&
11532 .vindex "&$dnslist_domain$&"
11533 .vindex "&$dnslist_matched$&"
11534 .vindex "&$dnslist_text$&"
11535 .vindex "&$dnslist_value$&"
11536 .cindex "black list (DNS)"
11537 When a DNS (black) list lookup succeeds, these variables are set to contain
11538 the following data from the lookup: the list's domain name, the key that was
11539 looked up, the contents of any associated TXT record, and the value from the
11540 main A record. See section &<<SECID204>>& for more details.
11541
11542 .vitem &$domain$&
11543 .vindex "&$domain$&"
11544 When an address is being routed, or delivered on its own, this variable
11545 contains the domain. Uppercase letters in the domain are converted into lower
11546 case for &$domain$&.
11547
11548 Global address rewriting happens when a message is received, so the value of
11549 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11550 is set during user filtering, but not during system filtering, because a
11551 message may have many recipients and the system filter is called just once.
11552
11553 When more than one address is being delivered at once (for example, several
11554 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11555 have the same domain. Transports can be restricted to handling only one domain
11556 at a time if the value of &$domain$& is required at transport time &-- this is
11557 the default for local transports. For further details of the environment in
11558 which local transports are run, see chapter &<<CHAPenvironment>>&.
11559
11560 .oindex "&%delay_warning_condition%&"
11561 At the end of a delivery, if all deferred addresses have the same domain, it is
11562 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11563
11564 The &$domain$& variable is also used in some other circumstances:
11565
11566 .ilist
11567 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11568 the recipient address. The domain of the &'sender'& address is in
11569 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11570 normally set during the running of the MAIL ACL. However, if the sender address
11571 is verified with a callout during the MAIL ACL, the sender domain is placed in
11572 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11573 the &(smtp)& transport.
11574
11575 .next
11576 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11577 &$domain$& contains the domain portion of the address that is being rewritten;
11578 it can be used in the expansion of the replacement address, for example, to
11579 rewrite domains by file lookup.
11580
11581 .next
11582 With one important exception, whenever a domain list is being scanned,
11583 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11584 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11585 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11586 that, in a RCPT ACL, the sender domain list can be dependent on the
11587 recipient domain (which is what is in &$domain$& at this time).
11588
11589 .next
11590 .cindex "ETRN" "value of &$domain$&"
11591 .oindex "&%smtp_etrn_command%&"
11592 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11593 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11594 .endlist
11595
11596
11597 .vitem &$domain_data$&
11598 .vindex "&$domain_data$&"
11599 When the &%domains%& option on a router matches a domain by
11600 means of a lookup, the data read by the lookup is available during the running
11601 of the router as &$domain_data$&. In addition, if the driver routes the
11602 address to a transport, the value is available in that transport. If the
11603 transport is handling multiple addresses, the value from the first address is
11604 used.
11605
11606 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11607 domain by means of a lookup. The data read by the lookup is available during
11608 the rest of the ACL statement. In all other situations, this variable expands
11609 to nothing.
11610
11611 .vitem &$exim_gid$&
11612 .vindex "&$exim_gid$&"
11613 This variable contains the numerical value of the Exim group id.
11614
11615 .vitem &$exim_path$&
11616 .vindex "&$exim_path$&"
11617 This variable contains the path to the Exim binary.
11618
11619 .vitem &$exim_uid$&
11620 .vindex "&$exim_uid$&"
11621 This variable contains the numerical value of the Exim user id.
11622
11623 .vitem &$exim_version$&
11624 .vindex "&$exim_version$&"
11625 This variable contains the version string of the Exim build.
11626 The first character is a major version number, currently 4.
11627 Then after a dot, the next group of digits is a minor version number.
11628 There may be other characters following the minor version.
11629
11630 .vitem &$found_extension$&
11631 .vindex "&$found_extension$&"
11632 This variable is available when Exim is compiled with the
11633 content-scanning extension and the obsolete &%demime%& condition. For details,
11634 see section &<<SECTdemimecond>>&.
11635
11636 .vitem &$header_$&<&'name'&>
11637 This is not strictly an expansion variable. It is expansion syntax for
11638 inserting the message header line with the given name. Note that the name must
11639 be terminated by colon or white space, because it may contain a wide variety of
11640 characters. Note also that braces must &'not'& be used.
11641
11642 .vitem &$headers_added$&
11643 .vindex "&$headers_added$&"
11644 Within an ACL this variable contains the headers added so far by
11645 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11646 The headers are a newline-separated list.
11647
11648 .vitem &$home$&
11649 .vindex "&$home$&"
11650 When the &%check_local_user%& option is set for a router, the user's home
11651 directory is placed in &$home$& when the check succeeds. In particular, this
11652 means it is set during the running of users' filter files. A router may also
11653 explicitly set a home directory for use by a transport; this can be overridden
11654 by a setting on the transport itself.
11655
11656 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11657 of the environment variable HOME.
11658
11659 .vitem &$host$&
11660 .vindex "&$host$&"
11661 If a router assigns an address to a transport (any transport), and passes a
11662 list of hosts with the address, the value of &$host$& when the transport starts
11663 to run is the name of the first host on the list. Note that this applies both
11664 to local and remote transports.
11665
11666 .cindex "transport" "filter"
11667 .cindex "filter" "transport filter"
11668 For the &(smtp)& transport, if there is more than one host, the value of
11669 &$host$& changes as the transport works its way through the list. In
11670 particular, when the &(smtp)& transport is expanding its options for encryption
11671 using TLS, or for specifying a transport filter (see chapter
11672 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11673 is connected.
11674
11675 When used in the client part of an authenticator configuration (see chapter
11676 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11677 client is connected.
11678
11679
11680 .vitem &$host_address$&
11681 .vindex "&$host_address$&"
11682 This variable is set to the remote host's IP address whenever &$host$& is set
11683 for a remote connection. It is also set to the IP address that is being checked
11684 when the &%ignore_target_hosts%& option is being processed.
11685
11686 .vitem &$host_data$&
11687 .vindex "&$host_data$&"
11688 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11689 result of the lookup is made available in the &$host_data$& variable. This
11690 allows you, for example, to do things like this:
11691 .code
11692 deny  hosts = net-lsearch;/some/file
11693 message = $host_data
11694 .endd
11695 .vitem &$host_lookup_deferred$&
11696 .cindex "host name" "lookup, failure of"
11697 .vindex "&$host_lookup_deferred$&"
11698 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11699 message comes from a remote host and there is an attempt to look up the host's
11700 name from its IP address, and the attempt is not successful, one of these
11701 variables is set to &"1"&.
11702
11703 .ilist
11704 If the lookup receives a definite negative response (for example, a DNS lookup
11705 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11706
11707 .next
11708 If there is any kind of problem during the lookup, such that Exim cannot
11709 tell whether or not the host name is defined (for example, a timeout for a DNS
11710 lookup), &$host_lookup_deferred$& is set to &"1"&.
11711 .endlist ilist
11712
11713 Looking up a host's name from its IP address consists of more than just a
11714 single reverse lookup. Exim checks that a forward lookup of at least one of the
11715 names it receives from a reverse lookup yields the original IP address. If this
11716 is not the case, Exim does not accept the looked up name(s), and
11717 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11718 IP address (for example, the existence of a PTR record in the DNS) is not
11719 sufficient on its own for the success of a host name lookup. If the reverse
11720 lookup succeeds, but there is a lookup problem such as a timeout when checking
11721 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11722 &"1"&. See also &$sender_host_name$&.
11723
11724 .vitem &$host_lookup_failed$&
11725 .vindex "&$host_lookup_failed$&"
11726 See &$host_lookup_deferred$&.
11727
11728 .vitem &$host_port$&
11729 .vindex "&$host_port$&"
11730 This variable is set to the remote host's TCP port whenever &$host$& is set
11731 for an outbound connection.
11732
11733
11734 .vitem &$inode$&
11735 .vindex "&$inode$&"
11736 The only time this variable is set is while expanding the &%directory_file%&
11737 option in the &(appendfile)& transport. The variable contains the inode number
11738 of the temporary file which is about to be renamed. It can be used to construct
11739 a unique name for the file.
11740
11741 .vitem &$interface_address$&
11742 .vindex "&$interface_address$&"
11743 This is an obsolete name for &$received_ip_address$&.
11744
11745 .vitem &$interface_port$&
11746 .vindex "&$interface_port$&"
11747 This is an obsolete name for &$received_port$&.
11748
11749 .vitem &$item$&
11750 .vindex "&$item$&"
11751 This variable is used during the expansion of &*forall*& and &*forany*&
11752 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11753 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11754 empty.
11755
11756 .vitem &$ldap_dn$&
11757 .vindex "&$ldap_dn$&"
11758 This variable, which is available only when Exim is compiled with LDAP support,
11759 contains the DN from the last entry in the most recently successful LDAP
11760 lookup.
11761
11762 .vitem &$load_average$&
11763 .vindex "&$load_average$&"
11764 This variable contains the system load average, multiplied by 1000 so that it
11765 is an integer. For example, if the load average is 0.21, the value of the
11766 variable is 210. The value is recomputed every time the variable is referenced.
11767
11768 .vitem &$local_part$&
11769 .vindex "&$local_part$&"
11770 When an address is being routed, or delivered on its own, this
11771 variable contains the local part. When a number of addresses are being
11772 delivered together (for example, multiple RCPT commands in an SMTP
11773 session), &$local_part$& is not set.
11774
11775 Global address rewriting happens when a message is received, so the value of
11776 &$local_part$& during routing and delivery is the value after rewriting.
11777 &$local_part$& is set during user filtering, but not during system filtering,
11778 because a message may have many recipients and the system filter is called just
11779 once.
11780
11781 .vindex "&$local_part_prefix$&"
11782 .vindex "&$local_part_suffix$&"
11783 If a local part prefix or suffix has been recognized, it is not included in the
11784 value of &$local_part$& during routing and subsequent delivery. The values of
11785 any prefix or suffix are in &$local_part_prefix$& and
11786 &$local_part_suffix$&, respectively.
11787
11788 When a message is being delivered to a file, pipe, or autoreply transport as a
11789 result of aliasing or forwarding, &$local_part$& is set to the local part of
11790 the parent address, not to the file name or command (see &$address_file$& and
11791 &$address_pipe$&).
11792
11793 When an ACL is running for a RCPT command, &$local_part$& contains the
11794 local part of the recipient address.
11795
11796 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11797 &$local_part$& contains the local part of the address that is being rewritten;
11798 it can be used in the expansion of the replacement address, for example.
11799
11800 In all cases, all quoting is removed from the local part. For example, for both
11801 the addresses
11802 .code
11803 "abc:xyz"@test.example
11804 abc\:xyz@test.example
11805 .endd
11806 the value of &$local_part$& is
11807 .code
11808 abc:xyz
11809 .endd
11810 If you use &$local_part$& to create another address, you should always wrap it
11811 inside a quoting operator. For example, in a &(redirect)& router you could
11812 have:
11813 .code
11814 data = ${quote_local_part:$local_part}@new.domain.example
11815 .endd
11816 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11817 to process local parts in a case-dependent manner in a router, you can set the
11818 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11819
11820 .vitem &$local_part_data$&
11821 .vindex "&$local_part_data$&"
11822 When the &%local_parts%& option on a router matches a local part by means of a
11823 lookup, the data read by the lookup is available during the running of the
11824 router as &$local_part_data$&. In addition, if the driver routes the address
11825 to a transport, the value is available in that transport. If the transport is
11826 handling multiple addresses, the value from the first address is used.
11827
11828 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11829 matches a local part by means of a lookup. The data read by the lookup is
11830 available during the rest of the ACL statement. In all other situations, this
11831 variable expands to nothing.
11832
11833 .vitem &$local_part_prefix$&
11834 .vindex "&$local_part_prefix$&"
11835 When an address is being routed or delivered, and a
11836 specific prefix for the local part was recognized, it is available in this
11837 variable, having been removed from &$local_part$&.
11838
11839 .vitem &$local_part_suffix$&
11840 .vindex "&$local_part_suffix$&"
11841 When an address is being routed or delivered, and a
11842 specific suffix for the local part was recognized, it is available in this
11843 variable, having been removed from &$local_part$&.
11844
11845 .vitem &$local_scan_data$&
11846 .vindex "&$local_scan_data$&"
11847 This variable contains the text returned by the &[local_scan()]& function when
11848 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11849
11850 .vitem &$local_user_gid$&
11851 .vindex "&$local_user_gid$&"
11852 See &$local_user_uid$&.
11853
11854 .vitem &$local_user_uid$&
11855 .vindex "&$local_user_uid$&"
11856 This variable and &$local_user_gid$& are set to the uid and gid after the
11857 &%check_local_user%& router precondition succeeds. This means that their values
11858 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11859 and &%condition%&), for the &%address_data%& expansion, and for any
11860 router-specific expansions. At all other times, the values in these variables
11861 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11862
11863 .vitem &$localhost_number$&
11864 .vindex "&$localhost_number$&"
11865 This contains the expanded value of the
11866 &%localhost_number%& option. The expansion happens after the main options have
11867 been read.
11868
11869 .vitem &$log_inodes$&
11870 .vindex "&$log_inodes$&"
11871 The number of free inodes in the disk partition where Exim's
11872 log files are being written. The value is recalculated whenever the variable is
11873 referenced. If the relevant file system does not have the concept of inodes,
11874 the value of is -1. See also the &%check_log_inodes%& option.
11875
11876 .vitem &$log_space$&
11877 .vindex "&$log_space$&"
11878 The amount of free space (as a number of kilobytes) in the disk
11879 partition where Exim's log files are being written. The value is recalculated
11880 whenever the variable is referenced. If the operating system does not have the
11881 ability to find the amount of free space (only true for experimental systems),
11882 the space value is -1. See also the &%check_log_space%& option.
11883
11884
11885 .vitem &$lookup_dnssec_authenticated$&
11886 .vindex "&$lookup_dnssec_authenticated$&"
11887 This variable is set after a DNS lookup done by
11888 a dnsdb lookup expansion, dnslookup router or smtp transport.
11889 .cindex "DNS" "DNSSEC"
11890 It will be empty if &(DNSSEC)& was not requested,
11891 &"no"& if the result was not labelled as authenticated data
11892 and &"yes"& if it was.
11893 Results that are labelled as authoritative answer that match
11894 the &%dns_trust_aa%& configuration variable count also
11895 as authenticated data.
11896
11897 .vitem &$mailstore_basename$&
11898 .vindex "&$mailstore_basename$&"
11899 This variable is set only when doing deliveries in &"mailstore"& format in the
11900 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11901 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11902 contains the basename of the files that are being written, that is, the name
11903 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11904 variable is empty.
11905
11906 .vitem &$malware_name$&
11907 .vindex "&$malware_name$&"
11908 This variable is available when Exim is compiled with the
11909 content-scanning extension. It is set to the name of the virus that was found
11910 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11911
11912 .vitem &$max_received_linelength$&
11913 .vindex "&$max_received_linelength$&"
11914 .cindex "maximum" "line length"
11915 .cindex "line length" "maximum"
11916 This variable contains the number of bytes in the longest line that was
11917 received as part of the message, not counting the line termination
11918 character(s).
11919
11920 .vitem &$message_age$&
11921 .cindex "message" "age of"
11922 .vindex "&$message_age$&"
11923 This variable is set at the start of a delivery attempt to contain the number
11924 of seconds since the message was received. It does not change during a single
11925 delivery attempt.
11926
11927 .vitem &$message_body$&
11928 .cindex "body of message" "expansion variable"
11929 .cindex "message body" "in expansion"
11930 .cindex "binary zero" "in message body"
11931 .vindex "&$message_body$&"
11932 .oindex "&%message_body_visible%&"
11933 This variable contains the initial portion of a message's body while it is
11934 being delivered, and is intended mainly for use in filter files. The maximum
11935 number of characters of the body that are put into the variable is set by the
11936 &%message_body_visible%& configuration option; the default is 500.
11937
11938 .oindex "&%message_body_newlines%&"
11939 By default, newlines are converted into spaces in &$message_body$&, to make it
11940 easier to search for phrases that might be split over a line break. However,
11941 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11942 zeros are always converted into spaces.
11943
11944 .vitem &$message_body_end$&
11945 .cindex "body of message" "expansion variable"
11946 .cindex "message body" "in expansion"
11947 .vindex "&$message_body_end$&"
11948 This variable contains the final portion of a message's
11949 body while it is being delivered. The format and maximum size are as for
11950 &$message_body$&.
11951
11952 .vitem &$message_body_size$&
11953 .cindex "body of message" "size"
11954 .cindex "message body" "size"
11955 .vindex "&$message_body_size$&"
11956 When a message is being delivered, this variable contains the size of the body
11957 in bytes. The count starts from the character after the blank line that
11958 separates the body from the header. Newlines are included in the count. See
11959 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11960
11961 .vitem &$message_exim_id$&
11962 .vindex "&$message_exim_id$&"
11963 When a message is being received or delivered, this variable contains the
11964 unique message id that is generated and used by Exim to identify the message.
11965 An id is not created for a message until after its header has been successfully
11966 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11967 line; it is the local id that Exim assigns to the message, for example:
11968 &`1BXTIK-0001yO-VA`&.
11969
11970 .vitem &$message_headers$&
11971 .vindex &$message_headers$&
11972 This variable contains a concatenation of all the header lines when a message
11973 is being processed, except for lines added by routers or transports. The header
11974 lines are separated by newline characters. Their contents are decoded in the
11975 same way as a header line that is inserted by &%bheader%&.
11976
11977 .vitem &$message_headers_raw$&
11978 .vindex &$message_headers_raw$&
11979 This variable is like &$message_headers$& except that no processing of the
11980 contents of header lines is done.
11981
11982 .vitem &$message_id$&
11983 This is an old name for &$message_exim_id$&. It is now deprecated.
11984
11985 .vitem &$message_linecount$&
11986 .vindex "&$message_linecount$&"
11987 This variable contains the total number of lines in the header and body of the
11988 message. Compare &$body_linecount$&, which is the count for the body only.
11989 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11990 number of lines received. Before delivery happens (that is, before filters,
11991 routers, and transports run) the count is increased to include the
11992 &'Received:'& header line that Exim standardly adds, and also any other header
11993 lines that are added by ACLs. The blank line that separates the message header
11994 from the body is not counted.
11995
11996 As with the special case of &$message_size$&, during the expansion of the
11997 appendfile transport's maildir_tag option in maildir format, the value of
11998 &$message_linecount$& is the precise size of the number of newlines in the
11999 file that has been written (minus one for the blank line between the
12000 header and the body).
12001
12002 Here is an example of the use of this variable in a DATA ACL:
12003 .code
12004 deny message   = Too many lines in message header
12005      condition = \
12006       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12007 .endd
12008 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12009 message has not yet been received.
12010
12011 .vitem &$message_size$&
12012 .cindex "size" "of message"
12013 .cindex "message" "size"
12014 .vindex "&$message_size$&"
12015 When a message is being processed, this variable contains its size in bytes. In
12016 most cases, the size includes those headers that were received with the
12017 message, but not those (such as &'Envelope-to:'&) that are added to individual
12018 deliveries as they are written. However, there is one special case: during the
12019 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12020 doing a delivery in maildir format, the value of &$message_size$& is the
12021 precise size of the file that has been written. See also
12022 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12023
12024 .cindex "RCPT" "value of &$message_size$&"
12025 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12026 contains the size supplied on the MAIL command, or -1 if no size was given. The
12027 value may not, of course, be truthful.
12028
12029 .vitem &$mime_$&&'xxx'&
12030 A number of variables whose names start with &$mime$& are
12031 available when Exim is compiled with the content-scanning extension. For
12032 details, see section &<<SECTscanmimepart>>&.
12033
12034 .vitem "&$n0$& &-- &$n9$&"
12035 These variables are counters that can be incremented by means
12036 of the &%add%& command in filter files.
12037
12038 .vitem &$original_domain$&
12039 .vindex "&$domain$&"
12040 .vindex "&$original_domain$&"
12041 When a top-level address is being processed for delivery, this contains the
12042 same value as &$domain$&. However, if a &"child"& address (for example,
12043 generated by an alias, forward, or filter file) is being processed, this
12044 variable contains the domain of the original address (lower cased). This
12045 differs from &$parent_domain$& only when there is more than one level of
12046 aliasing or forwarding. When more than one address is being delivered in a
12047 single transport run, &$original_domain$& is not set.
12048
12049 If a new address is created by means of a &%deliver%& command in a system
12050 filter, it is set up with an artificial &"parent"& address. This has the local
12051 part &'system-filter'& and the default qualify domain.
12052
12053 .vitem &$original_local_part$&
12054 .vindex "&$local_part$&"
12055 .vindex "&$original_local_part$&"
12056 When a top-level address is being processed for delivery, this contains the
12057 same value as &$local_part$&, unless a prefix or suffix was removed from the
12058 local part, because &$original_local_part$& always contains the full local
12059 part. When a &"child"& address (for example, generated by an alias, forward, or
12060 filter file) is being processed, this variable contains the full local part of
12061 the original address.
12062
12063 If the router that did the redirection processed the local part
12064 case-insensitively, the value in &$original_local_part$& is in lower case.
12065 This variable differs from &$parent_local_part$& only when there is more than
12066 one level of aliasing or forwarding. When more than one address is being
12067 delivered in a single transport run, &$original_local_part$& is not set.
12068
12069 If a new address is created by means of a &%deliver%& command in a system
12070 filter, it is set up with an artificial &"parent"& address. This has the local
12071 part &'system-filter'& and the default qualify domain.
12072
12073 .vitem &$originator_gid$&
12074 .cindex "gid (group id)" "of originating user"
12075 .cindex "sender" "gid"
12076 .vindex "&$caller_gid$&"
12077 .vindex "&$originator_gid$&"
12078 This variable contains the value of &$caller_gid$& that was set when the
12079 message was received. For messages received via the command line, this is the
12080 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12081 normally the gid of the Exim user.
12082
12083 .vitem &$originator_uid$&
12084 .cindex "uid (user id)" "of originating user"
12085 .cindex "sender" "uid"
12086 .vindex "&$caller_uid$&"
12087 .vindex "&$originaltor_uid$&"
12088 The value of &$caller_uid$& that was set when the message was received. For
12089 messages received via the command line, this is the uid of the sending user.
12090 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12091 user.
12092
12093 .vitem &$parent_domain$&
12094 .vindex "&$parent_domain$&"
12095 This variable is similar to &$original_domain$& (see
12096 above), except that it refers to the immediately preceding parent address.
12097
12098 .vitem &$parent_local_part$&
12099 .vindex "&$parent_local_part$&"
12100 This variable is similar to &$original_local_part$&
12101 (see above), except that it refers to the immediately preceding parent address.
12102
12103 .vitem &$pid$&
12104 .cindex "pid (process id)" "of current process"
12105 .vindex "&$pid$&"
12106 This variable contains the current process id.
12107
12108 .vitem &$pipe_addresses$&
12109 .cindex "filter" "transport filter"
12110 .cindex "transport" "filter"
12111 .vindex "&$pipe_addresses$&"
12112 This is not an expansion variable, but is mentioned here because the string
12113 &`$pipe_addresses`& is handled specially in the command specification for the
12114 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12115 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12116 It cannot be used in general expansion strings, and provokes an &"unknown
12117 variable"& error if encountered.
12118
12119 .vitem &$primary_hostname$&
12120 .vindex "&$primary_hostname$&"
12121 This variable contains the value set by &%primary_hostname%& in the
12122 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12123 a single-component name, Exim calls &[gethostbyname()]& (or
12124 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12125 qualified host name. See also &$smtp_active_hostname$&.
12126
12127
12128 .new
12129 .vitem &$proxy_host_address$& &&&
12130        &$proxy_host_port$& &&&
12131        &$proxy_target_address$& &&&
12132        &$proxy_target_port$& &&&
12133        &$proxy_session$&
12134 These variables are only available when built with Proxy Protocol
12135 or Socks5 support
12136 For details see chapter &<<SECTproxyInbound>>&.
12137 .wen
12138
12139 .new
12140 .vitem &$prdr_requested$&
12141 .cindex "PRDR" "variable for"
12142 This variable is set to &"yes"& if PRDR was requested by the client for the
12143 current message, otherwise &"no"&.
12144 .wen
12145
12146 .vitem &$prvscheck_address$&
12147 This variable is used in conjunction with the &%prvscheck%& expansion item,
12148 which is described in sections &<<SECTexpansionitems>>& and
12149 &<<SECTverifyPRVS>>&.
12150
12151 .vitem &$prvscheck_keynum$&
12152 This variable is used in conjunction with the &%prvscheck%& expansion item,
12153 which is described in sections &<<SECTexpansionitems>>& and
12154 &<<SECTverifyPRVS>>&.
12155
12156 .vitem &$prvscheck_result$&
12157 This variable is used in conjunction with the &%prvscheck%& expansion item,
12158 which is described in sections &<<SECTexpansionitems>>& and
12159 &<<SECTverifyPRVS>>&.
12160
12161 .vitem &$qualify_domain$&
12162 .vindex "&$qualify_domain$&"
12163 The value set for the &%qualify_domain%& option in the configuration file.
12164
12165 .vitem &$qualify_recipient$&
12166 .vindex "&$qualify_recipient$&"
12167 The value set for the &%qualify_recipient%& option in the configuration file,
12168 or if not set, the value of &$qualify_domain$&.
12169
12170 .vitem &$rcpt_count$&
12171 .vindex "&$rcpt_count$&"
12172 When a message is being received by SMTP, this variable contains the number of
12173 RCPT commands received for the current message. If this variable is used in a
12174 RCPT ACL, its value includes the current command.
12175
12176 .vitem &$rcpt_defer_count$&
12177 .vindex "&$rcpt_defer_count$&"
12178 .cindex "4&'xx'& responses" "count of"
12179 When a message is being received by SMTP, this variable contains the number of
12180 RCPT commands in the current message that have previously been rejected with a
12181 temporary (4&'xx'&) response.
12182
12183 .vitem &$rcpt_fail_count$&
12184 .vindex "&$rcpt_fail_count$&"
12185 When a message is being received by SMTP, this variable contains the number of
12186 RCPT commands in the current message that have previously been rejected with a
12187 permanent (5&'xx'&) response.
12188
12189 .vitem &$received_count$&
12190 .vindex "&$received_count$&"
12191 This variable contains the number of &'Received:'& header lines in the message,
12192 including the one added by Exim (so its value is always greater than zero). It
12193 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12194 delivering.
12195
12196 .vitem &$received_for$&
12197 .vindex "&$received_for$&"
12198 If there is only a single recipient address in an incoming message, this
12199 variable contains that address when the &'Received:'& header line is being
12200 built. The value is copied after recipient rewriting has happened, but before
12201 the &[local_scan()]& function is run.
12202
12203 .vitem &$received_ip_address$&
12204 .vindex "&$received_ip_address$&"
12205 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12206 variable is set to the address of the local IP interface, and &$received_port$&
12207 is set to the local port number. (The remote IP address and port are in
12208 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12209 the port value is -1 unless it has been set using the &%-oMi%& command line
12210 option.
12211
12212 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12213 could be used, for example, to make the file name for a TLS certificate depend
12214 on which interface and/or port is being used for the incoming connection. The
12215 values of &$received_ip_address$& and &$received_port$& are saved with any
12216 messages that are received, thus making these variables available at delivery
12217 time.
12218 For outbound connections see &$sending_ip_address$&.
12219
12220 .vitem &$received_port$&
12221 .vindex "&$received_port$&"
12222 See &$received_ip_address$&.
12223
12224 .vitem &$received_protocol$&
12225 .vindex "&$received_protocol$&"
12226 When a message is being processed, this variable contains the name of the
12227 protocol by which it was received. Most of the names used by Exim are defined
12228 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12229 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12230 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12231 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12232 connection and the client was successfully authenticated.
12233
12234 Exim uses the protocol name &"smtps"& for the case when encryption is
12235 automatically set up on connection without the use of STARTTLS (see
12236 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12237 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12238 where the client initially uses EHLO, sets up an encrypted connection using
12239 STARTTLS, and then uses HELO afterwards.
12240
12241 The &%-oMr%& option provides a way of specifying a custom protocol name for
12242 messages that are injected locally by trusted callers. This is commonly used to
12243 identify messages that are being re-injected after some kind of scanning.
12244
12245 .vitem &$received_time$&
12246 .vindex "&$received_time$&"
12247 This variable contains the date and time when the current message was received,
12248 as a number of seconds since the start of the Unix epoch.
12249
12250 .vitem &$recipient_data$&
12251 .vindex "&$recipient_data$&"
12252 This variable is set after an indexing lookup success in an ACL &%recipients%&
12253 condition. It contains the data from the lookup, and the value remains set
12254 until the next &%recipients%& test. Thus, you can do things like this:
12255 .display
12256 &`require recipients  = cdb*@;/some/file`&
12257 &`deny    `&&'some further test involving'& &`$recipient_data`&
12258 .endd
12259 &*Warning*&: This variable is set only when a lookup is used as an indexing
12260 method in the address list, using the semicolon syntax as in the example above.
12261 The variable is not set for a lookup that is used as part of the string
12262 expansion that all such lists undergo before being interpreted.
12263
12264 .vitem &$recipient_verify_failure$&
12265 .vindex "&$recipient_verify_failure$&"
12266 In an ACL, when a recipient verification fails, this variable contains
12267 information about the failure. It is set to one of the following words:
12268
12269 .ilist
12270 &"qualify"&: The address was unqualified (no domain), and the message
12271 was neither local nor came from an exempted host.
12272
12273 .next
12274 &"route"&: Routing failed.
12275
12276 .next
12277 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12278 or before the MAIL command (that is, on initial connection, HELO, or
12279 MAIL).
12280
12281 .next
12282 &"recipient"&: The RCPT command in a callout was rejected.
12283 .next
12284
12285 &"postmaster"&: The postmaster check in a callout was rejected.
12286 .endlist
12287
12288 The main use of this variable is expected to be to distinguish between
12289 rejections of MAIL and rejections of RCPT.
12290
12291 .vitem &$recipients$&
12292 .vindex "&$recipients$&"
12293 This variable contains a list of envelope recipients for a message. A comma and
12294 a space separate the addresses in the replacement text. However, the variable
12295 is not generally available, to prevent exposure of Bcc recipients in
12296 unprivileged users' filter files. You can use &$recipients$& only in these
12297 cases:
12298
12299 .olist
12300 In a system filter file.
12301 .next
12302 In the ACLs associated with the DATA command and with non-SMTP messages, that
12303 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12304 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12305 &%acl_not_smtp_mime%&.
12306 .next
12307 From within a &[local_scan()]& function.
12308 .endlist
12309
12310
12311 .vitem &$recipients_count$&
12312 .vindex "&$recipients_count$&"
12313 When a message is being processed, this variable contains the number of
12314 envelope recipients that came with the message. Duplicates are not excluded
12315 from the count. While a message is being received over SMTP, the number
12316 increases for each accepted recipient. It can be referenced in an ACL.
12317
12318
12319 .vitem &$regex_match_string$&
12320 .vindex "&$regex_match_string$&"
12321 This variable is set to contain the matching regular expression after a
12322 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12323
12324 .vitem "&$regex1$&, &$regex2$&, etc"
12325 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12326 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12327 these variables contain the
12328 captured substrings identified by the regular expression.
12329
12330
12331 .vitem &$reply_address$&
12332 .vindex "&$reply_address$&"
12333 When a message is being processed, this variable contains the contents of the
12334 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12335 contents of the &'From:'& header line. Apart from the removal of leading
12336 white space, the value is not processed in any way. In particular, no RFC 2047
12337 decoding or character code translation takes place.
12338
12339 .vitem &$return_path$&
12340 .vindex "&$return_path$&"
12341 When a message is being delivered, this variable contains the return path &--
12342 the sender field that will be sent as part of the envelope. It is not enclosed
12343 in <> characters. At the start of routing an address, &$return_path$& has the
12344 same value as &$sender_address$&, but if, for example, an incoming message to a
12345 mailing list has been expanded by a router which specifies a different address
12346 for bounce messages, &$return_path$& subsequently contains the new bounce
12347 address, whereas &$sender_address$& always contains the original sender address
12348 that was received with the message. In other words, &$sender_address$& contains
12349 the incoming envelope sender, and &$return_path$& contains the outgoing
12350 envelope sender.
12351
12352 .vitem &$return_size_limit$&
12353 .vindex "&$return_size_limit$&"
12354 This is an obsolete name for &$bounce_return_size_limit$&.
12355
12356 .vitem &$router_name$&
12357 .cindex "router" "name"
12358 .cindex "name" "of router"
12359 .vindex "&$router_name$&"
12360 During the running of a router this variable contains its name.
12361
12362 .vitem &$runrc$&
12363 .cindex "return code" "from &%run%& expansion"
12364 .vindex "&$runrc$&"
12365 This variable contains the return code from a command that is run by the
12366 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12367 assume the order in which option values are expanded, except for those
12368 preconditions whose order of testing is documented. Therefore, you cannot
12369 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12370 another.
12371
12372 .vitem &$self_hostname$&
12373 .oindex "&%self%&" "value of host name"
12374 .vindex "&$self_hostname$&"
12375 When an address is routed to a supposedly remote host that turns out to be the
12376 local host, what happens is controlled by the &%self%& generic router option.
12377 One of its values causes the address to be passed to another router. When this
12378 happens, &$self_hostname$& is set to the name of the local host that the
12379 original router encountered. In other circumstances its contents are null.
12380
12381 .vitem &$sender_address$&
12382 .vindex "&$sender_address$&"
12383 When a message is being processed, this variable contains the sender's address
12384 that was received in the message's envelope. The case of letters in the address
12385 is retained, in both the local part and the domain. For bounce messages, the
12386 value of this variable is the empty string. See also &$return_path$&.
12387
12388 .vitem &$sender_address_data$&
12389 .vindex "&$address_data$&"
12390 .vindex "&$sender_address_data$&"
12391 If &$address_data$& is set when the routers are called from an ACL to verify a
12392 sender address, the final value is preserved in &$sender_address_data$&, to
12393 distinguish it from data from a recipient address. The value does not persist
12394 after the end of the current ACL statement. If you want to preserve it for
12395 longer, you can save it in an ACL variable.
12396
12397 .vitem &$sender_address_domain$&
12398 .vindex "&$sender_address_domain$&"
12399 The domain portion of &$sender_address$&.
12400
12401 .vitem &$sender_address_local_part$&
12402 .vindex "&$sender_address_local_part$&"
12403 The local part portion of &$sender_address$&.
12404
12405 .vitem &$sender_data$&
12406 .vindex "&$sender_data$&"
12407 This variable is set after a lookup success in an ACL &%senders%& condition or
12408 in a router &%senders%& option. It contains the data from the lookup, and the
12409 value remains set until the next &%senders%& test. Thus, you can do things like
12410 this:
12411 .display
12412 &`require senders      = cdb*@;/some/file`&
12413 &`deny    `&&'some further test involving'& &`$sender_data`&
12414 .endd
12415 &*Warning*&: This variable is set only when a lookup is used as an indexing
12416 method in the address list, using the semicolon syntax as in the example above.
12417 The variable is not set for a lookup that is used as part of the string
12418 expansion that all such lists undergo before being interpreted.
12419
12420 .vitem &$sender_fullhost$&
12421 .vindex "&$sender_fullhost$&"
12422 When a message is received from a remote host, this variable contains the host
12423 name and IP address in a single string. It ends with the IP address in square
12424 brackets, followed by a colon and a port number if the logging of ports is
12425 enabled. The format of the rest of the string depends on whether the host
12426 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12427 looking up its IP address. (Looking up the IP address can be forced by the
12428 &%host_lookup%& option, independent of verification.) A plain host name at the
12429 start of the string is a verified host name; if this is not present,
12430 verification either failed or was not requested. A host name in parentheses is
12431 the argument of a HELO or EHLO command. This is omitted if it is identical to
12432 the verified host name or to the host's IP address in square brackets.
12433
12434 .vitem &$sender_helo_dnssec$&
12435 .vindex "&$sender_helo_dnssec$&"
12436 This boolean variable is true if a successful HELO verification was
12437 .cindex "DNS" "DNSSEC"
12438 done using DNS information the resolver library stated was authenticated data.
12439
12440 .vitem &$sender_helo_name$&
12441 .vindex "&$sender_helo_name$&"
12442 When a message is received from a remote host that has issued a HELO or EHLO
12443 command, the argument of that command is placed in this variable. It is also
12444 set if HELO or EHLO is used when a message is received using SMTP locally via
12445 the &%-bs%& or &%-bS%& options.
12446
12447 .vitem &$sender_host_address$&
12448 .vindex "&$sender_host_address$&"
12449 When a message is received from a remote host using SMTP,
12450 this variable contains that
12451 host's IP address. For locally non-SMTP submitted messages, it is empty.
12452
12453 .vitem &$sender_host_authenticated$&
12454 .vindex "&$sender_host_authenticated$&"
12455 This variable contains the name (not the public name) of the authenticator
12456 driver that successfully authenticated the client from which the message was
12457 received. It is empty if there was no successful authentication. See also
12458 &$authenticated_id$&.
12459
12460 .vitem &$sender_host_dnssec$&
12461 .vindex "&$sender_host_dnssec$&"
12462 If an attempt to populate &$sender_host_name$& has been made
12463 (by reference, &%hosts_lookup%& or
12464 otherwise) then this boolean will have been set true if, and only if, the
12465 resolver library states that both
12466 the reverse and forward DNS were authenticated data.  At all
12467 other times, this variable is false.
12468
12469 .cindex "DNS" "DNSSEC"
12470 It is likely that you will need to coerce DNSSEC support on in the resolver
12471 library, by setting:
12472 .code
12473 dns_dnssec_ok = 1
12474 .endd
12475
12476 Exim does not perform DNSSEC validation itself, instead leaving that to a
12477 validating resolver (e.g. unbound, or bind with suitable configuration).
12478
12479 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12480 mechanism in the list, then this variable will be false.
12481
12482
12483 .vitem &$sender_host_name$&
12484 .vindex "&$sender_host_name$&"
12485 When a message is received from a remote host, this variable contains the
12486 host's name as obtained by looking up its IP address. For messages received by
12487 other means, this variable is empty.
12488
12489 .vindex "&$host_lookup_failed$&"
12490 If the host name has not previously been looked up, a reference to
12491 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12492 A looked up name is accepted only if it leads back to the original IP address
12493 via a forward lookup. If either the reverse or the forward lookup fails to find
12494 any data, or if the forward lookup does not yield the original IP address,
12495 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12496
12497 .vindex "&$host_lookup_deferred$&"
12498 However, if either of the lookups cannot be completed (for example, there is a
12499 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12500 &$host_lookup_failed$& remains set to &"0"&.
12501
12502 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12503 host name again if there is a subsequent reference to &$sender_host_name$&
12504 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12505 is set to &"1"&.
12506
12507 Exim does not automatically look up every calling host's name. If you want
12508 maximum efficiency, you should arrange your configuration so that it avoids
12509 these lookups altogether. The lookup happens only if one or more of the
12510 following are true:
12511
12512 .ilist
12513 A string containing &$sender_host_name$& is expanded.
12514 .next
12515 The calling host matches the list in &%host_lookup%&. In the default
12516 configuration, this option is set to *, so it must be changed if lookups are
12517 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12518 .next
12519 Exim needs the host name in order to test an item in a host list. The items
12520 that require this are described in sections &<<SECThoslispatnam>>& and
12521 &<<SECThoslispatnamsk>>&.
12522 .next
12523 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12524 In this case, the host name is required to compare with the name quoted in any
12525 EHLO or HELO commands that the client issues.
12526 .next
12527 The remote host issues a EHLO or HELO command that quotes one of the
12528 domains in &%helo_lookup_domains%&. The default value of this option is
12529 . ==== As this is a nested list, any displays it contains must be indented
12530 . ==== as otherwise they are too far to the left.
12531 .code
12532   helo_lookup_domains = @ : @[]
12533 .endd
12534 which causes a lookup if a remote host (incorrectly) gives the server's name or
12535 IP address in an EHLO or HELO command.
12536 .endlist
12537
12538
12539 .vitem &$sender_host_port$&
12540 .vindex "&$sender_host_port$&"
12541 When a message is received from a remote host, this variable contains the port
12542 number that was used on the remote host.
12543
12544 .vitem &$sender_ident$&
12545 .vindex "&$sender_ident$&"
12546 When a message is received from a remote host, this variable contains the
12547 identification received in response to an RFC 1413 request. When a message has
12548 been received locally, this variable contains the login name of the user that
12549 called Exim.
12550
12551 .vitem &$sender_rate_$&&'xxx'&
12552 A number of variables whose names begin &$sender_rate_$& are set as part of the
12553 &%ratelimit%& ACL condition. Details are given in section
12554 &<<SECTratelimiting>>&.
12555
12556 .vitem &$sender_rcvhost$&
12557 .cindex "DNS" "reverse lookup"
12558 .cindex "reverse DNS lookup"
12559 .vindex "&$sender_rcvhost$&"
12560 This is provided specifically for use in &'Received:'& headers. It starts with
12561 either the verified host name (as obtained from a reverse DNS lookup) or, if
12562 there is no verified host name, the IP address in square brackets. After that
12563 there may be text in parentheses. When the first item is a verified host name,
12564 the first thing in the parentheses is the IP address in square brackets,
12565 followed by a colon and a port number if port logging is enabled. When the
12566 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12567 the parentheses.
12568
12569 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12570 was used and its argument was not identical to the real host name or IP
12571 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12572 all three items are present in the parentheses, a newline and tab are inserted
12573 into the string, to improve the formatting of the &'Received:'& header.
12574
12575 .vitem &$sender_verify_failure$&
12576 .vindex "&$sender_verify_failure$&"
12577 In an ACL, when a sender verification fails, this variable contains information
12578 about the failure. The details are the same as for
12579 &$recipient_verify_failure$&.
12580
12581 .vitem &$sending_ip_address$&
12582 .vindex "&$sending_ip_address$&"
12583 This variable is set whenever an outgoing SMTP connection to another host has
12584 been set up. It contains the IP address of the local interface that is being
12585 used. This is useful if a host that has more than one IP address wants to take
12586 on different personalities depending on which one is being used. For incoming
12587 connections, see &$received_ip_address$&.
12588
12589 .vitem &$sending_port$&
12590 .vindex "&$sending_port$&"
12591 This variable is set whenever an outgoing SMTP connection to another host has
12592 been set up. It contains the local port that is being used. For incoming
12593 connections, see &$received_port$&.
12594
12595 .vitem &$smtp_active_hostname$&
12596 .vindex "&$smtp_active_hostname$&"
12597 During an incoming SMTP session, this variable contains the value of the active
12598 host name, as specified by the &%smtp_active_hostname%& option. The value of
12599 &$smtp_active_hostname$& is saved with any message that is received, so its
12600 value can be consulted during routing and delivery.
12601
12602 .vitem &$smtp_command$&
12603 .vindex "&$smtp_command$&"
12604 During the processing of an incoming SMTP command, this variable contains the
12605 entire command. This makes it possible to distinguish between HELO and EHLO in
12606 the HELO ACL, and also to distinguish between commands such as these:
12607 .code
12608 MAIL FROM:<>
12609 MAIL FROM: <>
12610 .endd
12611 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12612 command, the address in &$smtp_command$& is the original address before any
12613 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12614 the address after SMTP-time rewriting.
12615
12616 .vitem &$smtp_command_argument$&
12617 .cindex "SMTP" "command, argument for"
12618 .vindex "&$smtp_command_argument$&"
12619 While an ACL is running to check an SMTP command, this variable contains the
12620 argument, that is, the text that follows the command name, with leading white
12621 space removed. Following the introduction of &$smtp_command$&, this variable is
12622 somewhat redundant, but is retained for backwards compatibility.
12623
12624 .vitem &$smtp_count_at_connection_start$&
12625 .vindex "&$smtp_count_at_connection_start$&"
12626 This variable is set greater than zero only in processes spawned by the Exim
12627 daemon for handling incoming SMTP connections. The name is deliberately long,
12628 in order to emphasize what the contents are. When the daemon accepts a new
12629 connection, it increments this variable. A copy of the variable is passed to
12630 the child process that handles the connection, but its value is fixed, and
12631 never changes. It is only an approximation of how many incoming connections
12632 there actually are, because many other connections may come and go while a
12633 single connection is being processed. When a child process terminates, the
12634 daemon decrements its copy of the variable.
12635
12636 .vitem "&$sn0$& &-- &$sn9$&"
12637 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12638 that were current at the end of the system filter file. This allows a system
12639 filter file to set values that can be tested in users' filter files. For
12640 example, a system filter could set a value indicating how likely it is that a
12641 message is junk mail.
12642
12643 .vitem &$spam_$&&'xxx'&
12644 A number of variables whose names start with &$spam$& are available when Exim
12645 is compiled with the content-scanning extension. For details, see section
12646 &<<SECTscanspamass>>&.
12647
12648
12649 .vitem &$spool_directory$&
12650 .vindex "&$spool_directory$&"
12651 The name of Exim's spool directory.
12652
12653 .vitem &$spool_inodes$&
12654 .vindex "&$spool_inodes$&"
12655 The number of free inodes in the disk partition where Exim's spool files are
12656 being written. The value is recalculated whenever the variable is referenced.
12657 If the relevant file system does not have the concept of inodes, the value of
12658 is -1. See also the &%check_spool_inodes%& option.
12659
12660 .vitem &$spool_space$&
12661 .vindex "&$spool_space$&"
12662 The amount of free space (as a number of kilobytes) in the disk partition where
12663 Exim's spool files are being written. The value is recalculated whenever the
12664 variable is referenced. If the operating system does not have the ability to
12665 find the amount of free space (only true for experimental systems), the space
12666 value is -1. For example, to check in an ACL that there is at least 50
12667 megabytes free on the spool, you could write:
12668 .code
12669 condition = ${if > {$spool_space}{50000}}
12670 .endd
12671 See also the &%check_spool_space%& option.
12672
12673
12674 .vitem &$thisaddress$&
12675 .vindex "&$thisaddress$&"
12676 This variable is set only during the processing of the &%foranyaddress%&
12677 command in a filter file. Its use is explained in the description of that
12678 command, which can be found in the separate document entitled &'Exim's
12679 interfaces to mail filtering'&.
12680
12681 .vitem &$tls_in_bits$&
12682 .vindex "&$tls_in_bits$&"
12683 Contains an approximation of the TLS cipher's bit-strength
12684 on the inbound connection; the meaning of
12685 this depends upon the TLS implementation used.
12686 If TLS has not been negotiated, the value will be 0.
12687 The value of this is automatically fed into the Cyrus SASL authenticator
12688 when acting as a server, to specify the "external SSF" (a SASL term).
12689
12690 The deprecated &$tls_bits$& variable refers to the inbound side
12691 except when used in the context of an outbound SMTP delivery, when it refers to
12692 the outbound.
12693
12694 .vitem &$tls_out_bits$&
12695 .vindex "&$tls_out_bits$&"
12696 Contains an approximation of the TLS cipher's bit-strength
12697 on an outbound SMTP connection; the meaning of
12698 this depends upon the TLS implementation used.
12699 If TLS has not been negotiated, the value will be 0.
12700
12701 .vitem &$tls_in_ourcert$&
12702 .vindex "&$tls_in_ourcert$&"
12703 .cindex certificate veriables
12704 This variable refers to the certificate presented to the peer of an
12705 inbound connection when the message was received.
12706 It is only useful as the argument of a
12707 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12708 or a &%def%& condition.
12709
12710 .vitem &$tls_in_peercert$&
12711 .vindex "&$tls_in_peercert$&"
12712 This variable refers to the certificate presented by the peer of an
12713 inbound connection when the message was received.
12714 It is only useful as the argument of a
12715 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12716 or a &%def%& condition.
12717 If certificate verification fails it may refer to a failing chain element
12718 which is not the leaf.
12719
12720 .vitem &$tls_out_ourcert$&
12721 .vindex "&$tls_out_ourcert$&"
12722 This variable refers to the certificate presented to the peer of an
12723 outbound connection.  It is only useful as the argument of a
12724 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12725 or a &%def%& condition.
12726
12727 .vitem &$tls_out_peercert$&
12728 .vindex "&$tls_out_peercert$&"
12729 This variable refers to the certificate presented by the peer of an
12730 outbound connection.  It is only useful as the argument of a
12731 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12732 or a &%def%& condition.
12733 If certificate verification fails it may refer to a failing chain element
12734 which is not the leaf.
12735
12736 .vitem &$tls_in_certificate_verified$&
12737 .vindex "&$tls_in_certificate_verified$&"
12738 This variable is set to &"1"& if a TLS certificate was verified when the
12739 message was received, and &"0"& otherwise.
12740
12741 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12742 except when used in the context of an outbound SMTP delivery, when it refers to
12743 the outbound.
12744
12745 .vitem &$tls_out_certificate_verified$&
12746 .vindex "&$tls_out_certificate_verified$&"
12747 This variable is set to &"1"& if a TLS certificate was verified when an
12748 outbound SMTP connection was made,
12749 and &"0"& otherwise.
12750
12751 .vitem &$tls_in_cipher$&
12752 .vindex "&$tls_in_cipher$&"
12753 .vindex "&$tls_cipher$&"
12754 When a message is received from a remote host over an encrypted SMTP
12755 connection, this variable is set to the cipher suite that was negotiated, for
12756 example DES-CBC3-SHA. In other circumstances, in particular, for message
12757 received over unencrypted connections, the variable is empty. Testing
12758 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12759 non-encrypted connections during ACL processing.
12760
12761 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12762 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12763 becomes the same as &$tls_out_cipher$&.
12764
12765 .vitem &$tls_out_cipher$&
12766 .vindex "&$tls_out_cipher$&"
12767 This variable is
12768 cleared before any outgoing SMTP connection is made,
12769 and then set to the outgoing cipher suite if one is negotiated. See chapter
12770 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12771 details of the &(smtp)& transport.
12772
12773 .vitem &$tls_in_ocsp$&
12774 .vindex "&$tls_in_ocsp$&"
12775 When a message is received from a remote client connection
12776 the result of any OCSP request from the client is encoded in this variable:
12777 .code
12778 0 OCSP proof was not requested (default value)
12779 1 No response to request
12780 2 Response not verified
12781 3 Verification failed
12782 4 Verification succeeded
12783 .endd
12784
12785 .vitem &$tls_out_ocsp$&
12786 .vindex "&$tls_out_ocsp$&"
12787 When a message is sent to a remote host connection
12788 the result of any OCSP request made is encoded in this variable.
12789 See &$tls_in_ocsp$& for values.
12790
12791 .vitem &$tls_in_peerdn$&
12792 .vindex "&$tls_in_peerdn$&"
12793 .vindex "&$tls_peerdn$&"
12794 .cindex certificate "extracting fields"
12795 When a message is received from a remote host over an encrypted SMTP
12796 connection, and Exim is configured to request a certificate from the client,
12797 the value of the Distinguished Name of the certificate is made available in the
12798 &$tls_in_peerdn$& during subsequent processing.
12799 If certificate verification fails it may refer to a failing chain element
12800 which is not the leaf.
12801
12802 The deprecated &$tls_peerdn$& variable refers to the inbound side
12803 except when used in the context of an outbound SMTP delivery, when it refers to
12804 the outbound.
12805
12806 .vitem &$tls_out_peerdn$&
12807 .vindex "&$tls_out_peerdn$&"
12808 When a message is being delivered to a remote host over an encrypted SMTP
12809 connection, and Exim is configured to request a certificate from the server,
12810 the value of the Distinguished Name of the certificate is made available in the
12811 &$tls_out_peerdn$& during subsequent processing.
12812 If certificate verification fails it may refer to a failing chain element
12813 which is not the leaf.
12814
12815 .vitem &$tls_in_sni$&
12816 .vindex "&$tls_in_sni$&"
12817 .vindex "&$tls_sni$&"
12818 .cindex "TLS" "Server Name Indication"
12819 When a TLS session is being established, if the client sends the Server
12820 Name Indication extension, the value will be placed in this variable.
12821 If the variable appears in &%tls_certificate%& then this option and
12822 some others, described in &<<SECTtlssni>>&,
12823 will be re-expanded early in the TLS session, to permit
12824 a different certificate to be presented (and optionally a different key to be
12825 used) to the client, based upon the value of the SNI extension.
12826
12827 The deprecated &$tls_sni$& variable refers to the inbound side
12828 except when used in the context of an outbound SMTP delivery, when it refers to
12829 the outbound.
12830
12831 .vitem &$tls_out_sni$&
12832 .vindex "&$tls_out_sni$&"
12833 .cindex "TLS" "Server Name Indication"
12834 During outbound
12835 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12836 the transport.
12837
12838 .vitem &$tod_bsdinbox$&
12839 .vindex "&$tod_bsdinbox$&"
12840 The time of day and the date, in the format required for BSD-style mailbox
12841 files, for example: Thu Oct 17 17:14:09 1995.
12842
12843 .vitem &$tod_epoch$&
12844 .vindex "&$tod_epoch$&"
12845 The time and date as a number of seconds since the start of the Unix epoch.
12846
12847 .vitem &$tod_epoch_l$&
12848 .vindex "&$tod_epoch_l$&"
12849 The time and date as a number of microseconds since the start of the Unix epoch.
12850
12851 .vitem &$tod_full$&
12852 .vindex "&$tod_full$&"
12853 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12854 +0100. The timezone is always given as a numerical offset from UTC, with
12855 positive values used for timezones that are ahead (east) of UTC, and negative
12856 values for those that are behind (west).
12857
12858 .vitem &$tod_log$&
12859 .vindex "&$tod_log$&"
12860 The time and date in the format used for writing Exim's log files, for example:
12861 1995-10-12 15:32:29, but without a timezone.
12862
12863 .vitem &$tod_logfile$&
12864 .vindex "&$tod_logfile$&"
12865 This variable contains the date in the format yyyymmdd. This is the format that
12866 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12867 flag.
12868
12869 .vitem &$tod_zone$&
12870 .vindex "&$tod_zone$&"
12871 This variable contains the numerical value of the local timezone, for example:
12872 -0500.
12873
12874 .vitem &$tod_zulu$&
12875 .vindex "&$tod_zulu$&"
12876 This variable contains the UTC date and time in &"Zulu"& format, as specified
12877 by ISO 8601, for example: 20030221154023Z.
12878
12879 .vitem &$transport_name$&
12880 .cindex "transport" "name"
12881 .cindex "name" "of transport"
12882 .vindex "&$transport_name$&"
12883 During the running of a transport, this variable contains its name.
12884
12885 .vitem &$value$&
12886 .vindex "&$value$&"
12887 This variable contains the result of an expansion lookup, extraction operation,
12888 or external command, as described above. It is also used during a
12889 &*reduce*& expansion.
12890
12891 .vitem &$verify_mode$&
12892 .vindex "&$verify_mode$&"
12893 While a router or transport is being run in verify mode
12894 or for cutthrough delivery,
12895 contains "S" for sender-verification or "R" for recipient-verification.
12896 Otherwise, empty.
12897
12898 .vitem &$version_number$&
12899 .vindex "&$version_number$&"
12900 The version number of Exim.
12901
12902 .vitem &$warn_message_delay$&
12903 .vindex "&$warn_message_delay$&"
12904 This variable is set only during the creation of a message warning about a
12905 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12906
12907 .vitem &$warn_message_recipients$&
12908 .vindex "&$warn_message_recipients$&"
12909 This variable is set only during the creation of a message warning about a
12910 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12911 .endlist
12912 .ecindex IIDstrexp
12913
12914
12915
12916 . ////////////////////////////////////////////////////////////////////////////
12917 . ////////////////////////////////////////////////////////////////////////////
12918
12919 .chapter "Embedded Perl" "CHAPperl"
12920 .scindex IIDperl "Perl" "calling from Exim"
12921 Exim can be built to include an embedded Perl interpreter. When this is done,
12922 Perl subroutines can be called as part of the string expansion process. To make
12923 use of the Perl support, you need version 5.004 or later of Perl installed on
12924 your system. To include the embedded interpreter in the Exim binary, include
12925 the line
12926 .code
12927 EXIM_PERL = perl.o
12928 .endd
12929 in your &_Local/Makefile_& and then build Exim in the normal way.
12930
12931
12932 .section "Setting up so Perl can be used" "SECID85"
12933 .oindex "&%perl_startup%&"
12934 Access to Perl subroutines is via a global configuration option called
12935 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12936 no &%perl_startup%& option in the Exim configuration file then no Perl
12937 interpreter is started and there is almost no overhead for Exim (since none of
12938 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12939 option then the associated value is taken to be Perl code which is executed in
12940 a newly created Perl interpreter.
12941
12942 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12943 need backslashes before any characters to escape special meanings. The option
12944 should usually be something like
12945 .code
12946 perl_startup = do '/etc/exim.pl'
12947 .endd
12948 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12949 use from Exim. Exim can be configured either to start up a Perl interpreter as
12950 soon as it is entered, or to wait until the first time it is needed. Starting
12951 the interpreter at the beginning ensures that it is done while Exim still has
12952 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12953 fact used in a particular run. Also, note that this does not mean that Exim is
12954 necessarily running as root when Perl is called at a later time. By default,
12955 the interpreter is started only when it is needed, but this can be changed in
12956 two ways:
12957
12958 .ilist
12959 .oindex "&%perl_at_start%&"
12960 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12961 a startup when Exim is entered.
12962 .next
12963 The command line option &%-ps%& also requests a startup when Exim is entered,
12964 overriding the setting of &%perl_at_start%&.
12965 .endlist
12966
12967 There is also a command line option &%-pd%& (for delay) which suppresses the
12968 initial startup, even if &%perl_at_start%& is set.
12969
12970
12971 .section "Calling Perl subroutines" "SECID86"
12972 When the configuration file includes a &%perl_startup%& option you can make use
12973 of the string expansion item to call the Perl subroutines that are defined
12974 by the &%perl_startup%& code. The operator is used in any of the following
12975 forms:
12976 .code
12977 ${perl{foo}}
12978 ${perl{foo}{argument}}
12979 ${perl{foo}{argument1}{argument2} ... }
12980 .endd
12981 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12982 arguments may be passed. Passing more than this results in an expansion failure
12983 with an error message of the form
12984 .code
12985 Too many arguments passed to Perl subroutine "foo" (max is 8)
12986 .endd
12987 The return value of the Perl subroutine is evaluated in a scalar context before
12988 it is passed back to Exim to be inserted into the expanded string. If the
12989 return value is &'undef'&, the expansion is forced to fail in the same way as
12990 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12991 by obeying Perl's &%die%& function, the expansion fails with the error message
12992 that was passed to &%die%&.
12993
12994
12995 .section "Calling Exim functions from Perl" "SECID87"
12996 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12997 is available to call back into Exim's string expansion function. For example,
12998 the Perl code
12999 .code
13000 my $lp = Exim::expand_string('$local_part');
13001 .endd
13002 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13003 Note those are single quotes and not double quotes to protect against
13004 &$local_part$& being interpolated as a Perl variable.
13005
13006 If the string expansion is forced to fail by a &"fail"& item, the result of
13007 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13008 expansion string, the Perl call from the original expansion string fails with
13009 an appropriate error message, in the same way as if &%die%& were used.
13010
13011 .cindex "debugging" "from embedded Perl"
13012 .cindex "log" "writing from embedded Perl"
13013 Two other Exim functions are available for use from within Perl code.
13014 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13015 debugging is enabled. If you want a newline at the end, you must supply it.
13016 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13017 timestamp. In this case, you should not supply a terminating newline.
13018
13019
13020 .section "Use of standard output and error by Perl" "SECID88"
13021 .cindex "Perl" "standard output and error"
13022 You should not write to the standard error or output streams from within your
13023 Perl code, as it is not defined how these are set up. In versions of Exim
13024 before 4.50, it is possible for the standard output or error to refer to the
13025 SMTP connection during message reception via the daemon. Writing to this stream
13026 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13027 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13028 avoided, but the output is lost.
13029
13030 .cindex "Perl" "use of &%warn%&"
13031 The Perl &%warn%& statement writes to the standard error stream by default.
13032 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13033 you have no control. When Exim starts up the Perl interpreter, it arranges for
13034 output from the &%warn%& statement to be written to the Exim main log. You can
13035 change this by including appropriate Perl magic somewhere in your Perl code.
13036 For example, to discard &%warn%& output completely, you need this:
13037 .code
13038 $SIG{__WARN__} = sub { };
13039 .endd
13040 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13041 example, the code for the subroutine is empty, so it does nothing, but you can
13042 include any Perl code that you like. The text of the &%warn%& message is passed
13043 as the first subroutine argument.
13044 .ecindex IIDperl
13045
13046
13047 . ////////////////////////////////////////////////////////////////////////////
13048 . ////////////////////////////////////////////////////////////////////////////
13049
13050 .chapter "Starting the daemon and the use of network interfaces" &&&
13051          "CHAPinterfaces" &&&
13052          "Starting the daemon"
13053 .cindex "daemon" "starting"
13054 .cindex "interface" "listening"
13055 .cindex "network interface"
13056 .cindex "interface" "network"
13057 .cindex "IP address" "for listening"
13058 .cindex "daemon" "listening IP addresses"
13059 .cindex "TCP/IP" "setting listening interfaces"
13060 .cindex "TCP/IP" "setting listening ports"
13061 A host that is connected to a TCP/IP network may have one or more physical
13062 hardware network interfaces. Each of these interfaces may be configured as one
13063 or more &"logical"& interfaces, which are the entities that a program actually
13064 works with. Each of these logical interfaces is associated with an IP address.
13065 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13066 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13067 knowledge about the host's interfaces for use in three different circumstances:
13068
13069 .olist
13070 When a listening daemon is started, Exim needs to know which interfaces
13071 and ports to listen on.
13072 .next
13073 When Exim is routing an address, it needs to know which IP addresses
13074 are associated with local interfaces. This is required for the correct
13075 processing of MX lists by removing the local host and others with the
13076 same or higher priority values. Also, Exim needs to detect cases
13077 when an address is routed to an IP address that in fact belongs to the
13078 local host. Unless the &%self%& router option or the &%allow_localhost%&
13079 option of the smtp transport is set (as appropriate), this is treated
13080 as an error situation.
13081 .next
13082 When Exim connects to a remote host, it may need to know which interface to use
13083 for the outgoing connection.
13084 .endlist
13085
13086
13087 Exim's default behaviour is likely to be appropriate in the vast majority
13088 of cases. If your host has only one interface, and you want all its IP
13089 addresses to be treated in the same way, and you are using only the
13090 standard SMTP port, you should not need to take any special action. The
13091 rest of this chapter does not apply to you.
13092
13093 In a more complicated situation you may want to listen only on certain
13094 interfaces, or on different ports, and for this reason there are a number of
13095 options that can be used to influence Exim's behaviour. The rest of this
13096 chapter describes how they operate.
13097
13098 When a message is received over TCP/IP, the interface and port that were
13099 actually used are set in &$received_ip_address$& and &$received_port$&.
13100
13101
13102
13103 .section "Starting a listening daemon" "SECID89"
13104 When a listening daemon is started (by means of the &%-bd%& command line
13105 option), the interfaces and ports on which it listens are controlled by the
13106 following options:
13107
13108 .ilist
13109 &%daemon_smtp_ports%& contains a list of default ports
13110 or service names.
13111 (For backward compatibility, this option can also be specified in the singular.)
13112 .next
13113 &%local_interfaces%& contains list of interface IP addresses on which to
13114 listen. Each item may optionally also specify a port.
13115 .endlist
13116
13117 The default list separator in both cases is a colon, but this can be changed as
13118 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13119 it is usually best to change the separator to avoid having to double all the
13120 colons. For example:
13121 .code
13122 local_interfaces = <; 127.0.0.1 ; \
13123                       192.168.23.65 ; \
13124                       ::1 ; \
13125                       3ffe:ffff:836f::fe86:a061
13126 .endd
13127 There are two different formats for specifying a port along with an IP address
13128 in &%local_interfaces%&:
13129
13130 .olist
13131 The port is added onto the address with a dot separator. For example, to listen
13132 on port 1234 on two different IP addresses:
13133 .code
13134 local_interfaces = <; 192.168.23.65.1234 ; \
13135                       3ffe:ffff:836f::fe86:a061.1234
13136 .endd
13137 .next
13138 The IP address is enclosed in square brackets, and the port is added
13139 with a colon separator, for example:
13140 .code
13141 local_interfaces = <; [192.168.23.65]:1234 ; \
13142                       [3ffe:ffff:836f::fe86:a061]:1234
13143 .endd
13144 .endlist
13145
13146 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13147 default setting contains just one port:
13148 .code
13149 daemon_smtp_ports = smtp
13150 .endd
13151 If more than one port is listed, each interface that does not have its own port
13152 specified listens on all of them. Ports that are listed in
13153 &%daemon_smtp_ports%& can be identified either by name (defined in
13154 &_/etc/services_&) or by number. However, when ports are given with individual
13155 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13156
13157
13158
13159 .section "Special IP listening addresses" "SECID90"
13160 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13161 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13162 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13163 instead of setting up separate listening sockets for each interface. The
13164 default value of &%local_interfaces%& is
13165 .code
13166 local_interfaces = 0.0.0.0
13167 .endd
13168 when Exim is built without IPv6 support; otherwise it is:
13169 .code
13170 local_interfaces = <; ::0 ; 0.0.0.0
13171 .endd
13172 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13173
13174
13175
13176 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13177 The &%-oX%& command line option can be used to override the values of
13178 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13179 instance. Another way of doing this would be to use macros and the &%-D%&
13180 option. However, &%-oX%& can be used by any admin user, whereas modification of
13181 the runtime configuration by &%-D%& is allowed only when the caller is root or
13182 exim.
13183
13184 The value of &%-oX%& is a list of items. The default colon separator can be
13185 changed in the usual way if required. If there are any items that do not
13186 contain dots or colons (that is, are not IP addresses), the value of
13187 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13188 items that do contain dots or colons, the value of &%local_interfaces%& is
13189 replaced by those items. Thus, for example,
13190 .code
13191 -oX 1225
13192 .endd
13193 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13194 whereas
13195 .code
13196 -oX 192.168.34.5.1125
13197 .endd
13198 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13199 (However, since &%local_interfaces%& now contains no items without ports, the
13200 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13201
13202
13203
13204 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13205 .cindex "ssmtp protocol"
13206 .cindex "smtps protocol"
13207 .cindex "SMTP" "ssmtp protocol"
13208 .cindex "SMTP" "smtps protocol"
13209 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13210 before the STARTTLS command was standardized for SMTP. Some legacy clients
13211 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13212 list of port numbers or service names,
13213 connections to those ports must use SSMTP. The most
13214 common use of this option is expected to be
13215 .code
13216 tls_on_connect_ports = 465
13217 .endd
13218 because 465 is the usual port number used by the legacy clients. There is also
13219 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13220 this way when a daemon is started.
13221
13222 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13223 daemon to listen on those ports. You must still specify them in
13224 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13225 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13226 connections via the daemon.)
13227
13228
13229
13230
13231 .section "IPv6 address scopes" "SECID92"
13232 .cindex "IPv6" "address scopes"
13233 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13234 can, in principle, have the same link-local IPv6 address on different
13235 interfaces. Thus, additional information is needed, over and above the IP
13236 address, to distinguish individual interfaces. A convention of using a
13237 percent sign followed by something (often the interface name) has been
13238 adopted in some cases, leading to addresses like this:
13239 .code
13240 fe80::202:b3ff:fe03:45c1%eth0
13241 .endd
13242 To accommodate this usage, a percent sign followed by an arbitrary string is
13243 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13244 to convert a textual IPv6 address for actual use. This function recognizes the
13245 percent convention in operating systems that support it, and it processes the
13246 address appropriately. Unfortunately, some older libraries have problems with
13247 &[getaddrinfo()]&. If
13248 .code
13249 IPV6_USE_INET_PTON=yes
13250 .endd
13251 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13252 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13253 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13254 function.) Of course, this means that the additional functionality of
13255 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13256
13257 .section "Disabling IPv6" "SECID93"
13258 .cindex "IPv6" "disabling"
13259 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13260 run on a host whose kernel does not support IPv6. The binary will fall back to
13261 using IPv4, but it may waste resources looking up AAAA records, and trying to
13262 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13263 .oindex "&%disable_ipv6%&"
13264 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13265 activities take place. AAAA records are never looked up, and any IPv6 addresses
13266 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13267 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13268 to handle IPv6 literal addresses.
13269
13270 On the other hand, when IPv6 is in use, there may be times when you want to
13271 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13272 option to globally suppress the lookup of AAAA records for specified domains,
13273 and you can use the &%ignore_target_hosts%& generic router option to ignore
13274 IPv6 addresses in an individual router.
13275
13276
13277
13278 .section "Examples of starting a listening daemon" "SECID94"
13279 The default case in an IPv6 environment is
13280 .code
13281 daemon_smtp_ports = smtp
13282 local_interfaces = <; ::0 ; 0.0.0.0
13283 .endd
13284 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13285 Either one or two sockets may be used, depending on the characteristics of
13286 the TCP/IP stack. (This is complicated and messy; for more information,
13287 read the comments in the &_daemon.c_& source file.)
13288
13289 To specify listening on ports 25 and 26 on all interfaces:
13290 .code
13291 daemon_smtp_ports = 25 : 26
13292 .endd
13293 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13294 .code
13295 local_interfaces = <; ::0.25     ; ::0.26 \
13296                       0.0.0.0.25 ; 0.0.0.0.26
13297 .endd
13298 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13299 IPv4 loopback address only:
13300 .code
13301 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13302 .endd
13303 To specify listening on the default port on specific interfaces only:
13304 .code
13305 local_interfaces = 10.0.0.67 : 192.168.34.67
13306 .endd
13307 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13308
13309
13310
13311 .section "Recognizing the local host" "SECTreclocipadd"
13312 The &%local_interfaces%& option is also used when Exim needs to determine
13313 whether or not an IP address refers to the local host. That is, the IP
13314 addresses of all the interfaces on which a daemon is listening are always
13315 treated as local.
13316
13317 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13318 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13319 available interfaces from the operating system, and extracts the relevant
13320 (that is, IPv4 or IPv6) addresses to use for checking.
13321
13322 Some systems set up large numbers of virtual interfaces in order to provide
13323 many virtual web servers. In this situation, you may want to listen for
13324 email on only a few of the available interfaces, but nevertheless treat all
13325 interfaces as local when routing. You can do this by setting
13326 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13327 &"all"& wildcard values. These addresses are recognized as local, but are not
13328 used for listening. Consider this example:
13329 .code
13330 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13331                       192.168.53.235 ; \
13332                       3ffe:2101:12:1:a00:20ff:fe86:a061
13333
13334 extra_local_interfaces = <; ::0 ; 0.0.0.0
13335 .endd
13336 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13337 address, but all available interface addresses are treated as local when
13338 Exim is routing.
13339
13340 In some environments the local host name may be in an MX list, but with an IP
13341 address that is not assigned to any local interface. In other cases it may be
13342 desirable to treat other host names as if they referred to the local host. Both
13343 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13344 This contains host names rather than IP addresses. When a host is referenced
13345 during routing, either via an MX record or directly, it is treated as the local
13346 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13347 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13348
13349
13350
13351 .section "Delivering to a remote host" "SECID95"
13352 Delivery to a remote host is handled by the smtp transport. By default, it
13353 allows the system's TCP/IP functions to choose which interface to use (if
13354 there is more than one) when connecting to a remote host. However, the
13355 &%interface%& option can be set to specify which interface is used. See the
13356 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13357 details.
13358
13359
13360
13361
13362 . ////////////////////////////////////////////////////////////////////////////
13363 . ////////////////////////////////////////////////////////////////////////////
13364
13365 .chapter "Main configuration" "CHAPmainconfig"
13366 .scindex IIDconfima "configuration file" "main section"
13367 .scindex IIDmaiconf "main configuration"
13368 The first part of the run time configuration file contains three types of item:
13369
13370 .ilist
13371 Macro definitions: These lines start with an upper case letter. See section
13372 &<<SECTmacrodefs>>& for details of macro processing.
13373 .next
13374 Named list definitions: These lines start with one of the words &"domainlist"&,
13375 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13376 section &<<SECTnamedlists>>&.
13377 .next
13378 Main configuration settings: Each setting occupies one line of the file
13379 (with possible continuations). If any setting is preceded by the word
13380 &"hide"&, the &%-bP%& command line option displays its value to admin users
13381 only. See section &<<SECTcos>>& for a description of the syntax of these option
13382 settings.
13383 .endlist
13384
13385 This chapter specifies all the main configuration options, along with their
13386 types and default values. For ease of finding a particular option, they appear
13387 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13388 are now so many options, they are first listed briefly in functional groups, as
13389 an aid to finding the name of the option you are looking for. Some options are
13390 listed in more than one group.
13391
13392 .section "Miscellaneous" "SECID96"
13393 .table2
13394 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13395 .row &%disable_ipv6%&                "do no IPv6 processing"
13396 .row &%keep_malformed%&              "for broken files &-- should not happen"
13397 .row &%localhost_number%&            "for unique message ids in clusters"
13398 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13399 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13400 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13401 .row &%print_topbitchars%&           "top-bit characters are printing"
13402 .row &%timezone%&                    "force time zone"
13403 .endtable
13404
13405
13406 .section "Exim parameters" "SECID97"
13407 .table2
13408 .row &%exim_group%&                  "override compiled-in value"
13409 .row &%exim_path%&                   "override compiled-in value"
13410 .row &%exim_user%&                   "override compiled-in value"
13411 .row &%primary_hostname%&            "default from &[uname()]&"
13412 .row &%split_spool_directory%&       "use multiple directories"
13413 .row &%spool_directory%&             "override compiled-in value"
13414 .endtable
13415
13416
13417
13418 .section "Privilege controls" "SECID98"
13419 .table2
13420 .row &%admin_groups%&                "groups that are Exim admin users"
13421 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13422 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13423 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13424 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13425 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13426 .row &%never_users%&                 "do not run deliveries as these"
13427 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13428 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13429 .row &%trusted_groups%&              "groups that are trusted"
13430 .row &%trusted_users%&               "users that are trusted"
13431 .endtable
13432
13433
13434
13435 .section "Logging" "SECID99"
13436 .table2
13437 .row &%event_action%&                "custom logging"
13438 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13439 .row &%log_file_path%&               "override compiled-in value"
13440 .row &%log_selector%&                "set/unset optional logging"
13441 .row &%log_timezone%&                "add timezone to log lines"
13442 .row &%message_logs%&                "create per-message logs"
13443 .row &%preserve_message_logs%&       "after message completion"
13444 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13445 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13446 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13447 .row &%syslog_facility%&             "set syslog &""facility""& field"
13448 .row &%syslog_processname%&          "set syslog &""ident""& field"
13449 .row &%syslog_timestamp%&            "timestamp syslog lines"
13450 .row &%write_rejectlog%&             "control use of message log"
13451 .endtable
13452
13453
13454
13455 .section "Frozen messages" "SECID100"
13456 .table2
13457 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13458 .row &%freeze_tell%&                 "send message when freezing"
13459 .row &%move_frozen_messages%&        "to another directory"
13460 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13461 .endtable
13462
13463
13464
13465 .section "Data lookups" "SECID101"
13466 .table2
13467 .row &%ibase_servers%&               "InterBase servers"
13468 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13469 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13470 .row &%ldap_cert_file%&              "client cert file for LDAP"
13471 .row &%ldap_cert_key%&               "client key file for LDAP"
13472 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13473 .row &%ldap_default_servers%&        "used if no server in query"
13474 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13475 .row &%ldap_start_tls%&              "require TLS within LDAP"
13476 .row &%ldap_version%&                "set protocol version"
13477 .row &%lookup_open_max%&             "lookup files held open"
13478 .row &%mysql_servers%&               "default MySQL servers"
13479 .row &%oracle_servers%&              "Oracle servers"
13480 .row &%pgsql_servers%&               "default PostgreSQL servers"
13481 .row &%sqlite_lock_timeout%&         "as it says"
13482 .endtable
13483
13484
13485
13486 .section "Message ids" "SECID102"
13487 .table2
13488 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13489 .row &%message_id_header_text%&      "ditto"
13490 .endtable
13491
13492
13493
13494 .section "Embedded Perl Startup" "SECID103"
13495 .table2
13496 .row &%perl_at_start%&               "always start the interpreter"
13497 .row &%perl_startup%&                "code to obey when starting Perl"
13498 .endtable
13499
13500
13501
13502 .section "Daemon" "SECID104"
13503 .table2
13504 .row &%daemon_smtp_ports%&           "default ports"
13505 .row &%daemon_startup_retries%&      "number of times to retry"
13506 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13507 .row &%extra_local_interfaces%&      "not necessarily listened on"
13508 .row &%local_interfaces%&            "on which to listen, with optional ports"
13509 .row &%pid_file_path%&               "override compiled-in value"
13510 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13511 .endtable
13512
13513
13514
13515 .section "Resource control" "SECID105"
13516 .table2
13517 .row &%check_log_inodes%&            "before accepting a message"
13518 .row &%check_log_space%&             "before accepting a message"
13519 .row &%check_spool_inodes%&          "before accepting a message"
13520 .row &%check_spool_space%&           "before accepting a message"
13521 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13522 .row &%queue_only_load%&             "queue incoming if load high"
13523 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13524 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13525 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13526 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13527 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13528 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13529 .row &%smtp_accept_max_per_connection%& "messages per connection"
13530 .row &%smtp_accept_max_per_host%&    "connections from one host"
13531 .row &%smtp_accept_queue%&           "queue mail if more connections"
13532 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13533                                            connection"
13534 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13535 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13536 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13537 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13538 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13539 .endtable
13540
13541
13542
13543 .section "Policy controls" "SECID106"
13544 .table2
13545 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13546 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13547 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13548 .row &%acl_smtp_auth%&               "ACL for AUTH"
13549 .row &%acl_smtp_connect%&            "ACL for connection"
13550 .row &%acl_smtp_data%&               "ACL for DATA"
13551 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13552 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13553 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13554 .row &%acl_smtp_expn%&               "ACL for EXPN"
13555 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13556 .row &%acl_smtp_mail%&               "ACL for MAIL"
13557 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13558 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13559 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13560 .row &%acl_smtp_predata%&            "ACL for start of data"
13561 .row &%acl_smtp_quit%&               "ACL for QUIT"
13562 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13563 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13564 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13565 .row &%av_scanner%&                  "specify virus scanner"
13566 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13567                                       words""&"
13568 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13569 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13570 .row &%header_maxsize%&              "total size of message header"
13571 .row &%header_line_maxsize%&         "individual header line limit"
13572 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13573 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13574 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13575 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13576 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13577 .row &%host_lookup%&                 "host name looked up for these hosts"
13578 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13579 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13580 .row &%host_reject_connection%&      "reject connection from these hosts"
13581 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13582 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13583 .row &%message_size_limit%&          "for all messages"
13584 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13585 .row &%spamd_address%&               "set interface to SpamAssassin"
13586 .row &%strict_acl_vars%&             "object to unset ACL variables"
13587 .endtable
13588
13589
13590
13591 .section "Callout cache" "SECID107"
13592 .table2
13593 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13594                                          item"
13595 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13596                                          item"
13597 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13598 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13599 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13600 .endtable
13601
13602
13603
13604 .section "TLS" "SECID108"
13605 .table2
13606 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13607 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13608 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13609 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13610 .row &%tls_certificate%&             "location of server certificate"
13611 .row &%tls_crl%&                     "certificate revocation list"
13612 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13613 .row &%tls_dhparam%&                 "DH parameters for server"
13614 .row &%tls_eccurve%&                 "EC curve selection for server"
13615 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13616 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13617 .row &%tls_privatekey%&              "location of server private key"
13618 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13619 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13620 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13621 .row &%tls_verify_certificates%&     "expected client certificates"
13622 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13623 .endtable
13624
13625
13626
13627 .section "Local user handling" "SECID109"
13628 .table2
13629 .row &%finduser_retries%&            "useful in NIS environments"
13630 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13631 .row &%gecos_pattern%&               "ditto"
13632 .row &%max_username_length%&         "for systems that truncate"
13633 .row &%unknown_login%&               "used when no login name found"
13634 .row &%unknown_username%&            "ditto"
13635 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13636 .row &%uucp_from_sender%&            "ditto"
13637 .endtable
13638
13639
13640
13641 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13642 .table2
13643 .row &%header_maxsize%&              "total size of message header"
13644 .row &%header_line_maxsize%&         "individual header line limit"
13645 .row &%message_size_limit%&          "applies to all messages"
13646 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13647 .row &%received_header_text%&        "expanded to make &'Received:'&"
13648 .row &%received_headers_max%&        "for mail loop detection"
13649 .row &%recipients_max%&              "limit per message"
13650 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13651 .endtable
13652
13653
13654
13655
13656 .section "Non-SMTP incoming messages" "SECID111"
13657 .table2
13658 .row &%receive_timeout%&             "for non-SMTP messages"
13659 .endtable
13660
13661
13662
13663
13664
13665 .section "Incoming SMTP messages" "SECID112"
13666 See also the &'Policy controls'& section above.
13667
13668 .table2
13669 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13670 .row &%host_lookup%&                 "host name looked up for these hosts"
13671 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13672 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13673 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13674 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13675 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13676 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13677 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13678 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13679 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13680 .row &%smtp_accept_max_per_connection%& "messages per connection"
13681 .row &%smtp_accept_max_per_host%&    "connections from one host"
13682 .row &%smtp_accept_queue%&           "queue mail if more connections"
13683 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13684                                            connection"
13685 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13686 .row &%smtp_active_hostname%&        "host name to use in messages"
13687 .row &%smtp_banner%&                 "text for welcome banner"
13688 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13689 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13690 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13691 .row &%smtp_etrn_command%&           "what to run for ETRN"
13692 .row &%smtp_etrn_serialize%&         "only one at once"
13693 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13694 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13695 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13696 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13697 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13698 .row &%smtp_receive_timeout%&        "per command or data line"
13699 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13700 .row &%smtp_return_error_details%&   "give detail on rejections"
13701 .endtable
13702
13703
13704
13705 .section "SMTP extensions" "SECID113"
13706 .table2
13707 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13708 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13709 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13710 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13711 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13712 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13713 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13714 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13715 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13716 .endtable
13717
13718
13719
13720 .section "Processing messages" "SECID114"
13721 .table2
13722 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13723 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13724 .row &%allow_utf8_domains%&          "in addresses"
13725 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13726                                       words""&"
13727 .row &%delivery_date_remove%&        "from incoming messages"
13728 .row &%envelope_to_remove%&          "from incoming messages"
13729 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13730 .row &%headers_charset%&             "default for translations"
13731 .row &%qualify_domain%&              "default for senders"
13732 .row &%qualify_recipient%&           "default for recipients"
13733 .row &%return_path_remove%&          "from incoming messages"
13734 .row &%strip_excess_angle_brackets%& "in addresses"
13735 .row &%strip_trailing_dot%&          "at end of addresses"
13736 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13737 .endtable
13738
13739
13740
13741 .section "System filter" "SECID115"
13742 .table2
13743 .row &%system_filter%&               "locate system filter"
13744 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13745                                             directory"
13746 .row &%system_filter_file_transport%& "transport for delivery to a file"
13747 .row &%system_filter_group%&         "group for filter running"
13748 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13749 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13750 .row &%system_filter_user%&          "user for filter running"
13751 .endtable
13752
13753
13754
13755 .section "Routing and delivery" "SECID116"
13756 .table2
13757 .row &%disable_ipv6%&                "do no IPv6 processing"
13758 .row &%dns_again_means_nonexist%&    "for broken domains"
13759 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13760 .row &%dns_dnssec_ok%&               "parameter for resolver"
13761 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13762 .row &%dns_retrans%&                 "parameter for resolver"
13763 .row &%dns_retry%&                   "parameter for resolver"
13764 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13765 .row &%dns_use_edns0%&               "parameter for resolver"
13766 .row &%hold_domains%&                "hold delivery for these domains"
13767 .row &%local_interfaces%&            "for routing checks"
13768 .row &%queue_domains%&               "no immediate delivery for these"
13769 .row &%queue_only%&                  "no immediate delivery at all"
13770 .row &%queue_only_file%&             "no immediate delivery if file exists"
13771 .row &%queue_only_load%&             "no immediate delivery if load is high"
13772 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13773 .row &%queue_only_override%&         "allow command line to override"
13774 .row &%queue_run_in_order%&          "order of arrival"
13775 .row &%queue_run_max%&               "of simultaneous queue runners"
13776 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13777 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13778 .row &%remote_sort_domains%&         "order of remote deliveries"
13779 .row &%retry_data_expire%&           "timeout for retry data"
13780 .row &%retry_interval_max%&          "safety net for retry rules"
13781 .endtable
13782
13783
13784
13785 .section "Bounce and warning messages" "SECID117"
13786 .table2
13787 .row &%bounce_message_file%&         "content of bounce"
13788 .row &%bounce_message_text%&         "content of bounce"
13789 .row &%bounce_return_body%&          "include body if returning message"
13790 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13791 .row &%bounce_return_message%&       "include original message in bounce"
13792 .row &%bounce_return_size_limit%&    "limit on returned message"
13793 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13794 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13795 .row &%errors_copy%&                 "copy bounce messages"
13796 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13797 .row &%delay_warning%&               "time schedule"
13798 .row &%delay_warning_condition%&     "condition for warning messages"
13799 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13800 .row &%smtp_return_error_details%&   "give detail on rejections"
13801 .row &%warn_message_file%&           "content of warning message"
13802 .endtable
13803
13804
13805
13806 .section "Alphabetical list of main options" "SECTalomo"
13807 Those options that undergo string expansion before use are marked with
13808 &dagger;.
13809
13810 .option accept_8bitmime main boolean true
13811 .cindex "8BITMIME"
13812 .cindex "8-bit characters"
13813 .cindex "log" "selectors"
13814 .cindex "log" "8BITMIME"
13815 This option causes Exim to send 8BITMIME in its response to an SMTP
13816 EHLO command, and to accept the BODY= parameter on MAIL commands.
13817 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13818 takes no steps to do anything special with messages received by this route.
13819
13820 Historically Exim kept this option off by default, but the maintainers
13821 feel that in today's Internet, this causes more problems than it solves.
13822 It now defaults to true.
13823 A more detailed analysis of the issues is provided by Dan Bernstein:
13824 .display
13825 &url(http://cr.yp.to/smtp/8bitmime.html)
13826 .endd
13827
13828 To log received 8BITMIME status use
13829 .code
13830 log_selector = +8bitmime
13831 .endd
13832
13833 .option acl_not_smtp main string&!! unset
13834 .cindex "&ACL;" "for non-SMTP messages"
13835 .cindex "non-SMTP messages" "ACLs for"
13836 This option defines the ACL that is run when a non-SMTP message has been
13837 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13838 further details.
13839
13840 .option acl_not_smtp_mime main string&!! unset
13841 This option defines the ACL that is run for individual MIME parts of non-SMTP
13842 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13843 SMTP messages.
13844
13845 .option acl_not_smtp_start main string&!! unset
13846 .cindex "&ACL;" "at start of non-SMTP message"
13847 .cindex "non-SMTP messages" "ACLs for"
13848 This option defines the ACL that is run before Exim starts reading a
13849 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13850
13851 .option acl_smtp_auth main string&!! unset
13852 .cindex "&ACL;" "setting up for SMTP commands"
13853 .cindex "AUTH" "ACL for"
13854 This option defines the ACL that is run when an SMTP AUTH command is
13855 received. See chapter &<<CHAPACL>>& for further details.
13856
13857 .option acl_smtp_connect main string&!! unset
13858 .cindex "&ACL;" "on SMTP connection"
13859 This option defines the ACL that is run when an SMTP connection is received.
13860 See chapter &<<CHAPACL>>& for further details.
13861
13862 .option acl_smtp_data main string&!! unset
13863 .cindex "DATA" "ACL for"
13864 This option defines the ACL that is run after an SMTP DATA command has been
13865 processed and the message itself has been received, but before the final
13866 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13867
13868 .option acl_smtp_data_prdr main string&!! accept
13869 .cindex "PRDR" "ACL for"
13870 .cindex "DATA" "PRDR ACL for"
13871 .cindex "&ACL;" "PRDR-related"
13872 .cindex "&ACL;" "per-user data processing"
13873 This option defines the ACL that,
13874 if the PRDR feature has been negotiated,
13875 is run for each recipient after an SMTP DATA command has been
13876 processed and the message itself has been received, but before the
13877 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13878
13879 .option acl_smtp_dkim main string&!! unset
13880 .cindex DKIM "ACL for"
13881 This option defines the ACL that is run for each DKIM signature
13882 of a received message.
13883 See chapter &<<CHAPdkim>>& for further details.
13884
13885 .option acl_smtp_etrn main string&!! unset
13886 .cindex "ETRN" "ACL for"
13887 This option defines the ACL that is run when an SMTP ETRN command is
13888 received. See chapter &<<CHAPACL>>& for further details.
13889
13890 .option acl_smtp_expn main string&!! unset
13891 .cindex "EXPN" "ACL for"
13892 This option defines the ACL that is run when an SMTP EXPN command is
13893 received. See chapter &<<CHAPACL>>& for further details.
13894
13895 .option acl_smtp_helo main string&!! unset
13896 .cindex "EHLO" "ACL for"
13897 .cindex "HELO" "ACL for"
13898 This option defines the ACL that is run when an SMTP EHLO or HELO
13899 command is received. See chapter &<<CHAPACL>>& for further details.
13900
13901
13902 .option acl_smtp_mail main string&!! unset
13903 .cindex "MAIL" "ACL for"
13904 This option defines the ACL that is run when an SMTP MAIL command is
13905 received. See chapter &<<CHAPACL>>& for further details.
13906
13907 .option acl_smtp_mailauth main string&!! unset
13908 .cindex "AUTH" "on MAIL command"
13909 This option defines the ACL that is run when there is an AUTH parameter on
13910 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13911 &<<CHAPSMTPAUTH>>& for details of authentication.
13912
13913 .option acl_smtp_mime main string&!! unset
13914 .cindex "MIME content scanning" "ACL for"
13915 This option is available when Exim is built with the content-scanning
13916 extension. It defines the ACL that is run for each MIME part in a message. See
13917 section &<<SECTscanmimepart>>& for details.
13918
13919 .option acl_smtp_notquit main string&!! unset
13920 .cindex "not-QUIT, ACL for"
13921 This option defines the ACL that is run when an SMTP session
13922 ends without a QUIT command being received.
13923 See chapter &<<CHAPACL>>& for further details.
13924
13925 .option acl_smtp_predata main string&!! unset
13926 This option defines the ACL that is run when an SMTP DATA command is
13927 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13928 further details.
13929
13930 .option acl_smtp_quit main string&!! unset
13931 .cindex "QUIT, ACL for"
13932 This option defines the ACL that is run when an SMTP QUIT command is
13933 received. See chapter &<<CHAPACL>>& for further details.
13934
13935 .option acl_smtp_rcpt main string&!! unset
13936 .cindex "RCPT" "ACL for"
13937 This option defines the ACL that is run when an SMTP RCPT command is
13938 received. See chapter &<<CHAPACL>>& for further details.
13939
13940 .option acl_smtp_starttls main string&!! unset
13941 .cindex "STARTTLS, ACL for"
13942 This option defines the ACL that is run when an SMTP STARTTLS command is
13943 received. See chapter &<<CHAPACL>>& for further details.
13944
13945 .option acl_smtp_vrfy main string&!! unset
13946 .cindex "VRFY" "ACL for"
13947 This option defines the ACL that is run when an SMTP VRFY command is
13948 received. See chapter &<<CHAPACL>>& for further details.
13949
13950 .option admin_groups main "string list&!!" unset
13951 .cindex "admin user"
13952 This option is expanded just once, at the start of Exim's processing. If the
13953 current group or any of the supplementary groups of an Exim caller is in this
13954 colon-separated list, the caller has admin privileges. If all your system
13955 programmers are in a specific group, for example, you can give them all Exim
13956 admin privileges by putting that group in &%admin_groups%&. However, this does
13957 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13958 To permit this, you have to add individuals to the Exim group.
13959
13960 .option allow_domain_literals main boolean false
13961 .cindex "domain literal"
13962 If this option is set, the RFC 2822 domain literal format is permitted in
13963 email addresses. The option is not set by default, because the domain literal
13964 format is not normally required these days, and few people know about it. It
13965 has, however, been exploited by mail abusers.
13966
13967 Unfortunately, it seems that some DNS black list maintainers are using this
13968 format to report black listing to postmasters. If you want to accept messages
13969 addressed to your hosts by IP address, you need to set
13970 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13971 domains (defined in the named domain list &%local_domains%& in the default
13972 configuration). This &"magic string"& matches the domain literal form of all
13973 the local host's IP addresses.
13974
13975
13976 .option allow_mx_to_ip main boolean false
13977 .cindex "MX record" "pointing to IP address"
13978 It appears that more and more DNS zone administrators are breaking the rules
13979 and putting domain names that look like IP addresses on the right hand side of
13980 MX records. Exim follows the rules and rejects this, giving an error message
13981 that explains the misconfiguration. However, some other MTAs support this
13982 practice, so to avoid &"Why can't Exim do this?"& complaints,
13983 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13984 recommended, except when you have no other choice.
13985
13986 .option allow_utf8_domains main boolean false
13987 .cindex "domain" "UTF-8 characters in"
13988 .cindex "UTF-8" "in domain name"
13989 Lots of discussion is going on about internationalized domain names. One
13990 camp is strongly in favour of just using UTF-8 characters, and it seems
13991 that at least two other MTAs permit this. This option allows Exim users to
13992 experiment if they wish.
13993
13994 If it is set true, Exim's domain parsing function allows valid
13995 UTF-8 multicharacters to appear in domain name components, in addition to
13996 letters, digits, and hyphens. However, just setting this option is not
13997 enough; if you want to look up these domain names in the DNS, you must also
13998 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13999 suitable setting is:
14000 .code
14001 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14002   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14003 .endd
14004 Alternatively, you can just disable this feature by setting
14005 .code
14006 dns_check_names_pattern =
14007 .endd
14008 That is, set the option to an empty string so that no check is done.
14009
14010
14011 .option auth_advertise_hosts main "host list&!!" *
14012 .cindex "authentication" "advertising"
14013 .cindex "AUTH" "advertising"
14014 If any server authentication mechanisms are configured, Exim advertises them in
14015 response to an EHLO command only if the calling host matches this list.
14016 Otherwise, Exim does not advertise AUTH.
14017 Exim does not accept AUTH commands from clients to which it has not
14018 advertised the availability of AUTH. The advertising of individual
14019 authentication mechanisms can be controlled by the use of the
14020 &%server_advertise_condition%& generic authenticator option on the individual
14021 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14022
14023 Certain mail clients (for example, Netscape) require the user to provide a name
14024 and password for authentication if AUTH is advertised, even though it may
14025 not be needed (the host may accept messages from hosts on its local LAN without
14026 authentication, for example). The &%auth_advertise_hosts%& option can be used
14027 to make these clients more friendly by excluding them from the set of hosts to
14028 which Exim advertises AUTH.
14029
14030 .cindex "AUTH" "advertising when encrypted"
14031 If you want to advertise the availability of AUTH only when the connection
14032 is encrypted using TLS, you can make use of the fact that the value of this
14033 option is expanded, with a setting like this:
14034 .code
14035 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14036 .endd
14037 .vindex "&$tls_in_cipher$&"
14038 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14039 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14040 expansion is *, which matches all hosts.
14041
14042
14043 .option auto_thaw main time 0s
14044 .cindex "thawing messages"
14045 .cindex "unfreezing messages"
14046 If this option is set to a time greater than zero, a queue runner will try a
14047 new delivery attempt on any frozen message, other than a bounce message, if
14048 this much time has passed since it was frozen. This may result in the message
14049 being re-frozen if nothing has changed since the last attempt. It is a way of
14050 saying &"keep on trying, even though there are big problems"&.
14051
14052 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14053 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14054 thought to be very useful any more, and its use should probably be avoided.
14055
14056
14057 .option av_scanner main string "see below"
14058 This option is available if Exim is built with the content-scanning extension.
14059 It specifies which anti-virus scanner to use. The default value is:
14060 .code
14061 sophie:/var/run/sophie
14062 .endd
14063 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14064 before use. See section &<<SECTscanvirus>>& for further details.
14065
14066
14067 .option bi_command main string unset
14068 .oindex "&%-bi%&"
14069 This option supplies the name of a command that is run when Exim is called with
14070 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14071 just the command name, it is not a complete command line. If an argument is
14072 required, it must come from the &%-oA%& command line option.
14073
14074
14075 .option bounce_message_file main string unset
14076 .cindex "bounce message" "customizing"
14077 .cindex "customizing" "bounce message"
14078 This option defines a template file containing paragraphs of text to be used
14079 for constructing bounce messages.  Details of the file's contents are given in
14080 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14081
14082
14083 .option bounce_message_text main string unset
14084 When this option is set, its contents are included in the default bounce
14085 message immediately after &"This message was created automatically by mail
14086 delivery software."& It is not used if &%bounce_message_file%& is set.
14087
14088 .option bounce_return_body main boolean true
14089 .cindex "bounce message" "including body"
14090 This option controls whether the body of an incoming message is included in a
14091 bounce message when &%bounce_return_message%& is true. The default setting
14092 causes the entire message, both header and body, to be returned (subject to the
14093 value of &%bounce_return_size_limit%&). If this option is false, only the
14094 message header is included. In the case of a non-SMTP message containing an
14095 error that is detected during reception, only those header lines preceding the
14096 point at which the error was detected are returned.
14097 .cindex "bounce message" "including original"
14098
14099 .option bounce_return_linesize_limit main integer 998
14100 .cindex "size" "of bounce lines, limit"
14101 .cindex "bounce message" "line length limit"
14102 .cindex "limit" "bounce message line length"
14103 This option sets a limit in bytes on the line length of messages
14104 that are returned to senders due to delivery problems,
14105 when &%bounce_return_message%& is true.
14106 The default value corresponds to RFC limits.
14107 If the message being returned has lines longer than this value it is
14108 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14109
14110 The option also applies to bounces returned when an error is detected
14111 during reception of a messsage.
14112 In this case lines from the original are truncated.
14113
14114 The option does not apply to messages generated by an &(autoreply)& transport.
14115
14116
14117 .option bounce_return_message main boolean true
14118 If this option is set false, none of the original message is included in
14119 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14120 &%bounce_return_body%&.
14121
14122
14123 .option bounce_return_size_limit main integer 100K
14124 .cindex "size" "of bounce, limit"
14125 .cindex "bounce message" "size limit"
14126 .cindex "limit" "bounce message size"
14127 This option sets a limit in bytes on the size of messages that are returned to
14128 senders as part of bounce messages when &%bounce_return_message%& is true. The
14129 limit should be less than the value of the global &%message_size_limit%& and of
14130 any &%message_size_limit%& settings on transports, to allow for the bounce text
14131 that Exim generates. If this option is set to zero there is no limit.
14132
14133 When the body of any message that is to be included in a bounce message is
14134 greater than the limit, it is truncated, and a comment pointing this out is
14135 added at the top. The actual cutoff may be greater than the value given, owing
14136 to the use of buffering for transferring the message in chunks (typically 8K in
14137 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14138 messages.
14139
14140 .option bounce_sender_authentication main string unset
14141 .cindex "bounce message" "sender authentication"
14142 .cindex "authentication" "bounce message"
14143 .cindex "AUTH" "on bounce message"
14144 This option provides an authenticated sender address that is sent with any
14145 bounce messages generated by Exim that are sent over an authenticated SMTP
14146 connection. A typical setting might be:
14147 .code
14148 bounce_sender_authentication = mailer-daemon@my.domain.example
14149 .endd
14150 which would cause bounce messages to be sent using the SMTP command:
14151 .code
14152 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14153 .endd
14154 The value of &%bounce_sender_authentication%& must always be a complete email
14155 address.
14156
14157 .option callout_domain_negative_expire main time 3h
14158 .cindex "caching" "callout timeouts"
14159 .cindex "callout" "caching timeouts"
14160 This option specifies the expiry time for negative callout cache data for a
14161 domain. See section &<<SECTcallver>>& for details of callout verification, and
14162 section &<<SECTcallvercache>>& for details of the caching.
14163
14164
14165 .option callout_domain_positive_expire main time 7d
14166 This option specifies the expiry time for positive callout cache data for a
14167 domain. See section &<<SECTcallver>>& for details of callout verification, and
14168 section &<<SECTcallvercache>>& for details of the caching.
14169
14170
14171 .option callout_negative_expire main time 2h
14172 This option specifies the expiry time for negative callout cache data for an
14173 address. See section &<<SECTcallver>>& for details of callout verification, and
14174 section &<<SECTcallvercache>>& for details of the caching.
14175
14176
14177 .option callout_positive_expire main time 24h
14178 This option specifies the expiry time for positive callout cache data for an
14179 address. See section &<<SECTcallver>>& for details of callout verification, and
14180 section &<<SECTcallvercache>>& for details of the caching.
14181
14182
14183 .option callout_random_local_part main string&!! "see below"
14184 This option defines the &"random"& local part that can be used as part of
14185 callout verification. The default value is
14186 .code
14187 $primary_hostname-$tod_epoch-testing
14188 .endd
14189 See section &<<CALLaddparcall>>& for details of how this value is used.
14190
14191
14192 .option check_log_inodes main integer 0
14193 See &%check_spool_space%& below.
14194
14195
14196 .option check_log_space main integer 0
14197 See &%check_spool_space%& below.
14198
14199 .oindex "&%check_rfc2047_length%&"
14200 .cindex "RFC 2047" "disabling length check"
14201 .option check_rfc2047_length main boolean true
14202 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14203 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14204 word; strings to be encoded that exceed this length are supposed to use
14205 multiple encoded words. By default, Exim does not recognize encoded words that
14206 exceed the maximum length. However, it seems that some software, in violation
14207 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14208 set false, Exim recognizes encoded words of any length.
14209
14210
14211 .option check_spool_inodes main integer 0
14212 See &%check_spool_space%& below.
14213
14214
14215 .option check_spool_space main integer 0
14216 .cindex "checking disk space"
14217 .cindex "disk space, checking"
14218 .cindex "spool directory" "checking space"
14219 The four &%check_...%& options allow for checking of disk resources before a
14220 message is accepted.
14221
14222 .vindex "&$log_inodes$&"
14223 .vindex "&$log_space$&"
14224 .vindex "&$spool_inodes$&"
14225 .vindex "&$spool_space$&"
14226 When any of these options are set, they apply to all incoming messages. If you
14227 want to apply different checks to different kinds of message, you can do so by
14228 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14229 &$spool_space$& in an ACL with appropriate additional conditions.
14230
14231
14232 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14233 either value is greater than zero, for example:
14234 .code
14235 check_spool_space = 10M
14236 check_spool_inodes = 100
14237 .endd
14238 The spool partition is the one that contains the directory defined by
14239 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14240 transit.
14241
14242 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14243 files are written if either is greater than zero. These should be set only if
14244 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14245
14246 If there is less space or fewer inodes than requested, Exim refuses to accept
14247 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14248 error response to the MAIL command. If ESMTP is in use and there was a
14249 SIZE parameter on the MAIL command, its value is added to the
14250 &%check_spool_space%& value, and the check is performed even if
14251 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14252
14253 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14254 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14255
14256 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14257 failure a message is written to stderr and Exim exits with a non-zero code, as
14258 it obviously cannot send an error message of any kind.
14259
14260 .option daemon_smtp_ports main string &`smtp`&
14261 .cindex "port" "for daemon"
14262 .cindex "TCP/IP" "setting listening ports"
14263 This option specifies one or more default SMTP ports on which the Exim daemon
14264 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14265 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14266
14267 .option daemon_startup_retries main integer 9
14268 .cindex "daemon startup, retrying"
14269 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14270 the daemon at startup when it cannot immediately bind a listening socket
14271 (typically because the socket is already in use): &%daemon_startup_retries%&
14272 defines the number of retries after the first failure, and
14273 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14274
14275 .option daemon_startup_sleep main time 30s
14276 See &%daemon_startup_retries%&.
14277
14278 .option delay_warning main "time list" 24h
14279 .cindex "warning of delay"
14280 .cindex "delay warning, specifying"
14281 When a message is delayed, Exim sends a warning message to the sender at
14282 intervals specified by this option. The data is a colon-separated list of times
14283 after which to send warning messages. If the value of the option is an empty
14284 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14285 message has been on the queue for longer than the last time, the last interval
14286 between the times is used to compute subsequent warning times. For example,
14287 with
14288 .code
14289 delay_warning = 4h:8h:24h
14290 .endd
14291 the first message is sent after 4 hours, the second after 8 hours, and
14292 the third one after 24 hours. After that, messages are sent every 16 hours,
14293 because that is the interval between the last two times on the list. If you set
14294 just one time, it specifies the repeat interval. For example, with:
14295 .code
14296 delay_warning = 6h
14297 .endd
14298 messages are repeated every six hours. To stop warnings after a given time, set
14299 a very large time at the end of the list. For example:
14300 .code
14301 delay_warning = 2h:12h:99d
14302 .endd
14303 Note that the option is only evaluated at the time a delivery attempt fails,
14304 which depends on retry and queue-runner configuration.
14305 Typically retries will be configured more frequently than warning messages.
14306
14307 .option delay_warning_condition main string&!! "see below"
14308 .vindex "&$domain$&"
14309 The string is expanded at the time a warning message might be sent. If all the
14310 deferred addresses have the same domain, it is set in &$domain$& during the
14311 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14312 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14313 &"false"& (the comparison being done caselessly) then the warning message is
14314 not sent. The default is:
14315 .code
14316 delay_warning_condition = ${if or {\
14317   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14318   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14319   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14320   } {no}{yes}}
14321 .endd
14322 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14323 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14324 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14325 &"auto-replied"& in an &'Auto-Submitted:'& header.
14326
14327 .option deliver_drop_privilege main boolean false
14328 .cindex "unprivileged delivery"
14329 .cindex "delivery" "unprivileged"
14330 If this option is set true, Exim drops its root privilege at the start of a
14331 delivery process, and runs as the Exim user throughout. This severely restricts
14332 the kinds of local delivery that are possible, but is viable in certain types
14333 of configuration. There is a discussion about the use of root privilege in
14334 chapter &<<CHAPsecurity>>&.
14335
14336 .option deliver_queue_load_max main fixed-point unset
14337 .cindex "load average"
14338 .cindex "queue runner" "abandoning"
14339 When this option is set, a queue run is abandoned if the system load average
14340 becomes greater than the value of the option. The option has no effect on
14341 ancient operating systems on which Exim cannot determine the load average.
14342 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14343
14344
14345 .option delivery_date_remove main boolean true
14346 .cindex "&'Delivery-date:'& header line"
14347 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14348 message when it is delivered, in exactly the same way as &'Return-path:'& is
14349 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14350 should not be present in incoming messages, and this option causes them to be
14351 removed at the time the message is received, to avoid any problems that might
14352 occur when a delivered message is subsequently sent on to some other recipient.
14353
14354 .option disable_fsync main boolean false
14355 .cindex "&[fsync()]&, disabling"
14356 This option is available only if Exim was built with the compile-time option
14357 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14358 a runtime configuration generates an &"unknown option"& error. You should not
14359 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14360 really, really, really understand what you are doing. &'No pre-compiled
14361 distributions of Exim should ever make this option available.'&
14362
14363 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14364 updated files' data to be written to disc before continuing. Unexpected events
14365 such as crashes and power outages may cause data to be lost or scrambled.
14366 Here be Dragons. &*Beware.*&
14367
14368
14369 .option disable_ipv6 main boolean false
14370 .cindex "IPv6" "disabling"
14371 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14372 activities take place. AAAA records are never looked up, and any IPv6 addresses
14373 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14374 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14375 to handle IPv6 literal addresses.
14376
14377
14378 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14379 .cindex DKIM "controlling calls to the ACL"
14380 This option gives a list of DKIM domains for which the DKIM ACL is run.
14381 It is expanded after the message is received; by default it runs
14382 the ACL once for each signature in the message.
14383 See chapter &<<CHAPdkim>>&.
14384
14385
14386 .option dns_again_means_nonexist main "domain list&!!" unset
14387 .cindex "DNS" "&""try again""& response; overriding"
14388 DNS lookups give a &"try again"& response for the DNS errors
14389 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14390 keep trying to deliver a message, or to give repeated temporary errors to
14391 incoming mail. Sometimes the effect is caused by a badly set up name server and
14392 may persist for a long time. If a domain which exhibits this problem matches
14393 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14394 This option should be used with care. You can make it apply to reverse lookups
14395 by a setting such as this:
14396 .code
14397 dns_again_means_nonexist = *.in-addr.arpa
14398 .endd
14399 This option applies to all DNS lookups that Exim does. It also applies when the
14400 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14401 since these are most likely to be caused by DNS lookup problems. The
14402 &(dnslookup)& router has some options of its own for controlling what happens
14403 when lookups for MX or SRV records give temporary errors. These more specific
14404 options are applied after this global option.
14405
14406 .option dns_check_names_pattern main string "see below"
14407 .cindex "DNS" "pre-check of name syntax"
14408 When this option is set to a non-empty string, it causes Exim to check domain
14409 names for characters that are not allowed in host names before handing them to
14410 the DNS resolver, because some resolvers give temporary errors for names that
14411 contain unusual characters. If a domain name contains any unwanted characters,
14412 a &"not found"& result is forced, and the resolver is not called. The check is
14413 done by matching the domain name against a regular expression, which is the
14414 value of this option. The default pattern is
14415 .code
14416 dns_check_names_pattern = \
14417   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14418 .endd
14419 which permits only letters, digits, slashes, and hyphens in components, but
14420 they must start and end with a letter or digit. Slashes are not, in fact,
14421 permitted in host names, but they are found in certain NS records (which can be
14422 accessed in Exim by using a &%dnsdb%& lookup). If you set
14423 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14424 empty string.
14425
14426 .option dns_csa_search_limit main integer 5
14427 This option controls the depth of parental searching for CSA SRV records in the
14428 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14429
14430 .option dns_csa_use_reverse main boolean true
14431 This option controls whether or not an IP address, given as a CSA domain, is
14432 reversed and looked up in the reverse DNS, as described in more detail in
14433 section &<<SECTverifyCSA>>&.
14434
14435
14436 .option dns_dnssec_ok main integer -1
14437 .cindex "DNS" "resolver options"
14438 .cindex "DNS" "DNSSEC"
14439 If this option is set to a non-negative number then Exim will initialise the
14440 DNS resolver library to either use or not use DNSSEC, overriding the system
14441 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14442
14443 If the resolver library does not support DNSSEC then this option has no effect.
14444
14445
14446 .option dns_ipv4_lookup main "domain list&!!" unset
14447 .cindex "IPv6" "DNS lookup for AAAA records"
14448 .cindex "DNS" "IPv6 lookup for AAAA records"
14449 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14450 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14451 (A records) when trying to find IP addresses for hosts, unless the host's
14452 domain matches this list.
14453
14454 This is a fudge to help with name servers that give big delays or otherwise do
14455 not work for the AAAA record type. In due course, when the world's name
14456 servers have all been upgraded, there should be no need for this option.
14457
14458
14459 .option dns_retrans main time 0s
14460 .cindex "DNS" "resolver options"
14461 .cindex timeout "dns lookup"
14462 .cindex "DNS" timeout
14463 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14464 retransmission and retry parameters for DNS lookups. Values of zero (the
14465 defaults) leave the system default settings unchanged. The first value is the
14466 time between retries, and the second is the number of retries. It isn't
14467 totally clear exactly how these settings affect the total time a DNS lookup may
14468 take. I haven't found any documentation about timeouts on DNS lookups; these
14469 parameter values are available in the external resolver interface structure,
14470 but nowhere does it seem to describe how they are used or what you might want
14471 to set in them.
14472 See also the &%slow_lookup_log%& option.
14473
14474
14475 .option dns_retry main integer 0
14476 See &%dns_retrans%& above.
14477
14478
14479 .option dns_trust_aa main "domain list&!!" unset
14480 .cindex "DNS" "resolver options"
14481 .cindex "DNS" "DNSSEC"
14482 If this option is set then lookup results marked with the AA bit
14483 (Authoritative Answer) are trusted the same way as if they were
14484 DNSSEC-verified. The authority section's name of the answer must
14485 match with this expanded domain list.
14486
14487 Use this option only if you talk directly to a resolver that is
14488 authoritative for some zones and does not set the AD (Authentic Data)
14489 bit in the answer. Some DNS servers may have an configuration option to
14490 mark the answers from their own zones as verified (they set the AD bit).
14491 Others do not have this option. It is considered as poor practice using
14492 a resolver that is an authoritative server for some zones.
14493
14494 Use this option only if you really have to (e.g. if you want
14495 to use DANE for remote delivery to a server that is listed in the DNS
14496 zones that your resolver is authoritative for).
14497
14498 If the DNS answer packet has the AA bit set and contains resource record
14499 in the answer section, the name of the first NS record appearing in the
14500 authority section is compared against the list. If the answer packet is
14501 authoritative but the answer section is empty, the name of the first SOA
14502 record in the authoritative section is used instead.
14503
14504 .cindex "DNS" "resolver options"
14505 .option dns_use_edns0 main integer -1
14506 .cindex "DNS" "resolver options"
14507 .cindex "DNS" "EDNS0"
14508 If this option is set to a non-negative number then Exim will initialise the
14509 DNS resolver library to either use or not use EDNS0 extensions, overriding
14510 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14511 on.
14512
14513 If the resolver library does not support EDNS0 then this option has no effect.
14514
14515
14516 .option drop_cr main boolean false
14517 This is an obsolete option that is now a no-op. It used to affect the way Exim
14518 handled CR and LF characters in incoming messages. What happens now is
14519 described in section &<<SECTlineendings>>&.
14520
14521 .option dsn_advertise_hosts main "host list&!!" unset
14522 .cindex "bounce messages" "success"
14523 .cindex "DSN" "success"
14524 .cindex "Delivery Status Notification" "success"
14525 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14526 and accepted from, these hosts.
14527 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14528 and RET and ORCPT options on MAIL FROM commands.
14529 A NOTIFY=SUCCESS option requests success-DSN messages.
14530 A NOTIFY= option with no argument requests that no delay or failure DSNs
14531 are sent.
14532
14533 .option dsn_from main "string&!!" "see below"
14534 .cindex "&'From:'& header line" "in bounces"
14535 .cindex "bounce messages" "&'From:'& line, specifying"
14536 This option can be used to vary the contents of &'From:'& header lines in
14537 bounces and other automatically generated messages (&"Delivery Status
14538 Notifications"& &-- hence the name of the option). The default setting is:
14539 .code
14540 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14541 .endd
14542 The value is expanded every time it is needed. If the expansion fails, a
14543 panic is logged, and the default value is used.
14544
14545 .option envelope_to_remove main boolean true
14546 .cindex "&'Envelope-to:'& header line"
14547 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14548 message when it is delivered, in exactly the same way as &'Return-path:'& is
14549 handled. &'Envelope-to:'& records the original recipient address from the
14550 message's envelope that caused the delivery to happen. Such headers should not
14551 be present in incoming messages, and this option causes them to be removed at
14552 the time the message is received, to avoid any problems that might occur when a
14553 delivered message is subsequently sent on to some other recipient.
14554
14555
14556 .option errors_copy main "string list&!!" unset
14557 .cindex "bounce message" "copy to other address"
14558 .cindex "copy of bounce message"
14559 Setting this option causes Exim to send bcc copies of bounce messages that it
14560 generates to other addresses. &*Note*&: This does not apply to bounce messages
14561 coming from elsewhere. The value of the option is a colon-separated list of
14562 items. Each item consists of a pattern, terminated by white space, followed by
14563 a comma-separated list of email addresses. If a pattern contains spaces, it
14564 must be enclosed in double quotes.
14565
14566 Each pattern is processed in the same way as a single item in an address list
14567 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14568 the bounce message, the message is copied to the addresses on the list. The
14569 items are scanned in order, and once a matching one is found, no further items
14570 are examined. For example:
14571 .code
14572 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14573               rqps@mydomain   hostmaster@mydomain.example,\
14574                               postmaster@mydomain.example
14575 .endd
14576 .vindex "&$domain$&"
14577 .vindex "&$local_part$&"
14578 The address list is expanded before use. The expansion variables &$local_part$&
14579 and &$domain$& are set from the original recipient of the error message, and if
14580 there was any wildcard matching in the pattern, the expansion
14581 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14582 variables &$0$&, &$1$&, etc. are set in the normal way.
14583
14584
14585 .option errors_reply_to main string unset
14586 .cindex "bounce message" "&'Reply-to:'& in"
14587 By default, Exim's bounce and delivery warning messages contain the header line
14588 .display
14589 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14590 .endd
14591 .oindex &%quota_warn_message%&
14592 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14593 A warning message that is generated by the &%quota_warn_message%& option in an
14594 &(appendfile)& transport may contain its own &'From:'& header line that
14595 overrides the default.
14596
14597 Experience shows that people reply to bounce messages. If the
14598 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14599 and warning messages. For example:
14600 .code
14601 errors_reply_to = postmaster@my.domain.example
14602 .endd
14603 The value of the option is not expanded. It must specify a valid RFC 2822
14604 address. However, if a warning message that is generated by the
14605 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14606 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14607 not used.
14608
14609
14610 .new
14611 .option event_action main string&!! unset
14612 .cindex events
14613 This option declares a string to be expanded for Exim's events mechanism.
14614 For details see &<<CHAPevents>>&.
14615 .wen
14616
14617
14618 .option exim_group main string "compile-time configured"
14619 .cindex "gid (group id)" "Exim's own"
14620 .cindex "Exim group"
14621 This option changes the gid under which Exim runs when it gives up root
14622 privilege. The default value is compiled into the binary. The value of this
14623 option is used only when &%exim_user%& is also set. Unless it consists entirely
14624 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14625 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14626 security issues.
14627
14628
14629 .option exim_path main string "see below"
14630 .cindex "Exim binary, path name"
14631 This option specifies the path name of the Exim binary, which is used when Exim
14632 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14633 the directory configured at compile time by the BIN_DIRECTORY setting. It
14634 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14635 other place.
14636 &*Warning*&: Do not use a macro to define the value of this option, because
14637 you will break those Exim utilities that scan the configuration file to find
14638 where the binary is. (They then use the &%-bP%& option to extract option
14639 settings such as the value of &%spool_directory%&.)
14640
14641
14642 .option exim_user main string "compile-time configured"
14643 .cindex "uid (user id)" "Exim's own"
14644 .cindex "Exim user"
14645 This option changes the uid under which Exim runs when it gives up root
14646 privilege. The default value is compiled into the binary. Ownership of the run
14647 time configuration file and the use of the &%-C%& and &%-D%& command line
14648 options is checked against the values in the binary, not what is set here.
14649
14650 Unless it consists entirely of digits, the string is looked up using
14651 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14652 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14653 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14654
14655
14656 .option extra_local_interfaces main "string list" unset
14657 This option defines network interfaces that are to be considered local when
14658 routing, but which are not used for listening by the daemon. See section
14659 &<<SECTreclocipadd>>& for details.
14660
14661
14662 . Allow this long option name to split; give it unsplit as a fifth argument
14663 . for the automatic .oindex that is generated by .option.
14664
14665 .option "extract_addresses_remove_arguments" main boolean true &&&
14666          extract_addresses_remove_arguments
14667 .oindex "&%-t%&"
14668 .cindex "command line" "addresses with &%-t%&"
14669 .cindex "Sendmail compatibility" "&%-t%& option"
14670 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14671 are present on the command line when the &%-t%& option is used to build an
14672 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14673 line addresses are removed from the recipients list. This is also how Smail
14674 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14675 command line addresses are added to those obtained from the header lines. When
14676 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14677 argument headers. If it is set false, Exim adds rather than removes argument
14678 addresses.
14679
14680
14681 .option finduser_retries main integer 0
14682 .cindex "NIS, retrying user lookups"
14683 On systems running NIS or other schemes in which user and group information is
14684 distributed from a remote system, there can be times when &[getpwnam()]& and
14685 related functions fail, even when given valid data, because things time out.
14686 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14687 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14688 many extra times to find a user or a group, waiting for one second between
14689 retries.
14690
14691 .cindex "&_/etc/passwd_&" "multiple reading of"
14692 You should not set this option greater than zero if your user information is in
14693 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14694 search the file multiple times for non-existent users, and also cause delay.
14695
14696
14697
14698 .option freeze_tell main "string list, comma separated" unset
14699 .cindex "freezing messages" "sending a message when freezing"
14700 On encountering certain errors, or when configured to do so in a system filter,
14701 ACL, or special router, Exim freezes a message. This means that no further
14702 delivery attempts take place until an administrator thaws the message, or the
14703 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14704 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14705 warning message whenever it freezes something, unless the message it is
14706 freezing is a locally-generated bounce message. (Without this exception there
14707 is the possibility of looping.) The warning message is sent to the addresses
14708 supplied as the comma-separated value of this option. If several of the
14709 message's addresses cause freezing, only a single message is sent. If the
14710 freezing was automatic, the reason(s) for freezing can be found in the message
14711 log. If you configure freezing in a filter or ACL, you must arrange for any
14712 logging that you require.
14713
14714
14715 .option gecos_name main string&!! unset
14716 .cindex "HP-UX"
14717 .cindex "&""gecos""& field, parsing"
14718 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14719 password file to hold other information in addition to users' real names. Exim
14720 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14721 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14722 of the field are used unchanged, except that, if an ampersand is encountered,
14723 it is replaced by the user's login name with the first character forced to
14724 upper case, since this is a convention that is observed on many systems.
14725
14726 When these options are set, &%gecos_pattern%& is treated as a regular
14727 expression that is to be applied to the field (again with && replaced by the
14728 login name), and if it matches, &%gecos_name%& is expanded and used as the
14729 user's name.
14730
14731 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14732 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14733 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14734 name terminates at the first comma, the following can be used:
14735 .code
14736 gecos_pattern = ([^,]*)
14737 gecos_name = $1
14738 .endd
14739
14740 .option gecos_pattern main string unset
14741 See &%gecos_name%& above.
14742
14743
14744 .option gnutls_compat_mode main boolean unset
14745 This option controls whether GnuTLS is used in compatibility mode in an Exim
14746 server. This reduces security slightly, but improves interworking with older
14747 implementations of TLS.
14748
14749
14750 option gnutls_allow_auto_pkcs11 main boolean unset
14751 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14752 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14753
14754 See
14755 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14756 for documentation.
14757
14758
14759
14760 .option headers_charset main string "see below"
14761 This option sets a default character set for translating from encoded MIME
14762 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14763 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14764 ultimate default is ISO-8859-1. For more details see the description of header
14765 insertions in section &<<SECTexpansionitems>>&.
14766
14767
14768
14769 .option header_maxsize main integer "see below"
14770 .cindex "header section" "maximum size of"
14771 .cindex "limit" "size of message header section"
14772 This option controls the overall maximum size of a message's header
14773 section. The default is the value of HEADER_MAXSIZE in
14774 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14775 sections are rejected.
14776
14777
14778 .option header_line_maxsize main integer 0
14779 .cindex "header lines" "maximum size of"
14780 .cindex "limit" "size of one header line"
14781 This option limits the length of any individual header line in a message, after
14782 all the continuations have been joined together. Messages with individual
14783 header lines that are longer than the limit are rejected. The default value of
14784 zero means &"no limit"&.
14785
14786
14787
14788
14789 .option helo_accept_junk_hosts main "host list&!!" unset
14790 .cindex "HELO" "accepting junk data"
14791 .cindex "EHLO" "accepting junk data"
14792 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14793 mail, and gives an error response for invalid data. Unfortunately, there are
14794 some SMTP clients that send syntactic junk. They can be accommodated by setting
14795 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14796 if you want to do semantic checking.
14797 See also &%helo_allow_chars%& for a way of extending the permitted character
14798 set.
14799
14800
14801 .option helo_allow_chars main string unset
14802 .cindex "HELO" "underscores in"
14803 .cindex "EHLO" "underscores in"
14804 .cindex "underscore in EHLO/HELO"
14805 This option can be set to a string of rogue characters that are permitted in
14806 all EHLO and HELO names in addition to the standard letters, digits,
14807 hyphens, and dots. If you really must allow underscores, you can set
14808 .code
14809 helo_allow_chars = _
14810 .endd
14811 Note that the value is one string, not a list.
14812
14813
14814 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14815 .cindex "HELO" "forcing reverse lookup"
14816 .cindex "EHLO" "forcing reverse lookup"
14817 If the domain given by a client in a HELO or EHLO command matches this
14818 list, a reverse lookup is done in order to establish the host's true name. The
14819 default forces a lookup if the client host gives the server's name or any of
14820 its IP addresses (in brackets), something that broken clients have been seen to
14821 do.
14822
14823
14824 .option helo_try_verify_hosts main "host list&!!" unset
14825 .cindex "HELO verifying" "optional"
14826 .cindex "EHLO" "verifying, optional"
14827 By default, Exim just checks the syntax of HELO and EHLO commands (see
14828 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14829 to do more extensive checking of the data supplied by these commands. The ACL
14830 condition &`verify = helo`& is provided to make this possible.
14831 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14832 to force the check to occur. From release 4.53 onwards, this is no longer
14833 necessary. If the check has not been done before &`verify = helo`& is
14834 encountered, it is done at that time. Consequently, this option is obsolete.
14835 Its specification is retained here for backwards compatibility.
14836
14837 When an EHLO or HELO command is received, if the calling host matches
14838 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14839 EHLO command either:
14840
14841 .ilist
14842 is an IP literal matching the calling address of the host, or
14843 .next
14844 .cindex "DNS" "reverse lookup"
14845 .cindex "reverse DNS lookup"
14846 matches the host name that Exim obtains by doing a reverse lookup of the
14847 calling host address, or
14848 .next
14849 when looked up in DNS yields the calling host address.
14850 .endlist
14851
14852 However, the EHLO or HELO command is not rejected if any of the checks
14853 fail. Processing continues, but the result of the check is remembered, and can
14854 be detected later in an ACL by the &`verify = helo`& condition.
14855
14856 If DNS was used for successful verification, the variable
14857 .cindex "DNS" "DNSSEC"
14858 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14859
14860 .option helo_verify_hosts main "host list&!!" unset
14861 .cindex "HELO verifying" "mandatory"
14862 .cindex "EHLO" "verifying, mandatory"
14863 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14864 backwards compatibility. For hosts that match this option, Exim checks the host
14865 name given in the HELO or EHLO in the same way as for
14866 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14867 rejected with a 550 error, and entries are written to the main and reject logs.
14868 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14869 error.
14870
14871 .option hold_domains main "domain list&!!" unset
14872 .cindex "domain" "delaying delivery"
14873 .cindex "delivery" "delaying certain domains"
14874 This option allows mail for particular domains to be held on the queue
14875 manually. The option is overridden if a message delivery is forced with the
14876 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14877 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14878 item in &%hold_domains%&, no routing or delivery for that address is done, and
14879 it is deferred every time the message is looked at.
14880
14881 This option is intended as a temporary operational measure for delaying the
14882 delivery of mail while some problem is being sorted out, or some new
14883 configuration tested. If you just want to delay the processing of some
14884 domains until a queue run occurs, you should use &%queue_domains%& or
14885 &%queue_smtp_domains%&, not &%hold_domains%&.
14886
14887 A setting of &%hold_domains%& does not override Exim's code for removing
14888 messages from the queue if they have been there longer than the longest retry
14889 time in any retry rule. If you want to hold messages for longer than the normal
14890 retry times, insert a dummy retry rule with a long retry time.
14891
14892
14893 .option host_lookup main "host list&!!" unset
14894 .cindex "host name" "lookup, forcing"
14895 Exim does not look up the name of a calling host from its IP address unless it
14896 is required to compare against some host list, or the host matches
14897 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14898 option (which normally contains IP addresses rather than host names). The
14899 default configuration file contains
14900 .code
14901 host_lookup = *
14902 .endd
14903 which causes a lookup to happen for all hosts. If the expense of these lookups
14904 is felt to be too great, the setting can be changed or removed.
14905
14906 After a successful reverse lookup, Exim does a forward lookup on the name it
14907 has obtained, to verify that it yields the IP address that it started with. If
14908 this check fails, Exim behaves as if the name lookup failed.
14909
14910 .vindex "&$host_lookup_failed$&"
14911 .vindex "&$sender_host_name$&"
14912 After any kind of failure, the host name (in &$sender_host_name$&) remains
14913 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14914 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14915 &`verify = reverse_host_lookup`& in ACLs.
14916
14917
14918 .option host_lookup_order main "string list" &`bydns:byaddr`&
14919 This option specifies the order of different lookup methods when Exim is trying
14920 to find a host name from an IP address. The default is to do a DNS lookup
14921 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14922 if that fails. You can change the order of these lookups, or omit one entirely,
14923 if you want.
14924
14925 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14926 multiple PTR records in the DNS and the IP address is not listed in
14927 &_/etc/hosts_&. Different operating systems give different results in this
14928 case. That is why the default tries a DNS lookup first.
14929
14930
14931
14932 .option host_reject_connection main "host list&!!" unset
14933 .cindex "host" "rejecting connections from"
14934 If this option is set, incoming SMTP calls from the hosts listed are rejected
14935 as soon as the connection is made.
14936 This option is obsolete, and retained only for backward compatibility, because
14937 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14938 connections immediately.
14939
14940 The ability to give an immediate rejection (either by this option or using an
14941 ACL) is provided for use in unusual cases. Many hosts will just try again,
14942 sometimes without much delay. Normally, it is better to use an ACL to reject
14943 incoming messages at a later stage, such as after RCPT commands. See
14944 chapter &<<CHAPACL>>&.
14945
14946
14947 .option hosts_connection_nolog main "host list&!!" unset
14948 .cindex "host" "not logging connections from"
14949 This option defines a list of hosts for which connection logging does not
14950 happen, even though the &%smtp_connection%& log selector is set. For example,
14951 you might want not to log SMTP connections from local processes, or from
14952 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14953 the daemon; you should therefore strive to restrict its value to a short inline
14954 list of IP addresses and networks. To disable logging SMTP connections from
14955 local processes, you must create a host list with an empty item. For example:
14956 .code
14957 hosts_connection_nolog = :
14958 .endd
14959 If the &%smtp_connection%& log selector is not set, this option has no effect.
14960
14961
14962
14963 .new
14964 .option hosts_proxy main "host list&!!" unset
14965 .cindex proxy "proxy protocol"
14966 This option enables use of Proxy Protocol proxies for incoming
14967 connections.  For details see &<<SECTproxyInbound>>&.
14968 .wen
14969
14970
14971 .option hosts_treat_as_local main "domain list&!!" unset
14972 .cindex "local host" "domains treated as"
14973 .cindex "host" "treated as local"
14974 If this option is set, any host names that match the domain list are treated as
14975 if they were the local host when Exim is scanning host lists obtained from MX
14976 records
14977 or other sources. Note that the value of this option is a domain list, not a
14978 host list, because it is always used to check host names, not IP addresses.
14979
14980 This option also applies when Exim is matching the special items
14981 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14982 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14983 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14984 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14985 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14986 interfaces and recognizing the local host.
14987
14988
14989 .option ibase_servers main "string list" unset
14990 .cindex "InterBase" "server list"
14991 This option provides a list of InterBase servers and associated connection data,
14992 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14993 The option is available only if Exim has been built with InterBase support.
14994
14995
14996
14997 .option ignore_bounce_errors_after main time 10w
14998 .cindex "bounce message" "discarding"
14999 .cindex "discarding bounce message"
15000 This option affects the processing of bounce messages that cannot be delivered,
15001 that is, those that suffer a permanent delivery failure. (Bounce messages that
15002 suffer temporary delivery failures are of course retried in the usual way.)
15003
15004 After a permanent delivery failure, bounce messages are frozen,
15005 because there is no sender to whom they can be returned. When a frozen bounce
15006 message has been on the queue for more than the given time, it is unfrozen at
15007 the next queue run, and a further delivery is attempted. If delivery fails
15008 again, the bounce message is discarded. This makes it possible to keep failed
15009 bounce messages around for a shorter time than the normal maximum retry time
15010 for frozen messages. For example,
15011 .code
15012 ignore_bounce_errors_after = 12h
15013 .endd
15014 retries failed bounce message deliveries after 12 hours, discarding any further
15015 failures. If the value of this option is set to a zero time period, bounce
15016 failures are discarded immediately. Setting a very long time (as in the default
15017 value) has the effect of disabling this option. For ways of automatically
15018 dealing with other kinds of frozen message, see &%auto_thaw%& and
15019 &%timeout_frozen_after%&.
15020
15021
15022 .option ignore_fromline_hosts main "host list&!!" unset
15023 .cindex "&""From""& line"
15024 .cindex "UUCP" "&""From""& line"
15025 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15026 the headers of a message. By default this is treated as the start of the
15027 message's body, which means that any following headers are not recognized as
15028 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15029 match those hosts that insist on sending it. If the sender is actually a local
15030 process rather than a remote host, and is using &%-bs%& to inject the messages,
15031 &%ignore_fromline_local%& must be set to achieve this effect.
15032
15033
15034 .option ignore_fromline_local main boolean false
15035 See &%ignore_fromline_hosts%& above.
15036
15037
15038 .option keep_malformed main time 4d
15039 This option specifies the length of time to keep messages whose spool files
15040 have been corrupted in some way. This should, of course, never happen. At the
15041 next attempt to deliver such a message, it gets removed. The incident is
15042 logged.
15043
15044
15045 .option ldap_ca_cert_dir main string unset
15046 .cindex "LDAP", "TLS CA certificate directory"
15047 .cindex certificate "directory for LDAP"
15048 This option indicates which directory contains CA certificates for verifying
15049 a TLS certificate presented by an LDAP server.
15050 While Exim does not provide a default value, your SSL library may.
15051 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15052 and constrained to be a directory.
15053
15054
15055 .option ldap_ca_cert_file main string unset
15056 .cindex "LDAP", "TLS CA certificate file"
15057 .cindex certificate "file for LDAP"
15058 This option indicates which file contains CA certificates for verifying
15059 a TLS certificate presented by an LDAP server.
15060 While Exim does not provide a default value, your SSL library may.
15061 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15062 and constrained to be a file.
15063
15064
15065 .option ldap_cert_file main string unset
15066 .cindex "LDAP" "TLS client certificate file"
15067 .cindex certificate "file for LDAP"
15068 This option indicates which file contains an TLS client certificate which
15069 Exim should present to the LDAP server during TLS negotiation.
15070 Should be used together with &%ldap_cert_key%&.
15071
15072
15073 .option ldap_cert_key main string unset
15074 .cindex "LDAP" "TLS client key file"
15075 .cindex certificate "key for LDAP"
15076 This option indicates which file contains the secret/private key to use
15077 to prove identity to the LDAP server during TLS negotiation.
15078 Should be used together with &%ldap_cert_file%&, which contains the
15079 identity to be proven.
15080
15081
15082 .option ldap_cipher_suite main string unset
15083 .cindex "LDAP" "TLS cipher suite"
15084 This controls the TLS cipher-suite negotiation during TLS negotiation with
15085 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15086 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15087
15088
15089 .option ldap_default_servers main "string list" unset
15090 .cindex "LDAP" "default servers"
15091 This option provides a list of LDAP servers which are tried in turn when an
15092 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15093 details of LDAP queries. This option is available only when Exim has been built
15094 with LDAP support.
15095
15096
15097 .option ldap_require_cert main string unset.
15098 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15099 This should be one of the values "hard", "demand", "allow", "try" or "never".
15100 A value other than one of these is interpreted as "never".
15101 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15102 Although Exim does not set a default, the LDAP library probably defaults
15103 to hard/demand.
15104
15105
15106 .option ldap_start_tls main boolean false
15107 .cindex "LDAP" "whether or not to negotiate TLS"
15108 If set, Exim will attempt to negotiate TLS with the LDAP server when
15109 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15110 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15111 of SSL-on-connect.
15112 In the event of failure to negotiate TLS, the action taken is controlled
15113 by &%ldap_require_cert%&.
15114
15115
15116 .option ldap_version main integer unset
15117 .cindex "LDAP" "protocol version, forcing"
15118 This option can be used to force Exim to set a specific protocol version for
15119 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15120 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15121 the LDAP headers; otherwise it is 2. This option is available only when Exim
15122 has been built with LDAP support.
15123
15124
15125
15126 .option local_from_check main boolean true
15127 .cindex "&'Sender:'& header line" "disabling addition of"
15128 .cindex "&'From:'& header line" "disabling checking of"
15129 When a message is submitted locally (that is, not over a TCP/IP connection) by
15130 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15131 checks that the &'From:'& header line matches the login of the calling user and
15132 the domain specified by &%qualify_domain%&.
15133
15134 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15135 locally submitted message is automatically qualified by Exim, unless the
15136 &%-bnq%& command line option is used.
15137
15138 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15139 on the local part. If the &'From:'& header line does not match, Exim adds a
15140 &'Sender:'& header with an address constructed from the calling user's login
15141 and the default qualify domain.
15142
15143 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15144 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15145 &'Sender:'& header lines supplied by untrusted users, you must also set
15146 &%local_sender_retain%& to be true.
15147
15148 .cindex "envelope sender"
15149 These options affect only the header lines in the message. The envelope sender
15150 is still forced to be the login id at the qualify domain unless
15151 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15152
15153 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15154 request similar header line checking. See section &<<SECTthesenhea>>&, which
15155 has more details about &'Sender:'& processing.
15156
15157
15158
15159
15160 .option local_from_prefix main string unset
15161 When Exim checks the &'From:'& header line of locally submitted messages for
15162 matching the login id (see &%local_from_check%& above), it can be configured to
15163 ignore certain prefixes and suffixes in the local part of the address. This is
15164 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15165 appropriate lists, in the same form as the &%local_part_prefix%& and
15166 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15167 example, if
15168 .code
15169 local_from_prefix = *-
15170 .endd
15171 is set, a &'From:'& line containing
15172 .code
15173 From: anything-user@your.domain.example
15174 .endd
15175 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15176 matches the actual sender address that is constructed from the login name and
15177 qualify domain.
15178
15179
15180 .option local_from_suffix main string unset
15181 See &%local_from_prefix%& above.
15182
15183
15184 .option local_interfaces main "string list" "see below"
15185 This option controls which network interfaces are used by the daemon for
15186 listening; they are also used to identify the local host when routing. Chapter
15187 &<<CHAPinterfaces>>& contains a full description of this option and the related
15188 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15189 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15190 &%local_interfaces%& is
15191 .code
15192 local_interfaces = 0.0.0.0
15193 .endd
15194 when Exim is built without IPv6 support; otherwise it is
15195 .code
15196 local_interfaces = <; ::0 ; 0.0.0.0
15197 .endd
15198
15199 .option local_scan_timeout main time 5m
15200 .cindex "timeout" "for &[local_scan()]& function"
15201 .cindex "&[local_scan()]& function" "timeout"
15202 This timeout applies to the &[local_scan()]& function (see chapter
15203 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15204 the incoming message is rejected with a temporary error if it is an SMTP
15205 message. For a non-SMTP message, the message is dropped and Exim ends with a
15206 non-zero code. The incident is logged on the main and reject logs.
15207
15208
15209
15210 .option local_sender_retain main boolean false
15211 .cindex "&'Sender:'& header line" "retaining from local submission"
15212 When a message is submitted locally (that is, not over a TCP/IP connection) by
15213 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15214 do not want this to happen, you must set &%local_sender_retain%&, and you must
15215 also set &%local_from_check%& to be false (Exim will complain if you do not).
15216 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15217 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15218
15219
15220
15221
15222 .option localhost_number main string&!! unset
15223 .cindex "host" "locally unique number for"
15224 .cindex "message ids" "with multiple hosts"
15225 .vindex "&$localhost_number$&"
15226 Exim's message ids are normally unique only within the local host. If
15227 uniqueness among a set of hosts is required, each host must set a different
15228 value for the &%localhost_number%& option. The string is expanded immediately
15229 after reading the configuration file (so that a number can be computed from the
15230 host name, for example) and the result of the expansion must be a number in the
15231 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15232 systems). This is available in subsequent string expansions via the variable
15233 &$localhost_number$&. When &%localhost_number is set%&, the final two
15234 characters of the message id, instead of just being a fractional part of the
15235 time, are computed from the time and the local host number as described in
15236 section &<<SECTmessiden>>&.
15237
15238
15239
15240 .option log_file_path main "string list&!!" "set at compile time"
15241 .cindex "log" "file path for"
15242 This option sets the path which is used to determine the names of Exim's log
15243 files, or indicates that logging is to be to syslog, or both. It is expanded
15244 when Exim is entered, so it can, for example, contain a reference to the host
15245 name. If no specific path is set for the log files at compile or run time,
15246 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15247 they are written in a sub-directory called &_log_& in Exim's spool directory.
15248 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15249 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15250 used. If this string is fixed at your installation (contains no expansion
15251 variables) it is recommended that you do not set this option in the
15252 configuration file, but instead supply the path using LOG_FILE_PATH in
15253 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15254 early on &-- in particular, failure to read the configuration file.
15255
15256
15257 .option log_selector main string unset
15258 .cindex "log" "selectors"
15259 This option can be used to reduce or increase the number of things that Exim
15260 writes to its log files. Its argument is made up of names preceded by plus or
15261 minus characters. For example:
15262 .code
15263 log_selector = +arguments -retry_defer
15264 .endd
15265 A list of possible names and what they control is given in the chapter on
15266 logging, in section &<<SECTlogselector>>&.
15267
15268
15269 .option log_timezone main boolean false
15270 .cindex "log" "timezone for entries"
15271 .vindex "&$tod_log$&"
15272 .vindex "&$tod_zone$&"
15273 By default, the timestamps on log lines are in local time without the
15274 timezone. This means that if your timezone changes twice a year, the timestamps
15275 in log lines are ambiguous for an hour when the clocks go back. One way of
15276 avoiding this problem is to set the timezone to UTC. An alternative is to set
15277 &%log_timezone%& true. This turns on the addition of the timezone offset to
15278 timestamps in log lines. Turning on this option can add quite a lot to the size
15279 of log files because each line is extended by 6 characters. Note that the
15280 &$tod_log$& variable contains the log timestamp without the zone, but there is
15281 another variable called &$tod_zone$& that contains just the timezone offset.
15282
15283
15284 .option lookup_open_max main integer 25
15285 .cindex "too many open files"
15286 .cindex "open files, too many"
15287 .cindex "file" "too many open"
15288 .cindex "lookup" "maximum open files"
15289 .cindex "limit" "open files for lookups"
15290 This option limits the number of simultaneously open files for single-key
15291 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15292 Exim normally keeps these files open during routing, because often the same
15293 file is required several times. If the limit is reached, Exim closes the least
15294 recently used file. Note that if you are using the &'ndbm'& library, it
15295 actually opens two files for each logical DBM database, though it still counts
15296 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15297 open files"& errors with NDBM, you need to reduce the value of
15298 &%lookup_open_max%&.
15299
15300
15301 .option max_username_length main integer 0
15302 .cindex "length of login name"
15303 .cindex "user name" "maximum length"
15304 .cindex "limit" "user name length"
15305 Some operating systems are broken in that they truncate long arguments to
15306 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15307 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15308 an argument that is longer behaves as if &[getpwnam()]& failed.
15309
15310
15311 .option message_body_newlines main bool false
15312 .cindex "message body" "newlines in variables"
15313 .cindex "newline" "in message body variables"
15314 .vindex "&$message_body$&"
15315 .vindex "&$message_body_end$&"
15316 By default, newlines in the message body are replaced by spaces when setting
15317 the &$message_body$& and &$message_body_end$& expansion variables. If this
15318 option is set true, this no longer happens.
15319
15320
15321 .option message_body_visible main integer 500
15322 .cindex "body of message" "visible size"
15323 .cindex "message body" "visible size"
15324 .vindex "&$message_body$&"
15325 .vindex "&$message_body_end$&"
15326 This option specifies how much of a message's body is to be included in the
15327 &$message_body$& and &$message_body_end$& expansion variables.
15328
15329
15330 .option message_id_header_domain main string&!! unset
15331 .cindex "&'Message-ID:'& header line"
15332 If this option is set, the string is expanded and used as the right hand side
15333 (domain) of the &'Message-ID:'& header that Exim creates if a
15334 locally-originated incoming message does not have one. &"Locally-originated"&
15335 means &"not received over TCP/IP."&
15336 Otherwise, the primary host name is used.
15337 Only letters, digits, dot and hyphen are accepted; any other characters are
15338 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15339 empty string, the option is ignored.
15340
15341
15342 .option message_id_header_text main string&!! unset
15343 If this variable is set, the string is expanded and used to augment the text of
15344 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15345 message does not have one. The text of this header is required by RFC 2822 to
15346 take the form of an address. By default, Exim uses its internal message id as
15347 the local part, and the primary host name as the domain. If this option is set,
15348 it is expanded, and provided the expansion is not forced to fail, and does not
15349 yield an empty string, the result is inserted into the header immediately
15350 before the @, separated from the internal message id by a dot. Any characters
15351 that are illegal in an address are automatically converted into hyphens. This
15352 means that variables such as &$tod_log$& can be used, because the spaces and
15353 colons will become hyphens.
15354
15355
15356 .option message_logs main boolean true
15357 .cindex "message logs" "disabling"
15358 .cindex "log" "message log; disabling"
15359 If this option is turned off, per-message log files are not created in the
15360 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15361 Exim, by reducing the number of files involved in handling a message from a
15362 minimum of four (header spool file, body spool file, delivery journal, and
15363 per-message log) to three. The other major I/O activity is Exim's main log,
15364 which is not affected by this option.
15365
15366
15367 .option message_size_limit main string&!! 50M
15368 .cindex "message" "size limit"
15369 .cindex "limit" "message size"
15370 .cindex "size" "of message, limit"
15371 This option limits the maximum size of message that Exim will process. The
15372 value is expanded for each incoming connection so, for example, it can be made
15373 to depend on the IP address of the remote host for messages arriving via
15374 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15375 optionally followed by K or M.
15376
15377 &*Note*&: This limit cannot be made to depend on a message's sender or any
15378 other properties of an individual message, because it has to be advertised in
15379 the server's response to EHLO. String expansion failure causes a temporary
15380 error. A value of zero means no limit, but its use is not recommended. See also
15381 &%bounce_return_size_limit%&.
15382
15383 Incoming SMTP messages are failed with a 552 error if the limit is
15384 exceeded; locally-generated messages either get a stderr message or a delivery
15385 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15386 an oversized message is logged in both the main and the reject logs. See also
15387 the generic transport option &%message_size_limit%&, which limits the size of
15388 message that an individual transport can process.
15389
15390 If you use a virus-scanner and set this option to to a value larger than the
15391 maximum size that your virus-scanner is configured to support, you may get
15392 failures triggered by large mails.  The right size to configure for the
15393 virus-scanner depends upon what data is passed and the options in use but it's
15394 probably safest to just set it to a little larger than this value.  E.g., with a
15395 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15396 some problems may result.
15397
15398 A value of 0 will disable size limit checking; Exim will still advertise the
15399 SIZE extension in an EHLO response, but without a limit, so as to permit
15400 SMTP clients to still indicate the message size along with the MAIL verb.
15401
15402
15403 .option move_frozen_messages main boolean false
15404 .cindex "frozen messages" "moving"
15405 This option, which is available only if Exim has been built with the setting
15406 .code
15407 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15408 .endd
15409 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15410 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15411 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15412 standard utilities for handling such moved messages, and they do not show up in
15413 lists generated by &%-bp%& or by the Exim monitor.
15414
15415
15416 .option mua_wrapper main boolean false
15417 Setting this option true causes Exim to run in a very restrictive mode in which
15418 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15419 contains a full description of this facility.
15420
15421
15422
15423 .option mysql_servers main "string list" unset
15424 .cindex "MySQL" "server list"
15425 This option provides a list of MySQL servers and associated connection data, to
15426 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15427 option is available only if Exim has been built with MySQL support.
15428
15429
15430 .option never_users main "string list&!!" unset
15431 This option is expanded just once, at the start of Exim's processing. Local
15432 message deliveries are normally run in processes that are setuid to the
15433 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15434 It is usually desirable to prevent any deliveries from running as root, as a
15435 safety precaution.
15436
15437 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15438 list of users that must not be used for local deliveries. This list is fixed in
15439 the binary and cannot be overridden by the configuration file. By default, it
15440 contains just the single user name &"root"&. The &%never_users%& runtime option
15441 can be used to add more users to the fixed list.
15442
15443 If a message is to be delivered as one of the users on the fixed list or the
15444 &%never_users%& list, an error occurs, and delivery is deferred. A common
15445 example is
15446 .code
15447 never_users = root:daemon:bin
15448 .endd
15449 Including root is redundant if it is also on the fixed list, but it does no
15450 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15451 transport driver.
15452
15453
15454 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15455 .cindex "OpenSSL "compatibility options"
15456 This option allows an administrator to adjust the SSL options applied
15457 by OpenSSL to connections.  It is given as a space-separated list of items,
15458 each one to be +added or -subtracted from the current value.
15459
15460 This option is only available if Exim is built against OpenSSL.  The values
15461 available for this option vary according to the age of your OpenSSL install.
15462 The &"all"& value controls a subset of flags which are available, typically
15463 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15464 list the values known on your system and Exim should support all the
15465 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15466 names lose the leading &"SSL_OP_"& and are lower-cased.
15467
15468 Note that adjusting the options can have severe impact upon the security of
15469 SSL as used by Exim.  It is possible to disable safety checks and shoot
15470 yourself in the foot in various unpleasant ways.  This option should not be
15471 adjusted lightly.  An unrecognised item will be detected at startup, by
15472 invoking Exim with the &%-bV%& flag.
15473
15474 The option affects Exim operating both as a server and as a client.
15475
15476 Historical note: prior to release 4.80, Exim defaulted this value to
15477 "+dont_insert_empty_fragments", which may still be needed for compatibility
15478 with some clients, but which lowers security by increasing exposure to
15479 some now infamous attacks.
15480
15481 Examples:
15482 .code
15483 # Make both old MS and old Eudora happy:
15484 openssl_options = -all +microsoft_big_sslv3_buffer \
15485                        +dont_insert_empty_fragments
15486
15487 # Disable older protocol versions:
15488 openssl_options = +no_sslv2 +no_sslv3
15489 .endd
15490
15491 Possible options may include:
15492 .ilist
15493 &`all`&
15494 .next
15495 &`allow_unsafe_legacy_renegotiation`&
15496 .next
15497 &`cipher_server_preference`&
15498 .next
15499 &`dont_insert_empty_fragments`&
15500 .next
15501 &`ephemeral_rsa`&
15502 .next
15503 &`legacy_server_connect`&
15504 .next
15505 &`microsoft_big_sslv3_buffer`&
15506 .next
15507 &`microsoft_sess_id_bug`&
15508 .next
15509 &`msie_sslv2_rsa_padding`&
15510 .next
15511 &`netscape_challenge_bug`&
15512 .next
15513 &`netscape_reuse_cipher_change_bug`&
15514 .next
15515 &`no_compression`&
15516 .next
15517 &`no_session_resumption_on_renegotiation`&
15518 .next
15519 &`no_sslv2`&
15520 .next
15521 &`no_sslv3`&
15522 .next
15523 &`no_ticket`&
15524 .next
15525 &`no_tlsv1`&
15526 .next
15527 &`no_tlsv1_1`&
15528 .next
15529 &`no_tlsv1_2`&
15530 .next
15531 &`safari_ecdhe_ecdsa_bug`&
15532 .next
15533 &`single_dh_use`&
15534 .next
15535 &`single_ecdh_use`&
15536 .next
15537 &`ssleay_080_client_dh_bug`&
15538 .next
15539 &`sslref2_reuse_cert_type_bug`&
15540 .next
15541 &`tls_block_padding_bug`&
15542 .next
15543 &`tls_d5_bug`&
15544 .next
15545 &`tls_rollback_bug`&
15546 .endlist
15547
15548 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15549 all clients connecting using the MacOS SecureTransport TLS facility prior
15550 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15551 to negotiate TLS then this option value might help, provided that your OpenSSL
15552 release is new enough to contain this work-around.  This may be a situation
15553 where you have to upgrade OpenSSL to get buggy clients working.
15554
15555
15556 .option oracle_servers main "string list" unset
15557 .cindex "Oracle" "server list"
15558 This option provides a list of Oracle servers and associated connection data,
15559 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15560 The option is available only if Exim has been built with Oracle support.
15561
15562
15563 .option percent_hack_domains main "domain list&!!" unset
15564 .cindex "&""percent hack""&"
15565 .cindex "source routing" "in email address"
15566 .cindex "address" "source-routed"
15567 The &"percent hack"& is the convention whereby a local part containing a
15568 percent sign is re-interpreted as a new email address, with the percent
15569 replaced by @. This is sometimes called &"source routing"&, though that term is
15570 also applied to RFC 2822 addresses that begin with an @ character. If this
15571 option is set, Exim implements the percent facility for those domains listed,
15572 but no others. This happens before an incoming SMTP address is tested against
15573 an ACL.
15574
15575 &*Warning*&: The &"percent hack"& has often been abused by people who are
15576 trying to get round relaying restrictions. For this reason, it is best avoided
15577 if at all possible. Unfortunately, a number of less security-conscious MTAs
15578 implement it unconditionally. If you are running Exim on a gateway host, and
15579 routing mail through to internal MTAs without processing the local parts, it is
15580 a good idea to reject recipient addresses with percent characters in their
15581 local parts. Exim's default configuration does this.
15582
15583
15584 .option perl_at_start main boolean false
15585 This option is available only when Exim is built with an embedded Perl
15586 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15587
15588
15589 .option perl_startup main string unset
15590 This option is available only when Exim is built with an embedded Perl
15591 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15592
15593
15594 .option pgsql_servers main "string list" unset
15595 .cindex "PostgreSQL lookup type" "server list"
15596 This option provides a list of PostgreSQL servers and associated connection
15597 data, to be used in conjunction with &(pgsql)& lookups (see section
15598 &<<SECID72>>&). The option is available only if Exim has been built with
15599 PostgreSQL support.
15600
15601
15602 .option pid_file_path main string&!! "set at compile time"
15603 .cindex "daemon" "pid file path"
15604 .cindex "pid file, path for"
15605 This option sets the name of the file to which the Exim daemon writes its
15606 process id. The string is expanded, so it can contain, for example, references
15607 to the host name:
15608 .code
15609 pid_file_path = /var/log/$primary_hostname/exim.pid
15610 .endd
15611 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15612 spool directory.
15613 The value set by the option can be overridden by the &%-oP%& command line
15614 option. A pid file is not written if a &"non-standard"& daemon is run by means
15615 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15616
15617
15618 .option pipelining_advertise_hosts main "host list&!!" *
15619 .cindex "PIPELINING" "suppressing advertising"
15620 This option can be used to suppress the advertisement of the SMTP
15621 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15622 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15623 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15624 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15625 that clients will use it; &"out of order"& commands that are &"expected"& do
15626 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15627
15628
15629 .option prdr_enable main boolean false
15630 .cindex "PRDR" "enabling on server"
15631 This option can be used to enable the Per-Recipient Data Response extension
15632 to SMTP, defined by Eric Hall.
15633 If the option is set, PRDR is advertised by Exim when operating as a server.
15634 If the client requests PRDR, and more than one recipient, for a message
15635 an additional ACL is called for each recipient after the message content
15636 is received.  See section &<<SECTPRDRACL>>&.
15637
15638 .option preserve_message_logs main boolean false
15639 .cindex "message logs" "preserving"
15640 If this option is set, message log files are not deleted when messages are
15641 completed. Instead, they are moved to a sub-directory of the spool directory
15642 called &_msglog.OLD_&, where they remain available for statistical or debugging
15643 purposes. This is a dangerous option to set on systems with any appreciable
15644 volume of mail. Use with care!
15645
15646
15647 .option primary_hostname main string "see below"
15648 .cindex "name" "of local host"
15649 .cindex "host" "name of local"
15650 .cindex "local host" "name of"
15651 .vindex "&$primary_hostname$&"
15652 This specifies the name of the current host. It is used in the default EHLO or
15653 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15654 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15655 The value is also used by default in some SMTP response messages from an Exim
15656 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15657
15658 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15659 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15660 contains only one component, Exim passes it to &[gethostbyname()]& (or
15661 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15662 version. The variable &$primary_hostname$& contains the host name, whether set
15663 explicitly by this option, or defaulted.
15664
15665
15666 .option print_topbitchars main boolean false
15667 .cindex "printing characters"
15668 .cindex "8-bit characters"
15669 By default, Exim considers only those characters whose codes lie in the range
15670 32&--126 to be printing characters. In a number of circumstances (for example,
15671 when writing log entries) non-printing characters are converted into escape
15672 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15673 is set, code values of 128 and above are also considered to be printing
15674 characters.
15675
15676 This option also affects the header syntax checks performed by the
15677 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15678 the user's full name when constructing From: and Sender: addresses (as
15679 described in section &<<SECTconstr>>&). Setting this option can cause
15680 Exim to generate eight bit message headers that do not conform to the
15681 standards.
15682
15683
15684 .option process_log_path main string unset
15685 .cindex "process log path"
15686 .cindex "log" "process log"
15687 .cindex "&'exiwhat'&"
15688 This option sets the name of the file to which an Exim process writes its
15689 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15690 utility script. If this option is unset, the file called &_exim-process.info_&
15691 in Exim's spool directory is used. The ability to specify the name explicitly
15692 can be useful in environments where two different Exims are running, using
15693 different spool directories.
15694
15695
15696 .option prod_requires_admin main boolean true
15697 .oindex "&%-M%&"
15698 .oindex "&%-R%&"
15699 .oindex "&%-q%&"
15700 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15701 admin user unless &%prod_requires_admin%& is set false. See also
15702 &%queue_list_requires_admin%&.
15703
15704
15705 .option qualify_domain main string "see below"
15706 .cindex "domain" "for qualifying addresses"
15707 .cindex "address" "qualification"
15708 This option specifies the domain name that is added to any envelope sender
15709 addresses that do not have a domain qualification. It also applies to
15710 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15711 are accepted by default only for locally-generated messages. Qualification is
15712 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15713 locally-generated messages, unless the &%-bnq%& command line option is used.
15714
15715 Messages from external sources must always contain fully qualified addresses,
15716 unless the sending host matches &%sender_unqualified_hosts%& or
15717 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15718 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15719 necessary. Internally, Exim always works with fully qualified envelope
15720 addresses. If &%qualify_domain%& is not set, it defaults to the
15721 &%primary_hostname%& value.
15722
15723
15724 .option qualify_recipient main string "see below"
15725 This option allows you to specify a different domain for qualifying recipient
15726 addresses to the one that is used for senders. See &%qualify_domain%& above.
15727
15728
15729
15730 .option queue_domains main "domain list&!!" unset
15731 .cindex "domain" "specifying non-immediate delivery"
15732 .cindex "queueing incoming messages"
15733 .cindex "message" "queueing certain domains"
15734 This option lists domains for which immediate delivery is not required.
15735 A delivery process is started whenever a message is received, but only those
15736 domains that do not match are processed. All other deliveries wait until the
15737 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15738
15739
15740 .option queue_list_requires_admin main boolean true
15741 .oindex "&%-bp%&"
15742 The &%-bp%& command-line option, which lists the messages that are on the
15743 queue, requires the caller to be an admin user unless
15744 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15745
15746
15747 .option queue_only main boolean false
15748 .cindex "queueing incoming messages"
15749 .cindex "message" "queueing unconditionally"
15750 If &%queue_only%& is set, a delivery process is not automatically started
15751 whenever a message is received. Instead, the message waits on the queue for the
15752 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15753 delivered immediately when certain conditions (such as heavy load) occur.
15754
15755 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15756 and &%-odi%& command line options override &%queue_only%& unless
15757 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15758 &%queue_only_load%&, and &%smtp_accept_queue%&.
15759
15760
15761 .option queue_only_file main string unset
15762 .cindex "queueing incoming messages"
15763 .cindex "message" "queueing by file existence"
15764 This option can be set to a colon-separated list of absolute path names, each
15765 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15766 it tests for the existence of each listed path using a call to &[stat()]&. For
15767 each path that exists, the corresponding queueing option is set.
15768 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15769 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15770 .code
15771 queue_only_file = smtp/some/file
15772 .endd
15773 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15774 &_/some/file_& exists.
15775
15776
15777 .option queue_only_load main fixed-point unset
15778 .cindex "load average"
15779 .cindex "queueing incoming messages"
15780 .cindex "message" "queueing by load"
15781 If the system load average is higher than this value, incoming messages from
15782 all sources are queued, and no automatic deliveries are started. If this
15783 happens during local or remote SMTP input, all subsequent messages received on
15784 the same SMTP connection are queued by default, whatever happens to the load in
15785 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15786 false.
15787
15788 Deliveries will subsequently be performed by queue runner processes. This
15789 option has no effect on ancient operating systems on which Exim cannot
15790 determine the load average. See also &%deliver_queue_load_max%& and
15791 &%smtp_load_reserve%&.
15792
15793
15794 .option queue_only_load_latch main boolean true
15795 .cindex "load average" "re-evaluating per message"
15796 When this option is true (the default), once one message has been queued
15797 because the load average is higher than the value set by &%queue_only_load%&,
15798 all subsequent messages received on the same SMTP connection are also queued.
15799 This is a deliberate choice; even though the load average may fall below the
15800 threshold, it doesn't seem right to deliver later messages on the same
15801 connection when not delivering earlier ones. However, there are special
15802 circumstances such as very long-lived connections from scanning appliances
15803 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15804 should be set false. This causes the value of the load average to be
15805 re-evaluated for each message.
15806
15807
15808 .option queue_only_override main boolean true
15809 .cindex "queueing incoming messages"
15810 When this option is true, the &%-od%&&'x'& command line options override the
15811 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15812 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15813 to override; they are accepted, but ignored.
15814
15815
15816 .option queue_run_in_order main boolean false
15817 .cindex "queue runner" "processing messages in order"
15818 If this option is set, queue runs happen in order of message arrival instead of
15819 in an arbitrary order. For this to happen, a complete list of the entire queue
15820 must be set up before the deliveries start. When the queue is all held in a
15821 single directory (the default), a single list is created for both the ordered
15822 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15823 single list is not created when &%queue_run_in_order%& is false. In this case,
15824 the sub-directories are processed one at a time (in a random order), and this
15825 avoids setting up one huge list for the whole queue. Thus, setting
15826 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15827 when the queue is large, because of the extra work in setting up the single,
15828 large list. In most situations, &%queue_run_in_order%& should not be set.
15829
15830
15831
15832 .option queue_run_max main integer 5
15833 .cindex "queue runner" "maximum number of"
15834 This controls the maximum number of queue runner processes that an Exim daemon
15835 can run simultaneously. This does not mean that it starts them all at once,
15836 but rather that if the maximum number are still running when the time comes to
15837 start another one, it refrains from starting another one. This can happen with
15838 very large queues and/or very sluggish deliveries. This option does not,
15839 however, interlock with other processes, so additional queue runners can be
15840 started by other means, or by killing and restarting the daemon.
15841
15842 Setting this option to zero does not suppress queue runs; rather, it disables
15843 the limit, allowing any number of simultaneous queue runner processes to be
15844 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15845 the daemon's command line.
15846
15847 .option queue_smtp_domains main "domain list&!!" unset
15848 .cindex "queueing incoming messages"
15849 .cindex "message" "queueing remote deliveries"
15850 When this option is set, a delivery process is started whenever a message is
15851 received, routing is performed, and local deliveries take place.
15852 However, if any SMTP deliveries are required for domains that match
15853 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15854 message waits on the queue for the next queue run. Since routing of the message
15855 has taken place, Exim knows to which remote hosts it must be delivered, and so
15856 when the queue run happens, multiple messages for the same host are delivered
15857 over a single SMTP connection. The &%-odqs%& command line option causes all
15858 SMTP deliveries to be queued in this way, and is equivalent to setting
15859 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15860 &%queue_domains%&.
15861
15862
15863 .option receive_timeout main time 0s
15864 .cindex "timeout" "for non-SMTP input"
15865 This option sets the timeout for accepting a non-SMTP message, that is, the
15866 maximum time that Exim waits when reading a message on the standard input. If
15867 the value is zero, it will wait for ever. This setting is overridden by the
15868 &%-or%& command line option. The timeout for incoming SMTP messages is
15869 controlled by &%smtp_receive_timeout%&.
15870
15871 .option received_header_text main string&!! "see below"
15872 .cindex "customizing" "&'Received:'& header"
15873 .cindex "&'Received:'& header line" "customizing"
15874 This string defines the contents of the &'Received:'& message header that is
15875 added to each message, except for the timestamp, which is automatically added
15876 on at the end (preceded by a semicolon). The string is expanded each time it is
15877 used. If the expansion yields an empty string, no &'Received:'& header line is
15878 added to the message. Otherwise, the string should start with the text
15879 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15880 header lines. The default setting is:
15881
15882 .code
15883 received_header_text = Received: \
15884   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15885   {${if def:sender_ident \
15886   {from ${quote_local_part:$sender_ident} }}\
15887   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15888   by $primary_hostname \
15889   ${if def:received_protocol {with $received_protocol}} \
15890   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15891   (Exim $version_number)\n\t\
15892   ${if def:sender_address \
15893   {(envelope-from <$sender_address>)\n\t}}\
15894   id $message_exim_id\
15895   ${if def:received_for {\n\tfor $received_for}}
15896 .endd
15897
15898 The reference to the TLS cipher is omitted when Exim is built without TLS
15899 support. The use of conditional expansions ensures that this works for both
15900 locally generated messages and messages received from remote hosts, giving
15901 header lines such as the following:
15902 .code
15903 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15904 by marley.carol.example with esmtp (Exim 4.00)
15905 (envelope-from <bob@carol.example>)
15906 id 16IOWa-00019l-00
15907 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15908 Received: by scrooge.carol.example with local (Exim 4.00)
15909 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15910 .endd
15911 Until the body of the message has been received, the timestamp is the time when
15912 the message started to be received. Once the body has arrived, and all policy
15913 checks have taken place, the timestamp is updated to the time at which the
15914 message was accepted.
15915
15916
15917 .option received_headers_max main integer 30
15918 .cindex "loop" "prevention"
15919 .cindex "mail loop prevention"
15920 .cindex "&'Received:'& header line" "counting"
15921 When a message is to be delivered, the number of &'Received:'& headers is
15922 counted, and if it is greater than this parameter, a mail loop is assumed to
15923 have occurred, the delivery is abandoned, and an error message is generated.
15924 This applies to both local and remote deliveries.
15925
15926
15927 .option recipient_unqualified_hosts main "host list&!!" unset
15928 .cindex "unqualified addresses"
15929 .cindex "host" "unqualified addresses from"
15930 This option lists those hosts from which Exim is prepared to accept unqualified
15931 recipient addresses in message envelopes. The addresses are made fully
15932 qualified by the addition of the &%qualify_recipient%& value. This option also
15933 affects message header lines. Exim does not reject unqualified recipient
15934 addresses in headers, but it qualifies them only if the message came from a
15935 host that matches &%recipient_unqualified_hosts%&,
15936 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15937 option was not set.
15938
15939
15940 .option recipients_max main integer 0
15941 .cindex "limit" "number of recipients"
15942 .cindex "recipient" "maximum number"
15943 If this option is set greater than zero, it specifies the maximum number of
15944 original recipients for any message. Additional recipients that are generated
15945 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15946 all recipients over the limit; earlier recipients are delivered as normal.
15947 Non-SMTP messages with too many recipients are failed, and no deliveries are
15948 done.
15949
15950 .cindex "RCPT" "maximum number of incoming"
15951 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15952 RCPT commands in a single message.
15953
15954
15955 .option recipients_max_reject main boolean false
15956 If this option is set true, Exim rejects SMTP messages containing too many
15957 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15958 error to the eventual DATA command. Otherwise (the default) it gives a 452
15959 error to the surplus RCPT commands and accepts the message on behalf of the
15960 initial set of recipients. The remote server should then re-send the message
15961 for the remaining recipients at a later time.
15962
15963
15964 .option remote_max_parallel main integer 2
15965 .cindex "delivery" "parallelism for remote"
15966 This option controls parallel delivery of one message to a number of remote
15967 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15968 does all the remote deliveries for a message one by one. Otherwise, if a single
15969 message has to be delivered to more than one remote host, or if several copies
15970 have to be sent to the same remote host, up to &%remote_max_parallel%&
15971 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15972 deliveries are required, the maximum number of processes are started, and as
15973 each one finishes, another is begun. The order of starting processes is the
15974 same as if sequential delivery were being done, and can be controlled by the
15975 &%remote_sort_domains%& option. If parallel delivery takes place while running
15976 with debugging turned on, the debugging output from each delivery process is
15977 tagged with its process id.
15978
15979 This option controls only the maximum number of parallel deliveries for one
15980 message in one Exim delivery process. Because Exim has no central queue
15981 manager, there is no way of controlling the total number of simultaneous
15982 deliveries if the configuration allows a delivery attempt as soon as a message
15983 is received.
15984
15985 .cindex "number of deliveries"
15986 .cindex "delivery" "maximum number of"
15987 If you want to control the total number of deliveries on the system, you
15988 need to set the &%queue_only%& option. This ensures that all incoming messages
15989 are added to the queue without starting a delivery process. Then set up an Exim
15990 daemon to start queue runner processes at appropriate intervals (probably
15991 fairly often, for example, every minute), and limit the total number of queue
15992 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15993 delivers only one message at a time, the maximum number of deliveries that can
15994 then take place at once is &%queue_run_max%& multiplied by
15995 &%remote_max_parallel%&.
15996
15997 If it is purely remote deliveries you want to control, use
15998 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15999 doing the SMTP routing before queueing, so that several messages for the same
16000 host will eventually get delivered down the same connection.
16001
16002
16003 .option remote_sort_domains main "domain list&!!" unset
16004 .cindex "sorting remote deliveries"
16005 .cindex "delivery" "sorting remote"
16006 When there are a number of remote deliveries for a message, they are sorted by
16007 domain into the order given by this list. For example,
16008 .code
16009 remote_sort_domains = *.cam.ac.uk:*.uk
16010 .endd
16011 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16012 then to those in the &%uk%& domain, then to any others.
16013
16014
16015 .option retry_data_expire main time 7d
16016 .cindex "hints database" "data expiry"
16017 This option sets a &"use before"& time on retry information in Exim's hints
16018 database. Any older retry data is ignored. This means that, for example, once a
16019 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16020 past failures.
16021
16022
16023 .option retry_interval_max main time 24h
16024 .cindex "retry" "limit on interval"
16025 .cindex "limit" "on retry interval"
16026 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16027 intervals between delivery attempts for messages that cannot be delivered
16028 straight away. This option sets an overall limit to the length of time between
16029 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16030 the default value.
16031
16032
16033 .option return_path_remove main boolean true
16034 .cindex "&'Return-path:'& header line" "removing"
16035 RFC 2821, section 4.4, states that an SMTP server must insert a
16036 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16037 The &'Return-path:'& header preserves the sender address as received in the
16038 MAIL command. This description implies that this header should not be present
16039 in an incoming message. If &%return_path_remove%& is true, any existing
16040 &'Return-path:'& headers are removed from messages at the time they are
16041 received. Exim's transports have options for adding &'Return-path:'& headers at
16042 the time of delivery. They are normally used only for final local deliveries.
16043
16044
16045 .option return_size_limit main integer 100K
16046 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16047
16048
16049 .option rfc1413_hosts main "host list&!!" @[]
16050 .cindex "RFC 1413"
16051 .cindex "host" "for RFC 1413 calls"
16052 RFC 1413 identification calls are made to any client host which matches
16053 an item in the list.
16054 The default value specifies just this host, being any local interface
16055 for the system.
16056
16057 .option rfc1413_query_timeout main time 0s
16058 .cindex "RFC 1413" "query timeout"
16059 .cindex "timeout" "for RFC 1413 call"
16060 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16061 no RFC 1413 calls are ever made.
16062
16063
16064 .option sender_unqualified_hosts main "host list&!!" unset
16065 .cindex "unqualified addresses"
16066 .cindex "host" "unqualified addresses from"
16067 This option lists those hosts from which Exim is prepared to accept unqualified
16068 sender addresses. The addresses are made fully qualified by the addition of
16069 &%qualify_domain%&. This option also affects message header lines. Exim does
16070 not reject unqualified addresses in headers that contain sender addresses, but
16071 it qualifies them only if the message came from a host that matches
16072 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16073 using TCP/IP), and the &%-bnq%& option was not set.
16074
16075
16076 .option slow_lookup_log main integer 0
16077 .cindex "logging" "slow lookups"
16078 .cindex "dns" "logging slow lookups"
16079 This option controls logging of slow lookups.
16080 If the value is nonzero it is taken as a number of milliseconds
16081 and lookups taking longer than this are logged.
16082 Currently this applies only to DNS lookups.
16083
16084
16085
16086 .option smtp_accept_keepalive main boolean true
16087 .cindex "keepalive" "on incoming connection"
16088 This option controls the setting of the SO_KEEPALIVE option on incoming
16089 TCP/IP socket connections. When set, it causes the kernel to probe idle
16090 connections periodically, by sending packets with &"old"& sequence numbers. The
16091 other end of the connection should send an acknowledgment if the connection is
16092 still okay or a reset if the connection has been aborted. The reason for doing
16093 this is that it has the beneficial effect of freeing up certain types of
16094 connection that can get stuck when the remote host is disconnected without
16095 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16096 hours to detect unreachable hosts.
16097
16098
16099
16100 .option smtp_accept_max main integer 20
16101 .cindex "limit" "incoming SMTP connections"
16102 .cindex "SMTP" "incoming connection count"
16103 .cindex "inetd"
16104 This option specifies the maximum number of simultaneous incoming SMTP calls
16105 that Exim will accept. It applies only to the listening daemon; there is no
16106 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16107 value is set to zero, no limit is applied. However, it is required to be
16108 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16109 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16110
16111 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16112 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16113 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16114 and &%smtp_load_reserve%& are then checked before accepting the connection.
16115
16116
16117 .option smtp_accept_max_nonmail main integer 10
16118 .cindex "limit" "non-mail SMTP commands"
16119 .cindex "SMTP" "limiting non-mail commands"
16120 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16121 the connection if there are too many. This option defines &"too many"&. The
16122 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16123 client looping sending EHLO, for example. The check is applied only if the
16124 client host matches &%smtp_accept_max_nonmail_hosts%&.
16125
16126 When a new message is expected, one occurrence of RSET is not counted. This
16127 allows a client to send one RSET between messages (this is not necessary,
16128 but some clients do it). Exim also allows one uncounted occurrence of HELO
16129 or EHLO, and one occurrence of STARTTLS between messages. After
16130 starting up a TLS session, another EHLO is expected, and so it too is not
16131 counted. The first occurrence of AUTH in a connection, or immediately
16132 following STARTTLS is not counted. Otherwise, all commands other than
16133 MAIL, RCPT, DATA, and QUIT are counted.
16134
16135
16136 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16137 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16138 check by setting this option. The default value makes it apply to all hosts. By
16139 changing the value, you can exclude any badly-behaved hosts that you have to
16140 live with.
16141
16142
16143 . Allow this long option name to split; give it unsplit as a fifth argument
16144 . for the automatic .oindex that is generated by .option.
16145 . We insert " &~&~" which is both pretty nasty visually and results in
16146 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16147 . zero-width-space, which would be nicer visually and results in (at least)
16148 . html that Firefox will split on when it's forced to reflow (rather than
16149 . inserting a horizontal scrollbar).  However, the text is still not
16150 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16151 . the option name to split.
16152
16153 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16154          smtp_accept_max_per_connection
16155 .cindex "SMTP" "limiting incoming message count"
16156 .cindex "limit" "messages per SMTP connection"
16157 The value of this option limits the number of MAIL commands that Exim is
16158 prepared to accept over a single SMTP connection, whether or not each command
16159 results in the transfer of a message. After the limit is reached, a 421
16160 response is given to subsequent MAIL commands. This limit is a safety
16161 precaution against a client that goes mad (incidents of this type have been
16162 seen).
16163
16164
16165 .option smtp_accept_max_per_host main string&!! unset
16166 .cindex "limit" "SMTP connections from one host"
16167 .cindex "host" "limiting SMTP connections from"
16168 This option restricts the number of simultaneous IP connections from a single
16169 host (strictly, from a single IP address) to the Exim daemon. The option is
16170 expanded, to enable different limits to be applied to different hosts by
16171 reference to &$sender_host_address$&. Once the limit is reached, additional
16172 connection attempts from the same host are rejected with error code 421. This
16173 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16174 of zero imposes no limit. If this option is set greater than zero, it is
16175 required that &%smtp_accept_max%& be non-zero.
16176
16177 &*Warning*&: When setting this option you should not use any expansion
16178 constructions that take an appreciable amount of time. The expansion and test
16179 happen in the main daemon loop, in order to reject additional connections
16180 without forking additional processes (otherwise a denial-of-service attack
16181 could cause a vast number or processes to be created). While the daemon is
16182 doing this processing, it cannot accept any other incoming connections.
16183
16184
16185
16186 .option smtp_accept_queue main integer 0
16187 .cindex "SMTP" "incoming connection count"
16188 .cindex "queueing incoming messages"
16189 .cindex "message" "queueing by SMTP connection count"
16190 If the number of simultaneous incoming SMTP connections being handled via the
16191 listening daemon exceeds this value, messages received by SMTP are just placed
16192 on the queue; no delivery processes are started automatically. The count is
16193 fixed at the start of an SMTP connection. It cannot be updated in the
16194 subprocess that receives messages, and so the queueing or not queueing applies
16195 to all messages received in the same connection.
16196
16197 A value of zero implies no limit, and clearly any non-zero value is useful only
16198 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16199 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16200 various &%-od%&&'x'& command line options.
16201
16202
16203 . See the comment on smtp_accept_max_per_connection
16204
16205 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16206          smtp_accept_queue_per_connection
16207 .cindex "queueing incoming messages"
16208 .cindex "message" "queueing by message count"
16209 This option limits the number of delivery processes that Exim starts
16210 automatically when receiving messages via SMTP, whether via the daemon or by
16211 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16212 and the number of messages received in a single SMTP session exceeds this
16213 number, subsequent messages are placed on the queue, but no delivery processes
16214 are started. This helps to limit the number of Exim processes when a server
16215 restarts after downtime and there is a lot of mail waiting for it on other
16216 systems. On large systems, the default should probably be increased, and on
16217 dial-in client systems it should probably be set to zero (that is, disabled).
16218
16219
16220 .option smtp_accept_reserve main integer 0
16221 .cindex "SMTP" "incoming call count"
16222 .cindex "host" "reserved"
16223 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16224 number of SMTP connections that are reserved for connections from the hosts
16225 that are specified in &%smtp_reserve_hosts%&. The value set in
16226 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16227 restricted to this number of connections; the option specifies a minimum number
16228 of connection slots for them, not a maximum. It is a guarantee that this group
16229 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16230 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16231 individual host.
16232
16233 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16234 set to 5, once there are 45 active connections (from any hosts), new
16235 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16236 provided the other criteria for acceptance are met.
16237
16238
16239 .option smtp_active_hostname main string&!! unset
16240 .cindex "host" "name in SMTP responses"
16241 .cindex "SMTP" "host name in responses"
16242 .vindex "&$primary_hostname$&"
16243 This option is provided for multi-homed servers that want to masquerade as
16244 several different hosts. At the start of an incoming SMTP connection, its value
16245 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16246 responses. For example, it is used as domain name in the response to an
16247 incoming HELO or EHLO command.
16248
16249 .vindex "&$smtp_active_hostname$&"
16250 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16251 is saved with any messages that are received. It is therefore available for use
16252 in routers and transports when the message is later delivered.
16253
16254 If this option is unset, or if its expansion is forced to fail, or if the
16255 expansion results in an empty string, the value of &$primary_hostname$& is
16256 used. Other expansion failures cause a message to be written to the main and
16257 panic logs, and the SMTP command receives a temporary error. Typically, the
16258 value of &%smtp_active_hostname%& depends on the incoming interface address.
16259 For example:
16260 .code
16261 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16262   {cox.mydomain}{box.mydomain}}
16263 .endd
16264
16265 Although &$smtp_active_hostname$& is primarily concerned with incoming
16266 messages, it is also used as the default for HELO commands in callout
16267 verification if there is no remote transport from which to obtain a
16268 &%helo_data%& value.
16269
16270 .option smtp_banner main string&!! "see below"
16271 .cindex "SMTP" "welcome banner"
16272 .cindex "banner for SMTP"
16273 .cindex "welcome banner for SMTP"
16274 .cindex "customizing" "SMTP banner"
16275 This string, which is expanded every time it is used, is output as the initial
16276 positive response to an SMTP connection. The default setting is:
16277 .code
16278 smtp_banner = $smtp_active_hostname ESMTP Exim \
16279   $version_number $tod_full
16280 .endd
16281 Failure to expand the string causes a panic error. If you want to create a
16282 multiline response to the initial SMTP connection, use &"\n"& in the string at
16283 appropriate points, but not at the end. Note that the 220 code is not included
16284 in this string. Exim adds it automatically (several times in the case of a
16285 multiline response).
16286
16287
16288 .option smtp_check_spool_space main boolean true
16289 .cindex "checking disk space"
16290 .cindex "disk space, checking"
16291 .cindex "spool directory" "checking space"
16292 When this option is set, if an incoming SMTP session encounters the SIZE
16293 option on a MAIL command, it checks that there is enough space in the
16294 spool directory's partition to accept a message of that size, while still
16295 leaving free the amount specified by &%check_spool_space%& (even if that value
16296 is zero). If there isn't enough space, a temporary error code is returned.
16297
16298
16299 .option smtp_connect_backlog main integer 20
16300 .cindex "connection backlog"
16301 .cindex "SMTP" "connection backlog"
16302 .cindex "backlog of connections"
16303 This option specifies a maximum number of waiting SMTP connections. Exim passes
16304 this value to the TCP/IP system when it sets up its listener. Once this number
16305 of connections are waiting for the daemon's attention, subsequent connection
16306 attempts are refused at the TCP/IP level. At least, that is what the manuals
16307 say; in some circumstances such connection attempts have been observed to time
16308 out instead. For large systems it is probably a good idea to increase the
16309 value (to 50, say). It also gives some protection against denial-of-service
16310 attacks by SYN flooding.
16311
16312
16313 .option smtp_enforce_sync main boolean true
16314 .cindex "SMTP" "synchronization checking"
16315 .cindex "synchronization checking in SMTP"
16316 The SMTP protocol specification requires the client to wait for a response from
16317 the server at certain points in the dialogue. Without PIPELINING these
16318 synchronization points are after every command; with PIPELINING they are
16319 fewer, but they still exist.
16320
16321 Some spamming sites send out a complete set of SMTP commands without waiting
16322 for any response. Exim protects against this by rejecting a message if the
16323 client has sent further input when it should not have. The error response &"554
16324 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16325 for this error cannot be perfect because of transmission delays (unexpected
16326 input may be on its way but not yet received when Exim checks). However, it
16327 does detect many instances.
16328
16329 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16330 If you want to disable the check selectively (for example, only for certain
16331 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16332 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16333
16334
16335
16336 .option smtp_etrn_command main string&!! unset
16337 .cindex "ETRN" "command to be run"
16338 .vindex "&$domain$&"
16339 If this option is set, the given command is run whenever an SMTP ETRN
16340 command is received from a host that is permitted to issue such commands (see
16341 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16342 are independently expanded. The expansion variable &$domain$& is set to the
16343 argument of the ETRN command, and no syntax checking is done on it. For
16344 example:
16345 .code
16346 smtp_etrn_command = /etc/etrn_command $domain \
16347                     $sender_host_address
16348 .endd
16349 A new process is created to run the command, but Exim does not wait for it to
16350 complete. Consequently, its status cannot be checked. If the command cannot be
16351 run, a line is written to the panic log, but the ETRN caller still receives
16352 a 250 success response. Exim is normally running under its own uid when
16353 receiving SMTP, so it is not possible for it to change the uid before running
16354 the command.
16355
16356
16357 .option smtp_etrn_serialize main boolean true
16358 .cindex "ETRN" "serializing"
16359 When this option is set, it prevents the simultaneous execution of more than
16360 one identical command as a result of ETRN in an SMTP connection. See
16361 section &<<SECTETRN>>& for details.
16362
16363
16364 .option smtp_load_reserve main fixed-point unset
16365 .cindex "load average"
16366 If the system load average ever gets higher than this, incoming SMTP calls are
16367 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16368 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16369 the load is over the limit. The option has no effect on ancient operating
16370 systems on which Exim cannot determine the load average. See also
16371 &%deliver_queue_load_max%& and &%queue_only_load%&.
16372
16373
16374
16375 .option smtp_max_synprot_errors main integer 3
16376 .cindex "SMTP" "limiting syntax and protocol errors"
16377 .cindex "limit" "SMTP syntax and protocol errors"
16378 Exim rejects SMTP commands that contain syntax or protocol errors. In
16379 particular, a syntactically invalid email address, as in this command:
16380 .code
16381 RCPT TO:<abc xyz@a.b.c>
16382 .endd
16383 causes immediate rejection of the command, before any other tests are done.
16384 (The ACL cannot be run if there is no valid address to set up for it.) An
16385 example of a protocol error is receiving RCPT before MAIL. If there are
16386 too many syntax or protocol errors in one SMTP session, the connection is
16387 dropped. The limit is set by this option.
16388
16389 .cindex "PIPELINING" "expected errors"
16390 When the PIPELINING extension to SMTP is in use, some protocol errors are
16391 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16392 Exim assumes that PIPELINING will be used if it advertises it (see
16393 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16394 not count towards the limit.
16395
16396
16397
16398 .option smtp_max_unknown_commands main integer 3
16399 .cindex "SMTP" "limiting unknown commands"
16400 .cindex "limit" "unknown SMTP commands"
16401 If there are too many unrecognized commands in an incoming SMTP session, an
16402 Exim server drops the connection. This is a defence against some kinds of abuse
16403 that subvert web
16404 clients
16405 into making connections to SMTP ports; in these circumstances, a number of
16406 non-SMTP command lines are sent first.
16407
16408
16409
16410 .option smtp_ratelimit_hosts main "host list&!!" unset
16411 .cindex "SMTP" "rate limiting"
16412 .cindex "limit" "rate of message arrival"
16413 .cindex "RCPT" "rate limiting"
16414 Some sites find it helpful to be able to limit the rate at which certain hosts
16415 can send them messages, and the rate at which an individual message can specify
16416 recipients.
16417
16418 Exim has two rate-limiting facilities. This section describes the older
16419 facility, which can limit rates within a single connection. The newer
16420 &%ratelimit%& ACL condition can limit rates across all connections. See section
16421 &<<SECTratelimiting>>& for details of the newer facility.
16422
16423 When a host matches &%smtp_ratelimit_hosts%&, the values of
16424 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16425 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16426 respectively. Each option, if set, must contain a set of four comma-separated
16427 values:
16428
16429 .ilist
16430 A threshold, before which there is no rate limiting.
16431 .next
16432 An initial time delay. Unlike other times in Exim, numbers with decimal
16433 fractional parts are allowed here.
16434 .next
16435 A factor by which to increase the delay each time.
16436 .next
16437 A maximum value for the delay. This should normally be less than 5 minutes,
16438 because after that time, the client is liable to timeout the SMTP command.
16439 .endlist
16440
16441 For example, these settings have been used successfully at the site which
16442 first suggested this feature, for controlling mail from their customers:
16443 .code
16444 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16445 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16446 .endd
16447 The first setting specifies delays that are applied to MAIL commands after
16448 two have been received over a single connection. The initial delay is 0.5
16449 seconds, increasing by a factor of 1.05 each time. The second setting applies
16450 delays to RCPT commands when more than four occur in a single message.
16451
16452
16453 .option smtp_ratelimit_mail main string unset
16454 See &%smtp_ratelimit_hosts%& above.
16455
16456
16457 .option smtp_ratelimit_rcpt main string unset
16458 See &%smtp_ratelimit_hosts%& above.
16459
16460
16461 .option smtp_receive_timeout main time&!! 5m
16462 .cindex "timeout" "for SMTP input"
16463 .cindex "SMTP" "input timeout"
16464 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16465 input, including batch SMTP. If a line of input (either an SMTP command or a
16466 data line) is not received within this time, the SMTP connection is dropped and
16467 the message is abandoned.
16468 A line is written to the log containing one of the following messages:
16469 .code
16470 SMTP command timeout on connection from...
16471 SMTP data timeout on connection from...
16472 .endd
16473 The former means that Exim was expecting to read an SMTP command; the latter
16474 means that it was in the DATA phase, reading the contents of a message.
16475
16476 If the first character of the option is a &"$"& the option is
16477 expanded before use and may depend on
16478 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16479
16480
16481 .oindex "&%-os%&"
16482 The value set by this option can be overridden by the
16483 &%-os%& command-line option. A setting of zero time disables the timeout, but
16484 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16485 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16486 timeout is controlled by &%receive_timeout%& and &%-or%&.
16487
16488
16489 .option smtp_reserve_hosts main "host list&!!" unset
16490 This option defines hosts for which SMTP connections are reserved; see
16491 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16492
16493
16494 .option smtp_return_error_details main boolean false
16495 .cindex "SMTP" "details policy failures"
16496 .cindex "policy control" "rejection, returning details"
16497 In the default state, Exim uses bland messages such as
16498 &"Administrative prohibition"& when it rejects SMTP commands for policy
16499 reasons. Many sysadmins like this because it gives away little information
16500 to spammers. However, some other sysadmins who are applying strict checking
16501 policies want to give out much fuller information about failures. Setting
16502 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16503 example, instead of &"Administrative prohibition"&, it might give:
16504 .code
16505 550-Rejected after DATA: '>' missing at end of address:
16506 550 failing address in "From" header is: <user@dom.ain
16507 .endd
16508
16509
16510 .new
16511 .option smtputf8_advertise_hosts main "host list&!!" *
16512 .cindex "SMTPUTF8" "advertising"
16513 When Exim is built with support for internationalised mail names,
16514 the availability therof is advertised in
16515 response to EHLO only to those client hosts that match this option. See
16516 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16517 .wen
16518
16519
16520 .option spamd_address main string "see below"
16521 This option is available when Exim is compiled with the content-scanning
16522 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16523 The default value is
16524 .code
16525 127.0.0.1 783
16526 .endd
16527 See section &<<SECTscanspamass>>& for more details.
16528
16529
16530
16531 .option split_spool_directory main boolean false
16532 .cindex "multiple spool directories"
16533 .cindex "spool directory" "split"
16534 .cindex "directories, multiple"
16535 If this option is set, it causes Exim to split its input directory into 62
16536 subdirectories, each with a single alphanumeric character as its name. The
16537 sixth character of the message id is used to allocate messages to
16538 subdirectories; this is the least significant base-62 digit of the time of
16539 arrival of the message.
16540
16541 Splitting up the spool in this way may provide better performance on systems
16542 where there are long mail queues, by reducing the number of files in any one
16543 directory. The msglog directory is also split up in a similar way to the input
16544 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16545 are still placed in the single directory &_msglog.OLD_&.
16546
16547 It is not necessary to take any special action for existing messages when
16548 changing &%split_spool_directory%&. Exim notices messages that are in the
16549 &"wrong"& place, and continues to process them. If the option is turned off
16550 after a period of being on, the subdirectories will eventually empty and be
16551 automatically deleted.
16552
16553 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16554 changes. Instead of creating a list of all messages in the queue, and then
16555 trying to deliver each one in turn, it constructs a list of those in one
16556 sub-directory and tries to deliver them, before moving on to the next
16557 sub-directory. The sub-directories are processed in a random order. This
16558 spreads out the scanning of the input directories, and uses less memory. It is
16559 particularly beneficial when there are lots of messages on the queue. However,
16560 if &%queue_run_in_order%& is set, none of this new processing happens. The
16561 entire queue has to be scanned and sorted before any deliveries can start.
16562
16563
16564 .option spool_directory main string&!! "set at compile time"
16565 .cindex "spool directory" "path to"
16566 This defines the directory in which Exim keeps its spool, that is, the messages
16567 it is waiting to deliver. The default value is taken from the compile-time
16568 configuration setting, if there is one. If not, this option must be set. The
16569 string is expanded, so it can contain, for example, a reference to
16570 &$primary_hostname$&.
16571
16572 If the spool directory name is fixed on your installation, it is recommended
16573 that you set it at build time rather than from this option, particularly if the
16574 log files are being written to the spool directory (see &%log_file_path%&).
16575 Otherwise log files cannot be used for errors that are detected early on, such
16576 as failures in the configuration file.
16577
16578 By using this option to override the compiled-in path, it is possible to run
16579 tests of Exim without using the standard spool.
16580
16581 .option sqlite_lock_timeout main time 5s
16582 .cindex "sqlite lookup type" "lock timeout"
16583 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16584 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16585
16586 .option strict_acl_vars main boolean false
16587 .cindex "&ACL;" "variables, handling unset"
16588 This option controls what happens if a syntactically valid but undefined ACL
16589 variable is referenced. If it is false (the default), an empty string
16590 is substituted; if it is true, an error is generated. See section
16591 &<<SECTaclvariables>>& for details of ACL variables.
16592
16593 .option strip_excess_angle_brackets main boolean false
16594 .cindex "angle brackets, excess"
16595 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16596 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16597 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16598 passed on to another MTA, the excess angle brackets are not passed on. If this
16599 option is not set, multiple pairs of angle brackets cause a syntax error.
16600
16601
16602 .option strip_trailing_dot main boolean false
16603 .cindex "trailing dot on domain"
16604 .cindex "dot" "trailing on domain"
16605 If this option is set, a trailing dot at the end of a domain in an address is
16606 ignored. If this is in the envelope and the message is passed on to another
16607 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16608 domain causes a syntax error.
16609 However, addresses in header lines are checked only when an ACL requests header
16610 syntax checking.
16611
16612
16613 .option syslog_duplication main boolean true
16614 .cindex "syslog" "duplicate log lines; suppressing"
16615 When Exim is logging to syslog, it writes the log lines for its three
16616 separate logs at different syslog priorities so that they can in principle
16617 be separated on the logging hosts. Some installations do not require this
16618 separation, and in those cases, the duplication of certain log lines is a
16619 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16620 particular log line is written to syslog. For lines that normally go to
16621 both the main log and the reject log, the reject log version (possibly
16622 containing message header lines) is written, at LOG_NOTICE priority.
16623 Lines that normally go to both the main and the panic log are written at
16624 the LOG_ALERT priority.
16625
16626
16627 .option syslog_facility main string unset
16628 .cindex "syslog" "facility; setting"
16629 This option sets the syslog &"facility"& name, used when Exim is logging to
16630 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16631 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16632 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16633 details of Exim's logging.
16634
16635
16636
16637 .option syslog_processname main string &`exim`&
16638 .cindex "syslog" "process name; setting"
16639 This option sets the syslog &"ident"& name, used when Exim is logging to
16640 syslog. The value must be no longer than 32 characters. See chapter
16641 &<<CHAPlog>>& for details of Exim's logging.
16642
16643
16644
16645 .option syslog_timestamp main boolean true
16646 .cindex "syslog" "timestamps"
16647 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16648 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16649 details of Exim's logging.
16650
16651
16652 .option system_filter main string&!! unset
16653 .cindex "filter" "system filter"
16654 .cindex "system filter" "specifying"
16655 .cindex "Sieve filter" "not available for system filter"
16656 This option specifies an Exim filter file that is applied to all messages at
16657 the start of each delivery attempt, before any routing is done. System filters
16658 must be Exim filters; they cannot be Sieve filters. If the system filter
16659 generates any deliveries to files or pipes, or any new mail messages, the
16660 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16661 which transports are to be used. Details of this facility are given in chapter
16662 &<<CHAPsystemfilter>>&.
16663
16664
16665 .option system_filter_directory_transport main string&!! unset
16666 .vindex "&$address_file$&"
16667 This sets the name of the transport driver that is to be used when the
16668 &%save%& command in a system message filter specifies a path ending in &"/"&,
16669 implying delivery of each message into a separate file in some directory.
16670 During the delivery, the variable &$address_file$& contains the path name.
16671
16672
16673 .option system_filter_file_transport main string&!! unset
16674 .cindex "file" "transport for system filter"
16675 This sets the name of the transport driver that is to be used when the &%save%&
16676 command in a system message filter specifies a path not ending in &"/"&. During
16677 the delivery, the variable &$address_file$& contains the path name.
16678
16679 .option system_filter_group main string unset
16680 .cindex "gid (group id)" "system filter"
16681 This option is used only when &%system_filter_user%& is also set. It sets the
16682 gid under which the system filter is run, overriding any gid that is associated
16683 with the user. The value may be numerical or symbolic.
16684
16685 .option system_filter_pipe_transport main string&!! unset
16686 .cindex "&(pipe)& transport" "for system filter"
16687 .vindex "&$address_pipe$&"
16688 This specifies the transport driver that is to be used when a &%pipe%& command
16689 is used in a system filter. During the delivery, the variable &$address_pipe$&
16690 contains the pipe command.
16691
16692
16693 .option system_filter_reply_transport main string&!! unset
16694 .cindex "&(autoreply)& transport" "for system filter"
16695 This specifies the transport driver that is to be used when a &%mail%& command
16696 is used in a system filter.
16697
16698
16699 .option system_filter_user main string unset
16700 .cindex "uid (user id)" "system filter"
16701 If this option is set to root, the system filter is run in the main Exim
16702 delivery process, as root.  Otherwise, the system filter runs in a separate
16703 process, as the given user, defaulting to the Exim run-time user.
16704 Unless the string consists entirely of digits, it
16705 is looked up in the password data. Failure to find the named user causes a
16706 configuration error. The gid is either taken from the password data, or
16707 specified by &%system_filter_group%&. When the uid is specified numerically,
16708 &%system_filter_group%& is required to be set.
16709
16710 If the system filter generates any pipe, file, or reply deliveries, the uid
16711 under which the filter is run is used when transporting them, unless a
16712 transport option overrides.
16713
16714
16715 .option tcp_nodelay main boolean true
16716 .cindex "daemon" "TCP_NODELAY on sockets"
16717 .cindex "Nagle algorithm"
16718 .cindex "TCP_NODELAY on listening sockets"
16719 If this option is set false, it stops the Exim daemon setting the
16720 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16721 turns off the &"Nagle algorithm"&, which is a way of improving network
16722 performance in interactive (character-by-character) situations. Turning it off
16723 should improve Exim's performance a bit, so that is what happens by default.
16724 However, it appears that some broken clients cannot cope, and time out. Hence
16725 this option. It affects only those sockets that are set up for listening by the
16726 daemon. Sockets created by the smtp transport for delivering mail always set
16727 TCP_NODELAY.
16728
16729
16730 .option timeout_frozen_after main time 0s
16731 .cindex "frozen messages" "timing out"
16732 .cindex "timeout" "frozen messages"
16733 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16734 message of any kind that has been on the queue for longer than the given time
16735 is automatically cancelled at the next queue run. If the frozen message is a
16736 bounce message, it is just discarded; otherwise, a bounce is sent to the
16737 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16738 If you want to timeout frozen bounce messages earlier than other kinds of
16739 frozen message, see &%ignore_bounce_errors_after%&.
16740
16741 &*Note:*& the default value of zero means no timeouts; with this setting,
16742 frozen messages remain on the queue forever (except for any frozen bounce
16743 messages that are released by &%ignore_bounce_errors_after%&).
16744
16745
16746 .option timezone main string unset
16747 .cindex "timezone, setting"
16748 The value of &%timezone%& is used to set the environment variable TZ while
16749 running Exim (if it is different on entry). This ensures that all timestamps
16750 created by Exim are in the required timezone. If you want all your timestamps
16751 to be in UTC (aka GMT) you should set
16752 .code
16753 timezone = UTC
16754 .endd
16755 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16756 or, if that is not set, from the value of the TZ environment variable when Exim
16757 is built. If &%timezone%& is set to the empty string, either at build or run
16758 time, any existing TZ variable is removed from the environment when Exim
16759 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16760 unfortunately not all, operating systems.
16761
16762
16763 .new
16764 .option tls_advertise_hosts main "host list&!!" *
16765 .wen
16766 .cindex "TLS" "advertising"
16767 .cindex "encryption" "on SMTP connection"
16768 .cindex "SMTP" "encrypted connection"
16769 When Exim is built with support for TLS encrypted connections, the availability
16770 of the STARTTLS command to set up an encrypted session is advertised in
16771 response to EHLO only to those client hosts that match this option. See
16772 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16773 .new
16774 Note that the default value requires that a certificate be supplied
16775 using the &%tls_certificate%& option.  If no certificate is available then
16776 the &%tls_advertise_hosts%& option should be set empty.
16777 .wen
16778
16779
16780 .option tls_certificate main string&!! unset
16781 .cindex "TLS" "server certificate; location of"
16782 .cindex "certificate" "server, location of"
16783 The value of this option is expanded, and must then be the absolute path to a
16784 file which contains the server's certificates. The server's private key is also
16785 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16786 &<<CHAPTLS>>& for further details.
16787
16788 &*Note*&: The certificates defined by this option are used only when Exim is
16789 receiving incoming messages as a server. If you want to supply certificates for
16790 use when sending messages as a client, you must set the &%tls_certificate%&
16791 option in the relevant &(smtp)& transport.
16792
16793 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16794 if the OpenSSL build supports TLS extensions and the TLS client sends the
16795 Server Name Indication extension, then this option and others documented in
16796 &<<SECTtlssni>>& will be re-expanded.
16797
16798 .option tls_crl main string&!! unset
16799 .cindex "TLS" "server certificate revocation list"
16800 .cindex "certificate" "revocation list for server"
16801 This option specifies a certificate revocation list. The expanded value must
16802 be the name of a file that contains a CRL in PEM format.
16803
16804 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16805
16806
16807 .option tls_dh_max_bits main integer 2236
16808 .cindex "TLS" "D-H bit count"
16809 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16810 the chosen TLS library.  That value might prove to be too high for
16811 interoperability.  This option provides a maximum clamp on the value
16812 suggested, trading off security for interoperability.
16813
16814 The value must be at least 1024.
16815
16816 The value 2236 was chosen because, at time of adding the option, it was the
16817 hard-coded maximum value supported by the NSS cryptographic library, as used
16818 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16819
16820 If you prefer more security and are willing to break some clients, raise this
16821 number.
16822
16823 Note that the value passed to GnuTLS for *generating* a new prime may be a
16824 little less than this figure, because GnuTLS is inexact and may produce a
16825 larger prime than requested.
16826
16827
16828 .option tls_dhparam main string&!! unset
16829 .cindex "TLS" "D-H parameters for server"
16830 The value of this option is expanded and indicates the source of DH parameters
16831 to be used by Exim.
16832
16833 If it is a filename starting with a &`/`&, then it names a file from which DH
16834 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16835 PKCS#3 representation of the DH prime.  If the file does not exist, for
16836 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16837 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16838 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16839 and treated as though the &%tls_dhparam%& were set to "none".
16840
16841 If this option expands to the string "none", then no DH parameters will be
16842 loaded by Exim.
16843
16844 If this option expands to the string "historic" and Exim is using GnuTLS, then
16845 Exim will attempt to load a file from inside the spool directory.  If the file
16846 does not exist, Exim will attempt to create it.
16847 See section &<<SECTgnutlsparam>>& for further details.
16848
16849 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16850 a default DH prime; the default is the 2048 bit prime described in section
16851 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16852 in IKE is assigned number 23.
16853
16854 Otherwise, the option must expand to the name used by Exim for any of a number
16855 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16856 "ike" followed by the number used by IKE, of "default" which corresponds to
16857 "ike23".
16858
16859 The available primes are:
16860 &`ike1`&, &`ike2`&, &`ike5`&,
16861 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16862 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16863
16864 Some of these will be too small to be accepted by clients.
16865 Some may be too large to be accepted by clients.
16866
16867 The TLS protocol does not negotiate an acceptable size for this; clients tend
16868 to hard-drop connections if what is offered by the server is unacceptable,
16869 whether too large or too small, and there's no provision for the client to
16870 tell the server what these constraints are.  Thus, as a server operator, you
16871 need to make an educated guess as to what is most likely to work for your
16872 userbase.
16873
16874 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16875 is most likely to maximise interoperability.  The upper bound comes from
16876 applications using the Mozilla Network Security Services (NSS) library, which
16877 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16878 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16879 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16880 acceptable bound from 1024 to 2048.
16881
16882
16883 .option tls_eccurve main string&!! prime256v1
16884 .cindex TLS "EC cryptography"
16885 If built with a recent-enough version of OpenSSL,
16886 this option selects a EC curve for use by Exim.
16887
16888 Curve names of the form &'prime256v1'& are accepted.
16889 For even more-recent library versions, names of the form &'P-512'&
16890 are also accepted, plus the special value &'auto'&
16891 which tell the library to choose.
16892
16893 If the option is set to an empty string, no EC curves will be enabled.
16894
16895
16896 .option tls_ocsp_file main string&!! unset
16897 .cindex TLS "certificate status"
16898 .cindex TLS "OCSP proof file"
16899 This option
16900 must if set expand to the absolute path to a file which contains a current
16901 status proof for the server's certificate, as obtained from the
16902 Certificate Authority.
16903
16904 .new
16905 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16906 .wen
16907
16908
16909 .option tls_on_connect_ports main "string list" unset
16910 .cindex SSMTP
16911 .cindex SMTPS
16912 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16913 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16914 set up without waiting for the client to issue a STARTTLS command. For
16915 further details, see section &<<SECTsupobssmt>>&.
16916
16917
16918
16919 .option tls_privatekey main string&!! unset
16920 .cindex "TLS" "server private key; location of"
16921 The value of this option is expanded, and must then be the absolute path to a
16922 file which contains the server's private key. If this option is unset, or if
16923 the expansion is forced to fail, or the result is an empty string, the private
16924 key is assumed to be in the same file as the server's certificates. See chapter
16925 &<<CHAPTLS>>& for further details.
16926
16927 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16928
16929
16930 .option tls_remember_esmtp main boolean false
16931 .cindex "TLS" "esmtp state; remembering"
16932 .cindex "TLS" "broken clients"
16933 If this option is set true, Exim violates the RFCs by remembering that it is in
16934 &"esmtp"& state after successfully negotiating a TLS session. This provides
16935 support for broken clients that fail to send a new EHLO after starting a
16936 TLS session.
16937
16938
16939 .option tls_require_ciphers main string&!! unset
16940 .cindex "TLS" "requiring specific ciphers"
16941 .cindex "cipher" "requiring specific"
16942 This option controls which ciphers can be used for incoming TLS connections.
16943 The &(smtp)& transport has an option of the same name for controlling outgoing
16944 connections. This option is expanded for each connection, so can be varied for
16945 different clients if required. The value of this option must be a list of
16946 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16947 in somewhat different ways. If GnuTLS is being used, the client controls the
16948 preference order of the available ciphers. Details are given in sections
16949 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16950
16951
16952 .option tls_try_verify_hosts main "host list&!!" unset
16953 .cindex "TLS" "client certificate verification"
16954 .cindex "certificate" "verification of client"
16955 See &%tls_verify_hosts%& below.
16956
16957
16958 .option tls_verify_certificates main string&!! system
16959 .cindex "TLS" "client certificate verification"
16960 .cindex "certificate" "verification of client"
16961 The value of this option is expanded, and must then be either the
16962 word "system"
16963 or the absolute path to
16964 a file or directory containing permitted certificates for clients that
16965 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16966
16967 The "system" value for the option will use a
16968 system default location compiled into the SSL library.
16969 This is not available for GnuTLS versions preceding 3.0.20,
16970 and will be taken as empty; an explicit location
16971 must be specified.
16972
16973 The use of a directory for the option value is not available for GnuTLS versions
16974 preceding 3.3.6 and a single file must be used.
16975
16976 With OpenSSL the certificates specified
16977 explicitly
16978 either by file or directory
16979 are added to those given by the system default location.
16980
16981 These certificates should be for the certificate authorities trusted, rather
16982 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16983 the value is a file then the certificates are sent by Exim as a server to
16984 connecting clients, defining the list of accepted certificate authorities.
16985 Thus the values defined should be considered public data.  To avoid this,
16986 use the explicit directory version.
16987
16988 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16989
16990 A forced expansion failure or setting to an empty string is equivalent to
16991 being unset.
16992
16993
16994 .option tls_verify_hosts main "host list&!!" unset
16995 .cindex "TLS" "client certificate verification"
16996 .cindex "certificate" "verification of client"
16997 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16998 certificates from clients. The expected certificates are defined by
16999 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17000 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17001 &%tls_verify_certificates%& is not set.
17002
17003 Any client that matches &%tls_verify_hosts%& is constrained by
17004 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17005 present one of the listed certificates. If it does not, the connection is
17006 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17007 the host to use TLS. It can still send SMTP commands through unencrypted
17008 connections. Forcing a client to use TLS has to be done separately using an
17009 ACL to reject inappropriate commands when the connection is not encrypted.
17010
17011 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17012 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17013 certificate and checks it against &%tls_verify_certificates%&, but does not
17014 abort the connection if there is no certificate or if it does not match. This
17015 state can be detected in an ACL, which makes it possible to implement policies
17016 such as &"accept for relay only if a verified certificate has been received,
17017 but accept for local delivery if encrypted, even without a verified
17018 certificate"&.
17019
17020 Client hosts that match neither of these lists are not asked to present
17021 certificates.
17022
17023
17024 .option trusted_groups main "string list&!!" unset
17025 .cindex "trusted groups"
17026 .cindex "groups" "trusted"
17027 This option is expanded just once, at the start of Exim's processing. If this
17028 option is set, any process that is running in one of the listed groups, or
17029 which has one of them as a supplementary group, is trusted. The groups can be
17030 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17031 details of what trusted callers are permitted to do. If neither
17032 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17033 are trusted.
17034
17035 .option trusted_users main "string list&!!" unset
17036 .cindex "trusted users"
17037 .cindex "user" "trusted"
17038 This option is expanded just once, at the start of Exim's processing. If this
17039 option is set, any process that is running as one of the listed users is
17040 trusted. The users can be specified numerically or by name. See section
17041 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17042 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17043 Exim user are trusted.
17044
17045 .option unknown_login main string&!! unset
17046 .cindex "uid (user id)" "unknown caller"
17047 .vindex "&$caller_uid$&"
17048 This is a specialized feature for use in unusual configurations. By default, if
17049 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17050 gives up. The &%unknown_login%& option can be used to set a login name to be
17051 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17052 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17053 is used for the user's real name (gecos field), unless this has been set by the
17054 &%-F%& option.
17055
17056 .option unknown_username main string unset
17057 See &%unknown_login%&.
17058
17059 .option untrusted_set_sender main "address list&!!" unset
17060 .cindex "trusted users"
17061 .cindex "sender" "setting by untrusted user"
17062 .cindex "untrusted user setting sender"
17063 .cindex "user" "untrusted setting sender"
17064 .cindex "envelope sender"
17065 When an untrusted user submits a message to Exim using the standard input, Exim
17066 normally creates an envelope sender address from the user's login and the
17067 default qualification domain. Data from the &%-f%& option (for setting envelope
17068 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17069 is used) is ignored.
17070
17071 However, untrusted users are permitted to set an empty envelope sender address,
17072 to declare that a message should never generate any bounces. For example:
17073 .code
17074 exim -f '<>' user@domain.example
17075 .endd
17076 .vindex "&$sender_ident$&"
17077 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17078 other envelope sender addresses in a controlled way. When it is set, untrusted
17079 users are allowed to set envelope sender addresses that match any of the
17080 patterns in the list. Like all address lists, the string is expanded. The
17081 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17082 users to setting senders that start with their login ids
17083 followed by a hyphen
17084 by a setting like this:
17085 .code
17086 untrusted_set_sender = ^$sender_ident-
17087 .endd
17088 If you want to allow untrusted users to set envelope sender addresses without
17089 restriction, you can use
17090 .code
17091 untrusted_set_sender = *
17092 .endd
17093 The &%untrusted_set_sender%& option applies to all forms of local input, but
17094 only to the setting of the envelope sender. It does not permit untrusted users
17095 to use the other options which trusted user can use to override message
17096 parameters. Furthermore, it does not stop Exim from removing an existing
17097 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17098 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17099 overriding these actions. The handling of the &'Sender:'& header is also
17100 described in section &<<SECTthesenhea>>&.
17101
17102 The log line for a message's arrival shows the envelope sender following
17103 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17104 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17105 envelope sender address, the user's login is shown in parentheses after the
17106 sender address.
17107
17108
17109 .option uucp_from_pattern main string "see below"
17110 .cindex "&""From""& line"
17111 .cindex "UUCP" "&""From""& line"
17112 Some applications that pass messages to an MTA via a command line interface use
17113 an initial line starting with &"From&~"& to pass the envelope sender. In
17114 particular, this is used by UUCP software. Exim recognizes such a line by means
17115 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17116 matches, the sender address is constructed by expanding the contents of
17117 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17118 default pattern recognizes lines in the following two forms:
17119 .code
17120 From ph10 Fri Jan  5 12:35 GMT 1996
17121 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17122 .endd
17123 The pattern can be seen by running
17124 .code
17125 exim -bP uucp_from_pattern
17126 .endd
17127 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17128 year in the second case. The first word after &"From&~"& is matched in the
17129 regular expression by a parenthesized subpattern. The default value for
17130 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17131 (&"ph10"& in the example above) as the message's sender. See also
17132 &%ignore_fromline_hosts%&.
17133
17134
17135 .option uucp_from_sender main string&!! &`$1`&
17136 See &%uucp_from_pattern%& above.
17137
17138
17139 .option warn_message_file main string unset
17140 .cindex "warning of delay" "customizing the message"
17141 .cindex "customizing" "warning message"
17142 This option defines a template file containing paragraphs of text to be used
17143 for constructing the warning message which is sent by Exim when a message has
17144 been on the queue for a specified amount of time, as specified by
17145 &%delay_warning%&. Details of the file's contents are given in chapter
17146 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17147
17148
17149 .option write_rejectlog main boolean true
17150 .cindex "reject log" "disabling"
17151 If this option is set false, Exim no longer writes anything to the reject log.
17152 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17153 .ecindex IIDconfima
17154 .ecindex IIDmaiconf
17155
17156
17157
17158
17159 . ////////////////////////////////////////////////////////////////////////////
17160 . ////////////////////////////////////////////////////////////////////////////
17161
17162 .chapter "Generic options for routers" "CHAProutergeneric"
17163 .scindex IIDgenoprou1 "options" "generic; for routers"
17164 .scindex IIDgenoprou2 "generic options" "router"
17165 This chapter describes the generic options that apply to all routers.
17166 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17167
17168 For a general description of how a router operates, see sections
17169 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17170 which the preconditions are tested. The order of expansion of the options that
17171 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17172 &%headers_remove%&, &%transport%&.
17173
17174
17175
17176 .option address_data routers string&!! unset
17177 .cindex "router" "data attached to address"
17178 The string is expanded just before the router is run, that is, after all the
17179 precondition tests have succeeded. If the expansion is forced to fail, the
17180 router declines, the value of &%address_data%& remains unchanged, and the
17181 &%more%& option controls what happens next. Other expansion failures cause
17182 delivery of the address to be deferred.
17183
17184 .vindex "&$address_data$&"
17185 When the expansion succeeds, the value is retained with the address, and can be
17186 accessed using the variable &$address_data$& in the current router, subsequent
17187 routers, and the eventual transport.
17188
17189 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17190 that runs a user's filter file, the contents of &$address_data$& are accessible
17191 in the filter. This is not normally a problem, because such data is usually
17192 either not confidential or it &"belongs"& to the current user, but if you do
17193 put confidential data into &$address_data$& you need to remember this point.
17194
17195 Even if the router declines or passes, the value of &$address_data$& remains
17196 with the address, though it can be changed by another &%address_data%& setting
17197 on a subsequent router. If a router generates child addresses, the value of
17198 &$address_data$& propagates to them. This also applies to the special kind of
17199 &"child"& that is generated by a router with the &%unseen%& option.
17200
17201 The idea of &%address_data%& is that you can use it to look up a lot of data
17202 for the address once, and then pick out parts of the data later. For example,
17203 you could use a single LDAP lookup to return a string of the form
17204 .code
17205 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17206 .endd
17207 In the transport you could pick out the mailbox by a setting such as
17208 .code
17209 file = ${extract{mailbox}{$address_data}}
17210 .endd
17211 This makes the configuration file less messy, and also reduces the number of
17212 lookups (though Exim does cache lookups).
17213
17214 .vindex "&$sender_address_data$&"
17215 .vindex "&$address_data$&"
17216 The &%address_data%& facility is also useful as a means of passing information
17217 from one router to another, and from a router to a transport. In addition, if
17218 &$address_data$& is set by a router when verifying a recipient address from an
17219 ACL, it remains available for use in the rest of the ACL statement. After
17220 verifying a sender, the value is transferred to &$sender_address_data$&.
17221
17222
17223
17224 .option address_test routers&!? boolean true
17225 .oindex "&%-bt%&"
17226 .cindex "router" "skipping when address testing"
17227 If this option is set false, the router is skipped when routing is being tested
17228 by means of the &%-bt%& command line option. This can be a convenience when
17229 your first router sends messages to an external scanner, because it saves you
17230 having to set the &"already scanned"& indicator when testing real address
17231 routing.
17232
17233
17234
17235 .option cannot_route_message routers string&!! unset
17236 .cindex "router" "customizing &""cannot route""& message"
17237 .cindex "customizing" "&""cannot route""& message"
17238 This option specifies a text message that is used when an address cannot be
17239 routed because Exim has run out of routers. The default message is
17240 &"Unrouteable address"&. This option is useful only on routers that have
17241 &%more%& set false, or on the very last router in a configuration, because the
17242 value that is used is taken from the last router that is considered. This
17243 includes a router that is skipped because its preconditions are not met, as
17244 well as a router that declines. For example, using the default configuration,
17245 you could put:
17246 .code
17247 cannot_route_message = Remote domain not found in DNS
17248 .endd
17249 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17250 and
17251 .code
17252 cannot_route_message = Unknown local user
17253 .endd
17254 on the final router that checks for local users. If string expansion fails for
17255 this option, the default message is used. Unless the expansion failure was
17256 explicitly forced, a message about the failure is written to the main and panic
17257 logs, in addition to the normal message about the routing failure.
17258
17259
17260 .option caseful_local_part routers boolean false
17261 .cindex "case of local parts"
17262 .cindex "router" "case of local parts"
17263 By default, routers handle the local parts of addresses in a case-insensitive
17264 manner, though the actual case is preserved for transmission with the message.
17265 If you want the case of letters to be significant in a router, you must set
17266 this option true. For individual router options that contain address or local
17267 part lists (for example, &%local_parts%&), case-sensitive matching can be
17268 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17269 more details.
17270
17271 .vindex "&$local_part$&"
17272 .vindex "&$original_local_part$&"
17273 .vindex "&$parent_local_part$&"
17274 The value of the &$local_part$& variable is forced to lower case while a
17275 router is running unless &%caseful_local_part%& is set. When a router assigns
17276 an address to a transport, the value of &$local_part$& when the transport runs
17277 is the same as it was in the router. Similarly, when a router generates child
17278 addresses by aliasing or forwarding, the values of &$original_local_part$&
17279 and &$parent_local_part$& are those that were used by the redirecting router.
17280
17281 This option applies to the processing of an address by a router. When a
17282 recipient address is being processed in an ACL, there is a separate &%control%&
17283 modifier that can be used to specify case-sensitive processing within the ACL
17284 (see section &<<SECTcontrols>>&).
17285
17286
17287
17288 .option check_local_user routers&!? boolean false
17289 .cindex "local user, checking in router"
17290 .cindex "router" "checking for local user"
17291 .cindex "&_/etc/passwd_&"
17292 .vindex "&$home$&"
17293 When this option is true, Exim checks that the local part of the recipient
17294 address (with affixes removed if relevant) is the name of an account on the
17295 local system. The check is done by calling the &[getpwnam()]& function rather
17296 than trying to read &_/etc/passwd_& directly. This means that other methods of
17297 holding password data (such as NIS) are supported. If the local part is a local
17298 user, &$home$& is set from the password data, and can be tested in other
17299 preconditions that are evaluated after this one (the order of evaluation is
17300 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17301 overridden by &%router_home_directory%&. If the local part is not a local user,
17302 the router is skipped.
17303
17304 If you want to check that the local part is either the name of a local user
17305 or matches something else, you cannot combine &%check_local_user%& with a
17306 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17307 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17308 setting to achieve this. For example:
17309 .code
17310 local_parts = passwd;$local_part : lsearch;/etc/other/users
17311 .endd
17312 Note, however, that the side effects of &%check_local_user%& (such as setting
17313 up a home directory) do not occur when a &(passwd)& lookup is used in a
17314 &%local_parts%& (or any other) precondition.
17315
17316
17317
17318 .option condition routers&!? string&!! unset
17319 .cindex "router" "customized precondition"
17320 This option specifies a general precondition test that has to succeed for the
17321 router to be called. The &%condition%& option is the last precondition to be
17322 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17323 result is a forced failure, or an empty string, or one of the strings &"0"& or
17324 &"no"& or &"false"& (checked without regard to the case of the letters), the
17325 router is skipped, and the address is offered to the next one.
17326
17327 If the result is any other value, the router is run (as this is the last
17328 precondition to be evaluated, all the other preconditions must be true).
17329
17330 This option is unusual in that multiple &%condition%& options may be present.
17331 All &%condition%& options must succeed.
17332
17333 The &%condition%& option provides a means of applying custom conditions to the
17334 running of routers. Note that in the case of a simple conditional expansion,
17335 the default expansion values are exactly what is wanted. For example:
17336 .code
17337 condition = ${if >{$message_age}{600}}
17338 .endd
17339 Because of the default behaviour of the string expansion, this is equivalent to
17340 .code
17341 condition = ${if >{$message_age}{600}{true}{}}
17342 .endd
17343
17344 A multiple condition example, which succeeds:
17345 .code
17346 condition = ${if >{$message_age}{600}}
17347 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17348 condition = foobar
17349 .endd
17350
17351 If the expansion fails (other than forced failure) delivery is deferred. Some
17352 of the other precondition options are common special cases that could in fact
17353 be specified using &%condition%&.
17354
17355 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17356 are far older, and use one set of semantics.  ACLs are newer and when
17357 they were created, the ACL &%condition%& process was given far stricter
17358 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17359 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17360 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17361 Router rules processing behavior.
17362
17363 This is best illustrated in an example:
17364 .code
17365 # If used in an ACL condition will fail with a syntax error, but
17366 # in a router condition any extra characters are treated as a string
17367
17368 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17369 true {yes} {no}}
17370
17371 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17372  {yes} {no}}
17373 .endd
17374 In each example above, the &%if%& statement actually ends after
17375 &"{google.com}}"&.  Since no true or false braces were defined, the
17376 default &%if%& behavior is to return a boolean true or a null answer
17377 (which evaluates to false). The rest of the line is then treated as a
17378 string. So the first example resulted in the boolean answer &"true"&
17379 with the string &" {yes} {no}}"& appended to it. The second example
17380 resulted in the null output (indicating false) with the string
17381 &" {yes} {no}}"& appended to it.
17382
17383 In fact you can put excess forward braces in too.  In the router
17384 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17385 mean something, like after a &"$"& or when required as part of a
17386 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17387 string characters.
17388
17389 Thus, in a Router, the above expansion strings will both always evaluate
17390 true, as the result of expansion is a non-empty string which doesn't
17391 match an explicit false value.  This can be tricky to debug.  By
17392 contrast, in an ACL either of those strings will always result in an
17393 expansion error because the result doesn't look sufficiently boolean.
17394
17395
17396 .option debug_print routers string&!! unset
17397 .cindex "testing" "variables in drivers"
17398 If this option is set and debugging is enabled (see the &%-d%& command line
17399 option) or in address-testing mode (see the &%-bt%& command line option),
17400 the string is expanded and included in the debugging output.
17401 If expansion of the string fails, the error message is written to the debugging
17402 output, and Exim carries on processing.
17403 This option is provided to help with checking out the values of variables and
17404 so on when debugging router configurations. For example, if a &%condition%&
17405 option appears not to be working, &%debug_print%& can be used to output the
17406 variables it references. The output happens after checks for &%domains%&,
17407 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17408 are tested. A newline is added to the text if it does not end with one.
17409 The variable &$router_name$& contains the name of the router.
17410
17411
17412
17413 .option disable_logging routers boolean false
17414 If this option is set true, nothing is logged for any routing errors
17415 or for any deliveries caused by this router. You should not set this option
17416 unless you really, really know what you are doing. See also the generic
17417 transport option of the same name.
17418
17419 .option dnssec_request_domains routers "domain list&!!" unset
17420 .cindex "MX record" "security"
17421 .cindex "DNSSEC" "MX lookup"
17422 .cindex "security" "MX lookup"
17423 .cindex "DNS" "DNSSEC"
17424 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17425 the dnssec request bit set.
17426 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17427
17428 .option dnssec_require_domains routers "domain list&!!" unset
17429 .cindex "MX record" "security"
17430 .cindex "DNSSEC" "MX lookup"
17431 .cindex "security" "MX lookup"
17432 .cindex "DNS" "DNSSEC"
17433 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17434 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17435 (AD bit) set will be ignored and logged as a host-lookup failure.
17436 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17437
17438
17439 .option domains routers&!? "domain list&!!" unset
17440 .cindex "router" "restricting to specific domains"
17441 .vindex "&$domain_data$&"
17442 If this option is set, the router is skipped unless the current domain matches
17443 the list. If the match is achieved by means of a file lookup, the data that the
17444 lookup returned for the domain is placed in &$domain_data$& for use in string
17445 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17446 a list of the order in which preconditions are evaluated.
17447
17448
17449
17450 .option driver routers string unset
17451 This option must always be set. It specifies which of the available routers is
17452 to be used.
17453
17454
17455 .option dsn_lasthop routers boolean false
17456 .cindex "DSN" "success"
17457 .cindex "Delivery Status Notification" "success"
17458 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17459 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17460 instead send a success DSN as if the next hop does not support DSN.
17461 Not effective on redirect routers.
17462
17463
17464
17465 .option errors_to routers string&!! unset
17466 .cindex "envelope sender"
17467 .cindex "router" "changing address for errors"
17468 If a router successfully handles an address, it may assign the address to a
17469 transport for delivery or it may generate child addresses. In both cases, if
17470 there is a delivery problem during later processing, the resulting bounce
17471 message is sent to the address that results from expanding this string,
17472 provided that the address verifies successfully. The &%errors_to%& option is
17473 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17474
17475 The &%errors_to%& setting associated with an address can be overridden if it
17476 subsequently passes through other routers that have their own &%errors_to%&
17477 settings, or if the message is delivered by a transport with a &%return_path%&
17478 setting.
17479
17480 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17481 the expansion fails to verify, the errors address associated with the incoming
17482 address is used. At top level, this is the envelope sender. A non-forced
17483 expansion failure causes delivery to be deferred.
17484
17485 If an address for which &%errors_to%& has been set ends up being delivered over
17486 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17487 any bounces that are generated by other MTAs on the delivery route are also
17488 sent there. You can set &%errors_to%& to the empty string by either of these
17489 settings:
17490 .code
17491 errors_to =
17492 errors_to = ""
17493 .endd
17494 An expansion item that yields an empty string has the same effect. If you do
17495 this, a locally detected delivery error for addresses processed by this router
17496 no longer gives rise to a bounce message; the error is discarded. If the
17497 address is delivered to a remote host, the return path is set to &`<>`&, unless
17498 overridden by the &%return_path%& option on the transport.
17499
17500 .vindex "&$address_data$&"
17501 If for some reason you want to discard local errors, but use a non-empty
17502 MAIL command for remote delivery, you can preserve the original return
17503 path in &$address_data$& in the router, and reinstate it in the transport by
17504 setting &%return_path%&.
17505
17506 The most common use of &%errors_to%& is to direct mailing list bounces to the
17507 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17508 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17509
17510
17511
17512 .option expn routers&!? boolean true
17513 .cindex "address" "testing"
17514 .cindex "testing" "addresses"
17515 .cindex "EXPN" "router skipping"
17516 .cindex "router" "skipping for EXPN"
17517 If this option is turned off, the router is skipped when testing an address
17518 as a result of processing an SMTP EXPN command. You might, for example,
17519 want to turn it off on a router for users' &_.forward_& files, while leaving it
17520 on for the system alias file.
17521 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17522 are evaluated.
17523
17524 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17525 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17526 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17527
17528
17529
17530 .option fail_verify routers boolean false
17531 .cindex "router" "forcing verification failure"
17532 Setting this option has the effect of setting both &%fail_verify_sender%& and
17533 &%fail_verify_recipient%& to the same value.
17534
17535
17536
17537 .option fail_verify_recipient routers boolean false
17538 If this option is true and an address is accepted by this router when
17539 verifying a recipient, verification fails.
17540
17541
17542
17543 .option fail_verify_sender routers boolean false
17544 If this option is true and an address is accepted by this router when
17545 verifying a sender, verification fails.
17546
17547
17548
17549 .option fallback_hosts routers "string list" unset
17550 .cindex "router" "fallback hosts"
17551 .cindex "fallback" "hosts specified on router"
17552 String expansion is not applied to this option. The argument must be a
17553 colon-separated list of host names or IP addresses. The list separator can be
17554 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17555 each name or address. In fact, the format of each item is exactly the same as
17556 defined for the list of hosts in a &(manualroute)& router (see section
17557 &<<SECTformatonehostitem>>&).
17558
17559 If a router queues an address for a remote transport, this host list is
17560 associated with the address, and used instead of the transport's fallback host
17561 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17562 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17563 transport for further details.
17564
17565
17566 .option group routers string&!! "see below"
17567 .cindex "gid (group id)" "local delivery"
17568 .cindex "local transports" "uid and gid"
17569 .cindex "transport" "local"
17570 .cindex "router" "setting group"
17571 When a router queues an address for a transport, and the transport does not
17572 specify a group, the group given here is used when running the delivery
17573 process.
17574 The group may be specified numerically or by name. If expansion fails, the
17575 error is logged and delivery is deferred.
17576 The default is unset, unless &%check_local_user%& is set, when the default
17577 is taken from the password information. See also &%initgroups%& and &%user%&
17578 and the discussion in chapter &<<CHAPenvironment>>&.
17579
17580
17581
17582 .option headers_add routers list&!! unset
17583 .cindex "header lines" "adding"
17584 .cindex "router" "adding header lines"
17585 This option specifies a list of text headers,
17586 newline-separated (by default, changeable in the usual way),
17587 that is associated with any addresses that are accepted by the router.
17588 Each item is separately expanded, at routing time.  However, this
17589 option has no effect when an address is just being verified. The way in which
17590 the text is used to add header lines at transport time is described in section
17591 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17592 message is in the process of being transported. This means that references to
17593 header lines in string expansions in the transport's configuration do not
17594 &"see"& the added header lines.
17595
17596 The &%headers_add%& option is expanded after &%errors_to%&, but before
17597 &%headers_remove%& and &%transport%&. If an item is empty, or if
17598 an item expansion is forced to fail, the item has no effect. Other expansion
17599 failures are treated as configuration errors.
17600
17601 Unlike most options, &%headers_add%& can be specified multiple times
17602 for a router; all listed headers are added.
17603
17604 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17605 router that has the &%one_time%& option set.
17606
17607 .cindex "duplicate addresses"
17608 .oindex "&%unseen%&"
17609 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17610 additions are deleted when the address is passed on to subsequent routers.
17611 For a &%redirect%& router, if a generated address is the same as the incoming
17612 address, this can lead to duplicate addresses with different header
17613 modifications. Exim does not do duplicate deliveries (except, in certain
17614 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17615 which of the duplicates is discarded, so this ambiguous situation should be
17616 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17617
17618
17619
17620 .option headers_remove routers list&!! unset
17621 .cindex "header lines" "removing"
17622 .cindex "router" "removing header lines"
17623 This option specifies a list of text headers,
17624 colon-separated (by default, changeable in the usual way),
17625 that is associated with any addresses that are accepted by the router.
17626 Each item is separately expanded, at routing time.  However, this
17627 option has no effect when an address is just being verified. The way in which
17628 the text is used to remove header lines at transport time is described in
17629 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17630 the message is in the process of being transported. This means that references
17631 to header lines in string expansions in the transport's configuration still
17632 &"see"& the original header lines.
17633
17634 The &%headers_remove%& option is expanded after &%errors_to%& and
17635 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17636 the item has no effect. Other expansion failures are treated as configuration
17637 errors.
17638
17639 Unlike most options, &%headers_remove%& can be specified multiple times
17640 for a router; all listed headers are removed.
17641
17642 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17643 router that has the &%one_time%& option set.
17644
17645 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17646 removal requests are deleted when the address is passed on to subsequent
17647 routers, and this can lead to problems with duplicates -- see the similar
17648 warning for &%headers_add%& above.
17649
17650 &*Warning 3*&: Because of the separate expansion of the list items,
17651 items that contain a list separator must have it doubled.
17652 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17653
17654
17655
17656 .option ignore_target_hosts routers "host list&!!" unset
17657 .cindex "IP address" "discarding"
17658 .cindex "router" "discarding IP addresses"
17659 Although this option is a host list, it should normally contain IP address
17660 entries rather than names. If any host that is looked up by the router has an
17661 IP address that matches an item in this list, Exim behaves as if that IP
17662 address did not exist. This option allows you to cope with rogue DNS entries
17663 like
17664 .code
17665 remote.domain.example.  A  127.0.0.1
17666 .endd
17667 by setting
17668 .code
17669 ignore_target_hosts = 127.0.0.1
17670 .endd
17671 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17672 discarded in this way, the router declines. In a conventional configuration, an
17673 attempt to mail to such a domain would normally provoke the &"unrouteable
17674 domain"& error, and an attempt to verify an address in the domain would fail.
17675 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17676 router declines if presented with one of the listed addresses.
17677
17678 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17679 means of the first or the second of the following settings, respectively:
17680 .code
17681 ignore_target_hosts = 0.0.0.0/0
17682 ignore_target_hosts = <; 0::0/0
17683 .endd
17684 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17685 in the second line matches all IPv6 addresses.
17686
17687 This option may also be useful for ignoring link-local and site-local IPv6
17688 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17689 is expanded before use as a list, it is possible to make it dependent on the
17690 domain that is being routed.
17691
17692 .vindex "&$host_address$&"
17693 During its expansion, &$host_address$& is set to the IP address that is being
17694 checked.
17695
17696 .option initgroups routers boolean false
17697 .cindex "additional groups"
17698 .cindex "groups" "additional"
17699 .cindex "local transports" "uid and gid"
17700 .cindex "transport" "local"
17701 If the router queues an address for a transport, and this option is true, and
17702 the uid supplied by the router is not overridden by the transport, the
17703 &[initgroups()]& function is called when running the transport to ensure that
17704 any additional groups associated with the uid are set up. See also &%group%&
17705 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17706
17707
17708
17709 .option local_part_prefix routers&!? "string list" unset
17710 .cindex "router" "prefix for local part"
17711 .cindex "prefix" "for local part, used in router"
17712 If this option is set, the router is skipped unless the local part starts with
17713 one of the given strings, or &%local_part_prefix_optional%& is true. See
17714 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17715 evaluated.
17716
17717 The list is scanned from left to right, and the first prefix that matches is
17718 used. A limited form of wildcard is available; if the prefix begins with an
17719 asterisk, it matches the longest possible sequence of arbitrary characters at
17720 the start of the local part. An asterisk should therefore always be followed by
17721 some character that does not occur in normal local parts.
17722 .cindex "multiple mailboxes"
17723 .cindex "mailbox" "multiple"
17724 Wildcarding can be used to set up multiple user mailboxes, as described in
17725 section &<<SECTmulbox>>&.
17726
17727 .vindex "&$local_part$&"
17728 .vindex "&$local_part_prefix$&"
17729 During the testing of the &%local_parts%& option, and while the router is
17730 running, the prefix is removed from the local part, and is available in the
17731 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17732 the router accepts the address, this remains true during subsequent delivery by
17733 a transport. In particular, the local part that is transmitted in the RCPT
17734 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17735 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17736 the relevant transport.
17737
17738 When an address is being verified, &%local_part_prefix%& affects only the
17739 behaviour of the router. If the callout feature of verification is in use, this
17740 means that the full address, including the prefix, will be used during the
17741 callout.
17742
17743 The prefix facility is commonly used to handle local parts of the form
17744 &%owner-something%&. Another common use is to support local parts of the form
17745 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17746 to tell a user their forwarding is broken &-- by placing a router like this one
17747 immediately before the router that handles &_.forward_& files:
17748 .code
17749 real_localuser:
17750   driver = accept
17751   local_part_prefix = real-
17752   check_local_user
17753   transport = local_delivery
17754 .endd
17755 For security, it would probably be a good idea to restrict the use of this
17756 router to locally-generated messages, using a condition such as this:
17757 .code
17758   condition = ${if match {$sender_host_address}\
17759                          {\N^(|127\.0\.0\.1)$\N}}
17760 .endd
17761
17762 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17763 both conditions must be met if not optional. Care must be taken if wildcards
17764 are used in both a prefix and a suffix on the same router. Different
17765 separator characters must be used to avoid ambiguity.
17766
17767
17768 .option local_part_prefix_optional routers boolean false
17769 See &%local_part_prefix%& above.
17770
17771
17772
17773 .option local_part_suffix routers&!? "string list" unset
17774 .cindex "router" "suffix for local part"
17775 .cindex "suffix for local part" "used in router"
17776 This option operates in the same way as &%local_part_prefix%&, except that the
17777 local part must end (rather than start) with the given string, the
17778 &%local_part_suffix_optional%& option determines whether the suffix is
17779 mandatory, and the wildcard * character, if present, must be the last
17780 character of the suffix. This option facility is commonly used to handle local
17781 parts of the form &%something-request%& and multiple user mailboxes of the form
17782 &%username-foo%&.
17783
17784
17785 .option local_part_suffix_optional routers boolean false
17786 See &%local_part_suffix%& above.
17787
17788
17789
17790 .option local_parts routers&!? "local part list&!!" unset
17791 .cindex "router" "restricting to specific local parts"
17792 .cindex "local part" "checking in router"
17793 The router is run only if the local part of the address matches the list.
17794 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17795 are evaluated, and
17796 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17797 string is expanded, it is possible to make it depend on the domain, for
17798 example:
17799 .code
17800 local_parts = dbm;/usr/local/specials/$domain
17801 .endd
17802 .vindex "&$local_part_data$&"
17803 If the match is achieved by a lookup, the data that the lookup returned
17804 for the local part is placed in the variable &$local_part_data$& for use in
17805 expansions of the router's private options. You might use this option, for
17806 example, if you have a large number of local virtual domains, and you want to
17807 send all postmaster mail to the same place without having to set up an alias in
17808 each virtual domain:
17809 .code
17810 postmaster:
17811   driver = redirect
17812   local_parts = postmaster
17813   data = postmaster@real.domain.example
17814 .endd
17815
17816
17817 .option log_as_local routers boolean "see below"
17818 .cindex "log" "delivery line"
17819 .cindex "delivery" "log line format"
17820 Exim has two logging styles for delivery, the idea being to make local
17821 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17822 recipient address is given just as the local part, without a domain. The use of
17823 this style is controlled by this option. It defaults to true for the &(accept)&
17824 router, and false for all the others. This option applies only when a
17825 router assigns an address to a transport. It has no effect on routers that
17826 redirect addresses.
17827
17828
17829
17830 .option more routers boolean&!! true
17831 The result of string expansion for this option must be a valid boolean value,
17832 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17833 result causes an error, and delivery is deferred. If the expansion is forced to
17834 fail, the default value for the option (true) is used. Other failures cause
17835 delivery to be deferred.
17836
17837 If this option is set false, and the router declines to handle the address, no
17838 further routers are tried, routing fails, and the address is bounced.
17839 .oindex "&%self%&"
17840 However, if the router explicitly passes an address to the following router by
17841 means of the setting
17842 .code
17843 self = pass
17844 .endd
17845 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17846 does not affect the behaviour if one of the precondition tests fails. In that
17847 case, the address is always passed to the next router.
17848
17849 Note that &%address_data%& is not considered to be a precondition. If its
17850 expansion is forced to fail, the router declines, and the value of &%more%&
17851 controls what happens next.
17852
17853
17854 .option pass_on_timeout routers boolean false
17855 .cindex "timeout" "of router"
17856 .cindex "router" "timeout"
17857 If a router times out during a host lookup, it normally causes deferral of the
17858 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17859 router, overriding &%no_more%&. This may be helpful for systems that are
17860 intermittently connected to the Internet, or those that want to pass to a smart
17861 host any messages that cannot immediately be delivered.
17862
17863 There are occasional other temporary errors that can occur while doing DNS
17864 lookups. They are treated in the same way as a timeout, and this option
17865 applies to all of them.
17866
17867
17868
17869 .option pass_router routers string unset
17870 .cindex "router" "go to after &""pass""&"
17871 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17872 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17873 routing to continue, and overriding a false setting of &%more%&. When one of
17874 these routers returns &"pass"&, the address is normally handed on to the next
17875 router in sequence. This can be changed by setting &%pass_router%& to the name
17876 of another router. However (unlike &%redirect_router%&) the named router must
17877 be below the current router, to avoid loops. Note that this option applies only
17878 to the special case of &"pass"&. It does not apply when a router returns
17879 &"decline"& because it cannot handle an address.
17880
17881
17882
17883 .option redirect_router routers string unset
17884 .cindex "router" "start at after redirection"
17885 Sometimes an administrator knows that it is pointless to reprocess addresses
17886 generated from alias or forward files with the same router again. For
17887 example, if an alias file translates real names into login ids there is no
17888 point searching the alias file a second time, especially if it is a large file.
17889
17890 The &%redirect_router%& option can be set to the name of any router instance.
17891 It causes the routing of any generated addresses to start at the named router
17892 instead of at the first router. This option has no effect if the router in
17893 which it is set does not generate new addresses.
17894
17895
17896
17897 .option require_files routers&!? "string list&!!" unset
17898 .cindex "file" "requiring for router"
17899 .cindex "router" "requiring file existence"
17900 This option provides a general mechanism for predicating the running of a
17901 router on the existence or non-existence of certain files or directories.
17902 Before running a router, as one of its precondition tests, Exim works its way
17903 through the &%require_files%& list, expanding each item separately.
17904
17905 Because the list is split before expansion, any colons in expansion items must
17906 be doubled, or the facility for using a different list separator must be used.
17907 If any expansion is forced to fail, the item is ignored. Other expansion
17908 failures cause routing of the address to be deferred.
17909
17910 If any expanded string is empty, it is ignored. Otherwise, except as described
17911 below, each string must be a fully qualified file path, optionally preceded by
17912 &"!"&. The paths are passed to the &[stat()]& function to test for the
17913 existence of the files or directories. The router is skipped if any paths not
17914 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17915
17916 .cindex "NFS"
17917 If &[stat()]& cannot determine whether a file exists or not, delivery of
17918 the message is deferred. This can happen when NFS-mounted filesystems are
17919 unavailable.
17920
17921 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17922 options, so you cannot use it to check for the existence of a file in which to
17923 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17924 full list of the order in which preconditions are evaluated.) However, as
17925 these options are all expanded, you can use the &%exists%& expansion condition
17926 to make such tests. The &%require_files%& option is intended for checking files
17927 that the router may be going to use internally, or which are needed by a
17928 transport (for example &_.procmailrc_&).
17929
17930 During delivery, the &[stat()]& function is run as root, but there is a
17931 facility for some checking of the accessibility of a file by another user.
17932 This is not a proper permissions check, but just a &"rough"& check that
17933 operates as follows:
17934
17935 If an item in a &%require_files%& list does not contain any forward slash
17936 characters, it is taken to be the user (and optional group, separated by a
17937 comma) to be checked for subsequent files in the list. If no group is specified
17938 but the user is specified symbolically, the gid associated with the uid is
17939 used. For example:
17940 .code
17941 require_files = mail:/some/file
17942 require_files = $local_part:$home/.procmailrc
17943 .endd
17944 If a user or group name in a &%require_files%& list does not exist, the
17945 &%require_files%& condition fails.
17946
17947 Exim performs the check by scanning along the components of the file path, and
17948 checking the access for the given uid and gid. It checks for &"x"& access on
17949 directories, and &"r"& access on the final file. Note that this means that file
17950 access control lists, if the operating system has them, are ignored.
17951
17952 &*Warning 1*&: When the router is being run to verify addresses for an
17953 incoming SMTP message, Exim is not running as root, but under its own uid. This
17954 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17955 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17956 user is not permitted to read one of the directories on the file's path.
17957
17958 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17959 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17960 without root access. In this case, if a check for access by a particular user
17961 is requested, Exim creates a subprocess that runs as that user, and tries the
17962 check again in that process.
17963
17964 The default action for handling an unresolved EACCES is to consider it to
17965 be caused by a configuration error, and routing is deferred because the
17966 existence or non-existence of the file cannot be determined. However, in some
17967 circumstances it may be desirable to treat this condition as if the file did
17968 not exist. If the file name (or the exclamation mark that precedes the file
17969 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17970 as if the file did not exist. For example:
17971 .code
17972 require_files = +/some/file
17973 .endd
17974 If the router is not an essential part of verification (for example, it
17975 handles users' &_.forward_& files), another solution is to set the &%verify%&
17976 option false so that the router is skipped when verifying.
17977
17978
17979
17980 .option retry_use_local_part routers boolean "see below"
17981 .cindex "hints database" "retry keys"
17982 .cindex "local part" "in retry keys"
17983 When a delivery suffers a temporary routing failure, a retry record is created
17984 in Exim's hints database. For addresses whose routing depends only on the
17985 domain, the key for the retry record should not involve the local part, but for
17986 other addresses, both the domain and the local part should be included.
17987 Usually, remote routing is of the former kind, and local routing is of the
17988 latter kind.
17989
17990 This option controls whether the local part is used to form the key for retry
17991 hints for addresses that suffer temporary errors while being handled by this
17992 router. The default value is true for any router that has &%check_local_user%&
17993 set, and false otherwise. Note that this option does not apply to hints keys
17994 for transport delays; they are controlled by a generic transport option of the
17995 same name.
17996
17997 The setting of &%retry_use_local_part%& applies only to the router on which it
17998 appears. If the router generates child addresses, they are routed
17999 independently; this setting does not become attached to them.
18000
18001
18002
18003 .option router_home_directory routers string&!! unset
18004 .cindex "router" "home directory for"
18005 .cindex "home directory" "for router"
18006 .vindex "&$home$&"
18007 This option sets a home directory for use while the router is running. (Compare
18008 &%transport_home_directory%&, which sets a home directory for later
18009 transporting.) In particular, if used on a &(redirect)& router, this option
18010 sets a value for &$home$& while a filter is running. The value is expanded;
18011 forced expansion failure causes the option to be ignored &-- other failures
18012 cause the router to defer.
18013
18014 Expansion of &%router_home_directory%& happens immediately after the
18015 &%check_local_user%& test (if configured), before any further expansions take
18016 place.
18017 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18018 are evaluated.)
18019 While the router is running, &%router_home_directory%& overrides the value of
18020 &$home$& that came from &%check_local_user%&.
18021
18022 When a router accepts an address and assigns it to a local transport (including
18023 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18024 delivery), the home directory setting for the transport is taken from the first
18025 of these values that is set:
18026
18027 .ilist
18028 The &%home_directory%& option on the transport;
18029 .next
18030 The &%transport_home_directory%& option on the router;
18031 .next
18032 The password data if &%check_local_user%& is set on the router;
18033 .next
18034 The &%router_home_directory%& option on the router.
18035 .endlist
18036
18037 In other words, &%router_home_directory%& overrides the password data for the
18038 router, but not for the transport.
18039
18040
18041
18042 .option self routers string freeze
18043 .cindex "MX record" "pointing to local host"
18044 .cindex "local host" "MX pointing to"
18045 This option applies to those routers that use a recipient address to find a
18046 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18047 and &(manualroute)& routers.
18048 Certain configurations of the &(queryprogram)& router can also specify a list
18049 of remote hosts.
18050 Usually such routers are configured to send the message to a remote host via an
18051 &(smtp)& transport. The &%self%& option specifies what happens when the first
18052 host on the list turns out to be the local host.
18053 The way in which Exim checks for the local host is described in section
18054 &<<SECTreclocipadd>>&.
18055
18056 Normally this situation indicates either an error in Exim's configuration (for
18057 example, the router should be configured not to process this domain), or an
18058 error in the DNS (for example, the MX should not point to this host). For this
18059 reason, the default action is to log the incident, defer the address, and
18060 freeze the message. The following alternatives are provided for use in special
18061 cases:
18062
18063 .vlist
18064 .vitem &%defer%&
18065 Delivery of the message is tried again later, but the message is not frozen.
18066
18067 .vitem "&%reroute%&: <&'domain'&>"
18068 The domain is changed to the given domain, and the address is passed back to
18069 be reprocessed by the routers. No rewriting of headers takes place. This
18070 behaviour is essentially a redirection.
18071
18072 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18073 The domain is changed to the given domain, and the address is passed back to be
18074 reprocessed by the routers. Any headers that contain the original domain are
18075 rewritten.
18076
18077 .vitem &%pass%&
18078 .oindex "&%more%&"
18079 .vindex "&$self_hostname$&"
18080 The router passes the address to the next router, or to the router named in the
18081 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18082 subsequent routing and delivery, the variable &$self_hostname$& contains the
18083 name of the local host that the router encountered. This can be used to
18084 distinguish between different cases for hosts with multiple names. The
18085 combination
18086 .code
18087 self = pass
18088 no_more
18089 .endd
18090 ensures that only those addresses that routed to the local host are passed on.
18091 Without &%no_more%&, addresses that were declined for other reasons would also
18092 be passed to the next router.
18093
18094 .vitem &%fail%&
18095 Delivery fails and an error report is generated.
18096
18097 .vitem &%send%&
18098 .cindex "local host" "sending to"
18099 The anomaly is ignored and the address is queued for the transport. This
18100 setting should be used with extreme caution. For an &(smtp)& transport, it
18101 makes sense only in cases where the program that is listening on the SMTP port
18102 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18103 different configuration file that handles the domain in another way.
18104 .endlist
18105
18106
18107
18108 .option senders routers&!? "address list&!!" unset
18109 .cindex "router" "checking senders"
18110 If this option is set, the router is skipped unless the message's sender
18111 address matches something on the list.
18112 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18113 are evaluated.
18114
18115 There are issues concerning verification when the running of routers is
18116 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18117 setting, it sets the sender to the null string. When using the &%-bt%& option
18118 to check a configuration file, it is necessary also to use the &%-f%& option to
18119 set an appropriate sender. For incoming mail, the sender is unset when
18120 verifying the sender, but is available when verifying any recipients. If the
18121 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18122 matters.
18123
18124
18125 .option translate_ip_address routers string&!! unset
18126 .cindex "IP address" "translating"
18127 .cindex "packet radio"
18128 .cindex "router" "IP address translation"
18129 There exist some rare networking situations (for example, packet radio) where
18130 it is helpful to be able to translate IP addresses generated by normal routing
18131 mechanisms into other IP addresses, thus performing a kind of manual IP
18132 routing. This should be done only if the normal IP routing of the TCP/IP stack
18133 is inadequate or broken. Because this is an extremely uncommon requirement, the
18134 code to support this option is not included in the Exim binary unless
18135 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18136
18137 .vindex "&$host_address$&"
18138 The &%translate_ip_address%& string is expanded for every IP address generated
18139 by the router, with the generated address set in &$host_address$&. If the
18140 expansion is forced to fail, no action is taken.
18141 For any other expansion error, delivery of the message is deferred.
18142 If the result of the expansion is an IP address, that replaces the original
18143 address; otherwise the result is assumed to be a host name &-- this is looked
18144 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18145 produce one or more replacement IP addresses. For example, to subvert all IP
18146 addresses in some specific networks, this could be added to a router:
18147 .code
18148 translate_ip_address = \
18149   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18150     {$value}fail}}
18151 .endd
18152 The file would contain lines like
18153 .code
18154 10.2.3.128/26    some.host
18155 10.8.4.34/26     10.44.8.15
18156 .endd
18157 You should not make use of this facility unless you really understand what you
18158 are doing.
18159
18160
18161
18162 .option transport routers string&!! unset
18163 This option specifies the transport to be used when a router accepts an address
18164 and sets it up for delivery. A transport is never needed if a router is used
18165 only for verification. The value of the option is expanded at routing time,
18166 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18167 and result must be the name of one of the configured transports. If it is not,
18168 delivery is deferred.
18169
18170 The &%transport%& option is not used by the &(redirect)& router, but it does
18171 have some private options that set up transports for pipe and file deliveries
18172 (see chapter &<<CHAPredirect>>&).
18173
18174
18175
18176 .option transport_current_directory routers string&!! unset
18177 .cindex "current directory for local transport"
18178 This option associates a current directory with any address that is routed
18179 to a local transport. This can happen either because a transport is
18180 explicitly configured for the router, or because it generates a delivery to a
18181 file or a pipe. During the delivery process (that is, at transport time), this
18182 option string is expanded and is set as the current directory, unless
18183 overridden by a setting on the transport.
18184 If the expansion fails for any reason, including forced failure, an error is
18185 logged, and delivery is deferred.
18186 See chapter &<<CHAPenvironment>>& for details of the local delivery
18187 environment.
18188
18189
18190
18191
18192 .option transport_home_directory routers string&!! "see below"
18193 .cindex "home directory" "for local transport"
18194 This option associates a home directory with any address that is routed to a
18195 local transport. This can happen either because a transport is explicitly
18196 configured for the router, or because it generates a delivery to a file or a
18197 pipe. During the delivery process (that is, at transport time), the option
18198 string is expanded and is set as the home directory, unless overridden by a
18199 setting of &%home_directory%& on the transport.
18200 If the expansion fails for any reason, including forced failure, an error is
18201 logged, and delivery is deferred.
18202
18203 If the transport does not specify a home directory, and
18204 &%transport_home_directory%& is not set for the router, the home directory for
18205 the transport is taken from the password data if &%check_local_user%& is set for
18206 the router. Otherwise it is taken from &%router_home_directory%& if that option
18207 is set; if not, no home directory is set for the transport.
18208
18209 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18210 environment.
18211
18212
18213
18214
18215 .option unseen routers boolean&!! false
18216 .cindex "router" "carrying on after success"
18217 The result of string expansion for this option must be a valid boolean value,
18218 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18219 result causes an error, and delivery is deferred. If the expansion is forced to
18220 fail, the default value for the option (false) is used. Other failures cause
18221 delivery to be deferred.
18222
18223 When this option is set true, routing does not cease if the router accepts the
18224 address. Instead, a copy of the incoming address is passed to the next router,
18225 overriding a false setting of &%more%&. There is little point in setting
18226 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18227 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18228 sometimes true and sometimes false).
18229
18230 .cindex "copy of message (&%unseen%& option)"
18231 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18232 qualifier in filter files. It can be used to cause copies of messages to be
18233 delivered to some other destination, while also carrying out a normal delivery.
18234 In effect, the current address is made into a &"parent"& that has two children
18235 &-- one that is delivered as specified by this router, and a clone that goes on
18236 to be routed further. For this reason, &%unseen%& may not be combined with the
18237 &%one_time%& option in a &(redirect)& router.
18238
18239 &*Warning*&: Header lines added to the address (or specified for removal) by
18240 this router or by previous routers affect the &"unseen"& copy of the message
18241 only. The clone that continues to be processed by further routers starts with
18242 no added headers and none specified for removal. For a &%redirect%& router, if
18243 a generated address is the same as the incoming address, this can lead to
18244 duplicate addresses with different header modifications. Exim does not do
18245 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18246 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18247 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18248 &%redirect%& router may be of help.
18249
18250 Unlike the handling of header modifications, any data that was set by the
18251 &%address_data%& option in the current or previous routers &'is'& passed on to
18252 subsequent routers.
18253
18254
18255 .option user routers string&!! "see below"
18256 .cindex "uid (user id)" "local delivery"
18257 .cindex "local transports" "uid and gid"
18258 .cindex "transport" "local"
18259 .cindex "router" "user for filter processing"
18260 .cindex "filter" "user for processing"
18261 When a router queues an address for a transport, and the transport does not
18262 specify a user, the user given here is used when running the delivery process.
18263 The user may be specified numerically or by name. If expansion fails, the
18264 error is logged and delivery is deferred.
18265 This user is also used by the &(redirect)& router when running a filter file.
18266 The default is unset, except when &%check_local_user%& is set. In this case,
18267 the default is taken from the password information. If the user is specified as
18268 a name, and &%group%& is not set, the group associated with the user is used.
18269 See also &%initgroups%& and &%group%& and the discussion in chapter
18270 &<<CHAPenvironment>>&.
18271
18272
18273
18274 .option verify routers&!? boolean true
18275 Setting this option has the effect of setting &%verify_sender%& and
18276 &%verify_recipient%& to the same value.
18277
18278
18279 .option verify_only routers&!? boolean false
18280 .cindex "EXPN" "with &%verify_only%&"
18281 .oindex "&%-bv%&"
18282 .cindex "router" "used only when verifying"
18283 If this option is set, the router is used only when verifying an address,
18284 delivering in cutthrough mode or
18285 testing with the &%-bv%& option, not when actually doing a delivery, testing
18286 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18287 restricted to verifying only senders or recipients by means of
18288 &%verify_sender%& and &%verify_recipient%&.
18289
18290 &*Warning*&: When the router is being run to verify addresses for an incoming
18291 SMTP message, Exim is not running as root, but under its own uid. If the router
18292 accesses any files, you need to make sure that they are accessible to the Exim
18293 user or group.
18294
18295
18296 .option verify_recipient routers&!? boolean true
18297 If this option is false, the router is skipped when verifying recipient
18298 addresses,
18299 delivering in cutthrough mode
18300 or testing recipient verification using &%-bv%&.
18301 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18302 are evaluated.
18303 See also the &$verify_mode$& variable.
18304
18305
18306 .option verify_sender routers&!? boolean true
18307 If this option is false, the router is skipped when verifying sender addresses
18308 or testing sender verification using &%-bvs%&.
18309 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18310 are evaluated.
18311 See also the &$verify_mode$& variable.
18312 .ecindex IIDgenoprou1
18313 .ecindex IIDgenoprou2
18314
18315
18316
18317
18318
18319
18320 . ////////////////////////////////////////////////////////////////////////////
18321 . ////////////////////////////////////////////////////////////////////////////
18322
18323 .chapter "The accept router" "CHID4"
18324 .cindex "&(accept)& router"
18325 .cindex "routers" "&(accept)&"
18326 The &(accept)& router has no private options of its own. Unless it is being
18327 used purely for verification (see &%verify_only%&) a transport is required to
18328 be defined by the generic &%transport%& option. If the preconditions that are
18329 specified by generic options are met, the router accepts the address and queues
18330 it for the given transport. The most common use of this router is for setting
18331 up deliveries to local mailboxes. For example:
18332 .code
18333 localusers:
18334   driver = accept
18335   domains = mydomain.example
18336   check_local_user
18337   transport = local_delivery
18338 .endd
18339 The &%domains%& condition in this example checks the domain of the address, and
18340 &%check_local_user%& checks that the local part is the login of a local user.
18341 When both preconditions are met, the &(accept)& router runs, and queues the
18342 address for the &(local_delivery)& transport.
18343
18344
18345
18346
18347
18348
18349 . ////////////////////////////////////////////////////////////////////////////
18350 . ////////////////////////////////////////////////////////////////////////////
18351
18352 .chapter "The dnslookup router" "CHAPdnslookup"
18353 .scindex IIDdnsrou1 "&(dnslookup)& router"
18354 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18355 The &(dnslookup)& router looks up the hosts that handle mail for the
18356 recipient's domain in the DNS. A transport must always be set for this router,
18357 unless &%verify_only%& is set.
18358
18359 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18360 SRV records. If none are found, or if SRV support is not configured,
18361 MX records are looked up. If no MX records exist, address records are sought.
18362 However, &%mx_domains%& can be set to disable the direct use of address
18363 records.
18364
18365 MX records of equal priority are sorted by Exim into a random order. Exim then
18366 looks for address records for the host names obtained from MX or SRV records.
18367 When a host has more than one IP address, they are sorted into a random order,
18368 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18369 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18370 generic option, the router declines.
18371
18372 Unless they have the highest priority (lowest MX value), MX records that point
18373 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18374 are discarded, together with any other MX records of equal or lower priority.
18375
18376 .cindex "MX record" "pointing to local host"
18377 .cindex "local host" "MX pointing to"
18378 .oindex "&%self%&" "in &(dnslookup)& router"
18379 If the host pointed to by the highest priority MX record, or looked up as an
18380 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18381 happens is controlled by the generic &%self%& option.
18382
18383
18384 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18385 There have been problems with DNS servers when SRV records are looked up.
18386 Some misbehaving servers return a DNS error or timeout when a non-existent
18387 SRV record is sought. Similar problems have in the past been reported for
18388 MX records. The global &%dns_again_means_nonexist%& option can help with this
18389 problem, but it is heavy-handed because it is a global option.
18390
18391 For this reason, there are two options, &%srv_fail_domains%& and
18392 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18393 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18394 an attempt to look up an SRV or MX record causes one of these results, and the
18395 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18396 such record"&. In the case of an SRV lookup, this means that the router
18397 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18398 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18399 case routing fails.
18400
18401
18402 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18403 .cindex "&(dnslookup)& router" "declines"
18404 There are a few cases where a &(dnslookup)& router will decline to accept
18405 an address; if such a router is expected to handle "all remaining non-local
18406 domains", then it is important to set &%no_more%&.
18407
18408 The router will defer rather than decline if the domain
18409 is found in the &%fail_defer_domains%& router option.
18410
18411 Reasons for a &(dnslookup)& router to decline currently include:
18412 .ilist
18413 The domain does not exist in DNS
18414 .next
18415 The domain exists but the MX record's host part is just "."; this is a common
18416 convention (borrowed from SRV) used to indicate that there is no such service
18417 for this domain and to not fall back to trying A/AAAA records.
18418 .next
18419 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18420 .next
18421 MX record points to a non-existent host.
18422 .next
18423 MX record points to an IP address and the main section option
18424 &%allow_mx_to_ip%& is not set.
18425 .next
18426 MX records exist and point to valid hosts, but all hosts resolve only to
18427 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18428 .next
18429 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18430 &%dns_check_names_pattern%& for handling one variant of this)
18431 .next
18432 &%check_secondary_mx%& is set on this router but the local host can
18433 not be found in the MX records (see below)
18434 .endlist
18435
18436
18437
18438
18439 .section "Private options for dnslookup" "SECID118"
18440 .cindex "options" "&(dnslookup)& router"
18441 The private options for the &(dnslookup)& router are as follows:
18442
18443 .option check_secondary_mx dnslookup boolean false
18444 .cindex "MX record" "checking for secondary"
18445 If this option is set, the router declines unless the local host is found in
18446 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18447 process domains for which the local host is a secondary mail exchanger
18448 differently to other domains. The way in which Exim decides whether a host is
18449 the local host is described in section &<<SECTreclocipadd>>&.
18450
18451
18452 .option check_srv dnslookup string&!! unset
18453 .cindex "SRV record" "enabling use of"
18454 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18455 addition to MX and address records. The support is disabled by default. To
18456 enable SRV support, set the &%check_srv%& option to the name of the service
18457 required. For example,
18458 .code
18459 check_srv = smtp
18460 .endd
18461 looks for SRV records that refer to the normal smtp service. The option is
18462 expanded, so the service name can vary from message to message or address
18463 to address. This might be helpful if SRV records are being used for a
18464 submission service. If the expansion is forced to fail, the &%check_srv%&
18465 option is ignored, and the router proceeds to look for MX records in the
18466 normal way.
18467
18468 When the expansion succeeds, the router searches first for SRV records for
18469 the given service (it assumes TCP protocol). A single SRV record with a
18470 host name that consists of just a single dot indicates &"no such service for
18471 this domain"&; if this is encountered, the router declines. If other kinds of
18472 SRV record are found, they are used to construct a host list for delivery
18473 according to the rules of RFC 2782. MX records are not sought in this case.
18474
18475 When no SRV records are found, MX records (and address records) are sought in
18476 the traditional way. In other words, SRV records take precedence over MX
18477 records, just as MX records take precedence over address records. Note that
18478 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18479 defined it. It is apparently believed that MX records are sufficient for email
18480 and that SRV records should not be used for this purpose. However, SRV records
18481 have an additional &"weight"& feature which some people might find useful when
18482 trying to split an SMTP load between hosts of different power.
18483
18484 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18485 when there is a DNS lookup error.
18486
18487
18488
18489
18490 .option fail_defer_domains dnslookup "domain list&!!" unset
18491 .cindex "MX record" "not found"
18492 DNS lookups for domains matching &%fail_defer_domains%&
18493 which find no matching record will cause the router to defer
18494 rather than the default behaviour of decline.
18495 This maybe be useful for queueing messages for a newly created
18496 domain while the DNS configuration is not ready.
18497 However, it will result in any message with mistyped domains
18498 also being queued.
18499
18500
18501 .option mx_domains dnslookup "domain list&!!" unset
18502 .cindex "MX record" "required to exist"
18503 .cindex "SRV record" "required to exist"
18504 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18505 record in order to be recognized. (The name of this option could be improved.)
18506 For example, if all the mail hosts in &'fict.example'& are known to have MX
18507 records, except for those in &'discworld.fict.example'&, you could use this
18508 setting:
18509 .code
18510 mx_domains = ! *.discworld.fict.example : *.fict.example
18511 .endd
18512 This specifies that messages addressed to a domain that matches the list but
18513 has no MX record should be bounced immediately instead of being routed using
18514 the address record.
18515
18516
18517 .option mx_fail_domains dnslookup "domain list&!!" unset
18518 If the DNS lookup for MX records for one of the domains in this list causes a
18519 DNS lookup error, Exim behaves as if no MX records were found. See section
18520 &<<SECTprowitdnsloo>>& for more discussion.
18521
18522
18523
18524
18525 .option qualify_single dnslookup boolean true
18526 .cindex "DNS" "resolver options"
18527 .cindex "DNS" "qualifying single-component names"
18528 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18529 lookups. Typically, but not standardly, this causes the resolver to qualify
18530 single-component names with the default domain. For example, on a machine
18531 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18532 &'thesaurus.ref.example'& inside the resolver. For details of what your
18533 resolver actually does, consult your man pages for &'resolver'& and
18534 &'resolv.conf'&.
18535
18536
18537
18538 .option rewrite_headers dnslookup boolean true
18539 .cindex "rewriting" "header lines"
18540 .cindex "header lines" "rewriting"
18541 If the domain name in the address that is being processed is not fully
18542 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18543 an address is specified as &'dormouse@teaparty'&, the domain might be
18544 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18545 occur as a result of setting the &%widen_domains%& option. If
18546 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18547 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18548 header lines of the message are rewritten with the full domain name.
18549
18550 This option should be turned off only when it is known that no message is
18551 ever going to be sent outside an environment where the abbreviation makes
18552 sense.
18553
18554 When an MX record is looked up in the DNS and matches a wildcard record, name
18555 servers normally return a record containing the name that has been looked up,
18556 making it impossible to detect whether a wildcard was present or not. However,
18557 some name servers have recently been seen to return the wildcard entry. If the
18558 name returned by a DNS lookup begins with an asterisk, it is not used for
18559 header rewriting.
18560
18561
18562 .option same_domain_copy_routing dnslookup boolean false
18563 .cindex "address" "copying routing"
18564 Addresses with the same domain are normally routed by the &(dnslookup)& router
18565 to the same list of hosts. However, this cannot be presumed, because the router
18566 options and preconditions may refer to the local part of the address. By
18567 default, therefore, Exim routes each address in a message independently. DNS
18568 servers run caches, so repeated DNS lookups are not normally expensive, and in
18569 any case, personal messages rarely have more than a few recipients.
18570
18571 If you are running mailing lists with large numbers of subscribers at the same
18572 domain, and you are using a &(dnslookup)& router which is independent of the
18573 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18574 lookups for identical domains in one message. In this case, when &(dnslookup)&
18575 routes an address to a remote transport, any other unrouted addresses in the
18576 message that have the same domain are automatically given the same routing
18577 without processing them independently,
18578 provided the following conditions are met:
18579
18580 .ilist
18581 No router that processed the address specified &%headers_add%& or
18582 &%headers_remove%&.
18583 .next
18584 The router did not change the address in any way, for example, by &"widening"&
18585 the domain.
18586 .endlist
18587
18588
18589
18590
18591 .option search_parents dnslookup boolean false
18592 .cindex "DNS" "resolver options"
18593 When this option is true, the resolver option RES_DNSRCH is set for DNS
18594 lookups. This is different from the &%qualify_single%& option in that it
18595 applies to domains containing dots. Typically, but not standardly, it causes
18596 the resolver to search for the name in the current domain and in parent
18597 domains. For example, on a machine in the &'fict.example'& domain, if looking
18598 up &'teaparty.wonderland'& failed, the resolver would try
18599 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18600 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18601
18602 Setting this option true can cause problems in domains that have a wildcard MX
18603 record, because any domain that does not have its own MX record matches the
18604 local wildcard.
18605
18606
18607
18608 .option srv_fail_domains dnslookup "domain list&!!" unset
18609 If the DNS lookup for SRV records for one of the domains in this list causes a
18610 DNS lookup error, Exim behaves as if no SRV records were found. See section
18611 &<<SECTprowitdnsloo>>& for more discussion.
18612
18613
18614
18615
18616 .option widen_domains dnslookup "string list" unset
18617 .cindex "domain" "partial; widening"
18618 If a DNS lookup fails and this option is set, each of its strings in turn is
18619 added onto the end of the domain, and the lookup is tried again. For example,
18620 if
18621 .code
18622 widen_domains = fict.example:ref.example
18623 .endd
18624 is set and a lookup of &'klingon.dictionary'& fails,
18625 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18626 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18627 and &%search_parents%& options can cause some widening to be undertaken inside
18628 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18629 when verifying, unless &%rewrite_headers%& is false (not the default).
18630
18631
18632 .section "Effect of qualify_single and search_parents" "SECID119"
18633 When a domain from an envelope recipient is changed by the resolver as a result
18634 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18635 corresponding address in the message's header lines unless &%rewrite_headers%&
18636 is set false. Exim then re-routes the address, using the full domain.
18637
18638 These two options affect only the DNS lookup that takes place inside the router
18639 for the domain of the address that is being routed. They do not affect lookups
18640 such as that implied by
18641 .code
18642 domains = @mx_any
18643 .endd
18644 that may happen while processing a router precondition before the router is
18645 entered. No widening ever takes place for these lookups.
18646 .ecindex IIDdnsrou1
18647 .ecindex IIDdnsrou2
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657 . ////////////////////////////////////////////////////////////////////////////
18658 . ////////////////////////////////////////////////////////////////////////////
18659
18660 .chapter "The ipliteral router" "CHID5"
18661 .cindex "&(ipliteral)& router"
18662 .cindex "domain literal" "routing"
18663 .cindex "routers" "&(ipliteral)&"
18664 This router has no private options. Unless it is being used purely for
18665 verification (see &%verify_only%&) a transport is required to be defined by the
18666 generic &%transport%& option. The router accepts the address if its domain part
18667 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18668 router handles the address
18669 .code
18670 root@[192.168.1.1]
18671 .endd
18672 by setting up delivery to the host with that IP address. IPv4 domain literals
18673 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18674 are similar, but the address is preceded by &`ipv6:`&. For example:
18675 .code
18676 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18677 .endd
18678 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18679 grounds that sooner or later somebody will try it.
18680
18681 .oindex "&%self%&" "in &(ipliteral)& router"
18682 If the IP address matches something in &%ignore_target_hosts%&, the router
18683 declines. If an IP literal turns out to refer to the local host, the generic
18684 &%self%& option determines what happens.
18685
18686 The RFCs require support for domain literals; however, their use is
18687 controversial in today's Internet. If you want to use this router, you must
18688 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18689 Exim will not recognize the domain literal syntax in addresses.
18690
18691
18692
18693 . ////////////////////////////////////////////////////////////////////////////
18694 . ////////////////////////////////////////////////////////////////////////////
18695
18696 .chapter "The iplookup router" "CHID6"
18697 .cindex "&(iplookup)& router"
18698 .cindex "routers" "&(iplookup)&"
18699 The &(iplookup)& router was written to fulfil a specific requirement in
18700 Cambridge University (which in fact no longer exists). For this reason, it is
18701 not included in the binary of Exim by default. If you want to include it, you
18702 must set
18703 .code
18704 ROUTER_IPLOOKUP=yes
18705 .endd
18706 in your &_Local/Makefile_& configuration file.
18707
18708 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18709 connection to one or more specific hosts. The host can then return the same or
18710 a different address &-- in effect rewriting the recipient address in the
18711 message's envelope. The new address is then passed on to subsequent routers. If
18712 this process fails, the address can be passed on to other routers, or delivery
18713 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18714 must not be specified for it.
18715
18716 .cindex "options" "&(iplookup)& router"
18717 .option hosts iplookup string unset
18718 This option must be supplied. Its value is a colon-separated list of host
18719 names. The hosts are looked up using &[gethostbyname()]&
18720 (or &[getipnodebyname()]& when available)
18721 and are tried in order until one responds to the query. If none respond, what
18722 happens is controlled by &%optional%&.
18723
18724
18725 .option optional iplookup boolean false
18726 If &%optional%& is true, if no response is obtained from any host, the address
18727 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18728 delivery to the address is deferred.
18729
18730
18731 .option port iplookup integer 0
18732 .cindex "port" "&(iplookup)& router"
18733 This option must be supplied. It specifies the port number for the TCP or UDP
18734 call.
18735
18736
18737 .option protocol iplookup string udp
18738 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18739 protocols is to be used.
18740
18741
18742 .option query iplookup string&!! "see below"
18743 This defines the content of the query that is sent to the remote hosts. The
18744 default value is:
18745 .code
18746 $local_part@$domain $local_part@$domain
18747 .endd
18748 The repetition serves as a way of checking that a response is to the correct
18749 query in the default case (see &%response_pattern%& below).
18750
18751
18752 .option reroute iplookup string&!! unset
18753 If this option is not set, the rerouted address is precisely the byte string
18754 returned by the remote host, up to the first white space, if any. If set, the
18755 string is expanded to form the rerouted address. It can include parts matched
18756 in the response by &%response_pattern%& by means of numeric variables such as
18757 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18758 whether or not a pattern is in use. In all cases, the rerouted address must end
18759 up in the form &'local_part@domain'&.
18760
18761
18762 .option response_pattern iplookup string unset
18763 This option can be set to a regular expression that is applied to the string
18764 returned from the remote host. If the pattern does not match the response, the
18765 router declines. If &%response_pattern%& is not set, no checking of the
18766 response is done, unless the query was defaulted, in which case there is a
18767 check that the text returned after the first white space is the original
18768 address. This checks that the answer that has been received is in response to
18769 the correct question. For example, if the response is just a new domain, the
18770 following could be used:
18771 .code
18772 response_pattern = ^([^@]+)$
18773 reroute = $local_part@$1
18774 .endd
18775
18776 .option timeout iplookup time 5s
18777 This specifies the amount of time to wait for a response from the remote
18778 machine. The same timeout is used for the &[connect()]& function for a TCP
18779 call. It does not apply to UDP.
18780
18781
18782
18783
18784 . ////////////////////////////////////////////////////////////////////////////
18785 . ////////////////////////////////////////////////////////////////////////////
18786
18787 .chapter "The manualroute router" "CHID7"
18788 .scindex IIDmanrou1 "&(manualroute)& router"
18789 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18790 .cindex "domain" "manually routing"
18791 The &(manualroute)& router is so-called because it provides a way of manually
18792 routing an address according to its domain. It is mainly used when you want to
18793 route addresses to remote hosts according to your own rules, bypassing the
18794 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18795 route to local transports, a facility that may be useful if you want to save
18796 messages for dial-in hosts in local files.
18797
18798 The &(manualroute)& router compares a list of domain patterns with the domain
18799 it is trying to route. If there is no match, the router declines. Each pattern
18800 has associated with it a list of hosts and some other optional data, which may
18801 include a transport. The combination of a pattern and its data is called a
18802 &"routing rule"&. For patterns that do not have an associated transport, the
18803 generic &%transport%& option must specify a transport, unless the router is
18804 being used purely for verification (see &%verify_only%&).
18805
18806 .vindex "&$host$&"
18807 In the case of verification, matching the domain pattern is sufficient for the
18808 router to accept the address. When actually routing an address for delivery,
18809 an address that matches a domain pattern is queued for the associated
18810 transport. If the transport is not a local one, a host list must be associated
18811 with the pattern; IP addresses are looked up for the hosts, and these are
18812 passed to the transport along with the mail address. For local transports, a
18813 host list is optional. If it is present, it is passed in &$host$& as a single
18814 text string.
18815
18816 The list of routing rules can be provided as an inline string in
18817 &%route_list%&, or the data can be obtained by looking up the domain in a file
18818 or database by setting &%route_data%&. Only one of these settings may appear in
18819 any one instance of &(manualroute)&. The format of routing rules is described
18820 below, following the list of private options.
18821
18822
18823 .section "Private options for manualroute" "SECTprioptman"
18824
18825 .cindex "options" "&(manualroute)& router"
18826 The private options for the &(manualroute)& router are as follows:
18827
18828 .option host_all_ignored manualroute string defer
18829 See &%host_find_failed%&.
18830
18831 .option host_find_failed manualroute string freeze
18832 This option controls what happens when &(manualroute)& tries to find an IP
18833 address for a host, and the host does not exist. The option can be set to one
18834 of the following values:
18835 .code
18836 decline
18837 defer
18838 fail
18839 freeze
18840 ignore
18841 pass
18842 .endd
18843 The default (&"freeze"&) assumes that this state is a serious configuration
18844 error. The difference between &"pass"& and &"decline"& is that the former
18845 forces the address to be passed to the next router (or the router defined by
18846 &%pass_router%&),
18847 .oindex "&%more%&"
18848 overriding &%no_more%&, whereas the latter passes the address to the next
18849 router only if &%more%& is true.
18850
18851 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18852 cannot be found. If all the hosts in the list are ignored, the behaviour is
18853 controlled by the &%host_all_ignored%& option. This takes the same values
18854 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18855
18856 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18857 state; if a host lookup gets a temporary error, delivery is deferred unless the
18858 generic &%pass_on_timeout%& option is set.
18859
18860
18861 .option hosts_randomize manualroute boolean false
18862 .cindex "randomized host list"
18863 .cindex "host" "list of; randomized"
18864 If this option is set, the order of the items in a host list in a routing rule
18865 is randomized each time the list is used, unless an option in the routing rule
18866 overrides (see below). Randomizing the order of a host list can be used to do
18867 crude load sharing. However, if more than one mail address is routed by the
18868 same router to the same host list, the host lists are considered to be the same
18869 (even though they may be randomized into different orders) for the purpose of
18870 deciding whether to batch the deliveries into a single SMTP transaction.
18871
18872 When &%hosts_randomize%& is true, a host list may be split
18873 into groups whose order is separately randomized. This makes it possible to
18874 set up MX-like behaviour. The boundaries between groups are indicated by an
18875 item that is just &`+`& in the host list. For example:
18876 .code
18877 route_list = * host1:host2:host3:+:host4:host5
18878 .endd
18879 The order of the first three hosts and the order of the last two hosts is
18880 randomized for each use, but the first three always end up before the last two.
18881 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18882 randomized host list is passed to an &(smtp)& transport that also has
18883 &%hosts_randomize set%&, the list is not re-randomized.
18884
18885
18886 .option route_data manualroute string&!! unset
18887 If this option is set, it must expand to yield the data part of a routing rule.
18888 Typically, the expansion string includes a lookup based on the domain. For
18889 example:
18890 .code
18891 route_data = ${lookup{$domain}dbm{/etc/routes}}
18892 .endd
18893 If the expansion is forced to fail, or the result is an empty string, the
18894 router declines. Other kinds of expansion failure cause delivery to be
18895 deferred.
18896
18897
18898 .option route_list manualroute "string list" unset
18899 This string is a list of routing rules, in the form defined below. Note that,
18900 unlike most string lists, the items are separated by semicolons. This is so
18901 that they may contain colon-separated host lists.
18902
18903
18904 .option same_domain_copy_routing manualroute boolean false
18905 .cindex "address" "copying routing"
18906 Addresses with the same domain are normally routed by the &(manualroute)&
18907 router to the same list of hosts. However, this cannot be presumed, because the
18908 router options and preconditions may refer to the local part of the address. By
18909 default, therefore, Exim routes each address in a message independently. DNS
18910 servers run caches, so repeated DNS lookups are not normally expensive, and in
18911 any case, personal messages rarely have more than a few recipients.
18912
18913 If you are running mailing lists with large numbers of subscribers at the same
18914 domain, and you are using a &(manualroute)& router which is independent of the
18915 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18916 lookups for identical domains in one message. In this case, when
18917 &(manualroute)& routes an address to a remote transport, any other unrouted
18918 addresses in the message that have the same domain are automatically given the
18919 same routing without processing them independently. However, this is only done
18920 if &%headers_add%& and &%headers_remove%& are unset.
18921
18922
18923
18924
18925 .section "Routing rules in route_list" "SECID120"
18926 The value of &%route_list%& is a string consisting of a sequence of routing
18927 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18928 entered as two semicolons. Alternatively, the list separator can be changed as
18929 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18930 Empty rules are ignored. The format of each rule is
18931 .display
18932 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18933 .endd
18934 The following example contains two rules, each with a simple domain pattern and
18935 no options:
18936 .code
18937 route_list = \
18938   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18939   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18940 .endd
18941 The three parts of a rule are separated by white space. The pattern and the
18942 list of hosts can be enclosed in quotes if necessary, and if they are, the
18943 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18944 single domain pattern, which is the only mandatory item in the rule. The
18945 pattern is in the same format as one item in a domain list (see section
18946 &<<SECTdomainlist>>&),
18947 except that it may not be the name of an interpolated file.
18948 That is, it may be wildcarded, or a regular expression, or a file or database
18949 lookup (with semicolons doubled, because of the use of semicolon as a separator
18950 in a &%route_list%&).
18951
18952 The rules in &%route_list%& are searched in order until one of the patterns
18953 matches the domain that is being routed. The list of hosts and then options are
18954 then used as described below. If there is no match, the router declines. When
18955 &%route_list%& is set, &%route_data%& must not be set.
18956
18957
18958
18959 .section "Routing rules in route_data" "SECID121"
18960 The use of &%route_list%& is convenient when there are only a small number of
18961 routing rules. For larger numbers, it is easier to use a file or database to
18962 hold the routing information, and use the &%route_data%& option instead.
18963 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18964 Most commonly, &%route_data%& is set as a string that contains an
18965 expansion lookup. For example, suppose we place two routing rules in a file
18966 like this:
18967 .code
18968 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18969 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18970 .endd
18971 This data can be accessed by setting
18972 .code
18973 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18974 .endd
18975 Failure of the lookup results in an empty string, causing the router to
18976 decline. However, you do not have to use a lookup in &%route_data%&. The only
18977 requirement is that the result of expanding the string is a list of hosts,
18978 possibly followed by options, separated by white space. The list of hosts must
18979 be enclosed in quotes if it contains white space.
18980
18981
18982
18983
18984 .section "Format of the list of hosts" "SECID122"
18985 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18986 always separately expanded before use. If the expansion fails, the router
18987 declines. The result of the expansion must be a colon-separated list of names
18988 and/or IP addresses, optionally also including ports. The format of each item
18989 in the list is described in the next section. The list separator can be changed
18990 as described in section &<<SECTlistconstruct>>&.
18991
18992 If the list of hosts was obtained from a &%route_list%& item, the following
18993 variables are set during its expansion:
18994
18995 .ilist
18996 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18997 If the domain was matched against a regular expression, the numeric variables
18998 &$1$&, &$2$&, etc. may be set. For example:
18999 .code
19000 route_list = ^domain(\d+)   host-$1.text.example
19001 .endd
19002 .next
19003 &$0$& is always set to the entire domain.
19004 .next
19005 &$1$& is also set when partial matching is done in a file lookup.
19006
19007 .next
19008 .vindex "&$value$&"
19009 If the pattern that matched the domain was a lookup item, the data that was
19010 looked up is available in the expansion variable &$value$&. For example:
19011 .code
19012 route_list = lsearch;;/some/file.routes  $value
19013 .endd
19014 .endlist
19015
19016 Note the doubling of the semicolon in the pattern that is necessary because
19017 semicolon is the default route list separator.
19018
19019
19020
19021 .section "Format of one host item" "SECTformatonehostitem"
19022 Each item in the list of hosts is either a host name or an IP address,
19023 optionally with an attached port number. When no port is given, an IP address
19024 is not enclosed in brackets. When a port is specified, it overrides the port
19025 specification on the transport. The port is separated from the name or address
19026 by a colon. This leads to some complications:
19027
19028 .ilist
19029 Because colon is the default separator for the list of hosts, either
19030 the colon that specifies a port must be doubled, or the list separator must
19031 be changed. The following two examples have the same effect:
19032 .code
19033 route_list = * "host1.tld::1225 : host2.tld::1226"
19034 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19035 .endd
19036 .next
19037 When IPv6 addresses are involved, it gets worse, because they contain
19038 colons of their own. To make this case easier, it is permitted to
19039 enclose an IP address (either v4 or v6) in square brackets if a port
19040 number follows. For example:
19041 .code
19042 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19043 .endd
19044 .endlist
19045
19046 .section "How the list of hosts is used" "SECThostshowused"
19047 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19048 the hosts is tried, in the order specified, when carrying out the SMTP
19049 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19050 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19051 transport.
19052
19053 Hosts may be listed by name or by IP address. An unadorned name in the list of
19054 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19055 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19056 records in the DNS. For example:
19057 .code
19058 route_list = *  x.y.z:p.q.r/MX:e.f.g
19059 .endd
19060 If this feature is used with a port specifier, the port must come last. For
19061 example:
19062 .code
19063 route_list = *  dom1.tld/mx::1225
19064 .endd
19065 If the &%hosts_randomize%& option is set, the order of the items in the list is
19066 randomized before any lookups are done. Exim then scans the list; for any name
19067 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19068 be an interface on the local host and the item is not the first in the list,
19069 Exim discards it and any subsequent items. If it is the first item, what
19070 happens is controlled by the
19071 .oindex "&%self%&" "in &(manualroute)& router"
19072 &%self%& option of the router.
19073
19074 A name on the list that is followed by &`/MX`& is replaced with the list of
19075 hosts obtained by looking up MX records for the name. This is always a DNS
19076 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19077 below) are not relevant here. The order of these hosts is determined by the
19078 preference values in the MX records, according to the usual rules. Because
19079 randomizing happens before the MX lookup, it does not affect the order that is
19080 defined by MX preferences.
19081
19082 If the local host is present in the sublist obtained from MX records, but is
19083 not the most preferred host in that list, it and any equally or less
19084 preferred hosts are removed before the sublist is inserted into the main list.
19085
19086 If the local host is the most preferred host in the MX list, what happens
19087 depends on where in the original list of hosts the &`/MX`& item appears. If it
19088 is not the first item (that is, there are previous hosts in the main list),
19089 Exim discards this name and any subsequent items in the main list.
19090
19091 If the MX item is first in the list of hosts, and the local host is the
19092 most preferred host, what happens is controlled by the &%self%& option of the
19093 router.
19094
19095 DNS failures when lookup up the MX records are treated in the same way as DNS
19096 failures when looking up IP addresses: &%pass_on_timeout%& and
19097 &%host_find_failed%& are used when relevant.
19098
19099 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19100 whether obtained from an MX lookup or not.
19101
19102
19103
19104 .section "How the options are used" "SECThowoptused"
19105 The options are a sequence of words; in practice no more than three are ever
19106 present. One of the words can be the name of a transport; this overrides the
19107 &%transport%& option on the router for this particular routing rule only. The
19108 other words (if present) control randomization of the list of hosts on a
19109 per-rule basis, and how the IP addresses of the hosts are to be found when
19110 routing to a remote transport. These options are as follows:
19111
19112 .ilist
19113 &%randomize%&: randomize the order of the hosts in this list, overriding the
19114 setting of &%hosts_randomize%& for this routing rule only.
19115 .next
19116 &%no_randomize%&: do not randomize the order of the hosts in this list,
19117 overriding the setting of &%hosts_randomize%& for this routing rule only.
19118 .next
19119 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19120 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19121 also look in &_/etc/hosts_& or other sources of information.
19122 .next
19123 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19124 no address records are found. If there is a temporary DNS error (such as a
19125 timeout), delivery is deferred.
19126 .endlist
19127
19128 For example:
19129 .code
19130 route_list = domain1  host1:host2:host3  randomize bydns;\
19131              domain2  host4:host5
19132 .endd
19133 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19134 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19135 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19136 or &[gethostbyname()]&, and the result of the lookup is the result of that
19137 call.
19138
19139 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19140 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19141 instead of TRY_AGAIN. That is why the default action is to try a DNS
19142 lookup first. Only if that gives a definite &"no such host"& is the local
19143 function called.
19144
19145
19146
19147 If no IP address for a host can be found, what happens is controlled by the
19148 &%host_find_failed%& option.
19149
19150 .vindex "&$host$&"
19151 When an address is routed to a local transport, IP addresses are not looked up.
19152 The host list is passed to the transport in the &$host$& variable.
19153
19154
19155
19156 .section "Manualroute examples" "SECID123"
19157 In some of the examples that follow, the presence of the &%remote_smtp%&
19158 transport, as defined in the default configuration file, is assumed:
19159
19160 .ilist
19161 .cindex "smart host" "example router"
19162 The &(manualroute)& router can be used to forward all external mail to a
19163 &'smart host'&. If you have set up, in the main part of the configuration, a
19164 named domain list that contains your local domains, for example:
19165 .code
19166 domainlist local_domains = my.domain.example
19167 .endd
19168 You can arrange for all other domains to be routed to a smart host by making
19169 your first router something like this:
19170 .code
19171 smart_route:
19172   driver = manualroute
19173   domains = !+local_domains
19174   transport = remote_smtp
19175   route_list = * smarthost.ref.example
19176 .endd
19177 This causes all non-local addresses to be sent to the single host
19178 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19179 they are tried in order
19180 (but you can use &%hosts_randomize%& to vary the order each time).
19181 Another way of configuring the same thing is this:
19182 .code
19183 smart_route:
19184   driver = manualroute
19185   transport = remote_smtp
19186   route_list = !+local_domains  smarthost.ref.example
19187 .endd
19188 There is no difference in behaviour between these two routers as they stand.
19189 However, they behave differently if &%no_more%& is added to them. In the first
19190 example, the router is skipped if the domain does not match the &%domains%&
19191 precondition; the following router is always tried. If the router runs, it
19192 always matches the domain and so can never decline. Therefore, &%no_more%&
19193 would have no effect. In the second case, the router is never skipped; it
19194 always runs. However, if it doesn't match the domain, it declines. In this case
19195 &%no_more%& would prevent subsequent routers from running.
19196
19197 .next
19198 .cindex "mail hub example"
19199 A &'mail hub'& is a host which receives mail for a number of domains via MX
19200 records in the DNS and delivers it via its own private routing mechanism. Often
19201 the final destinations are behind a firewall, with the mail hub being the one
19202 machine that can connect to machines both inside and outside the firewall. The
19203 &(manualroute)& router is usually used on a mail hub to route incoming messages
19204 to the correct hosts. For a small number of domains, the routing can be inline,
19205 using the &%route_list%& option, but for a larger number a file or database
19206 lookup is easier to manage.
19207
19208 If the domain names are in fact the names of the machines to which the mail is
19209 to be sent by the mail hub, the configuration can be quite simple. For
19210 example:
19211 .code
19212 hub_route:
19213   driver = manualroute
19214   transport = remote_smtp
19215   route_list = *.rhodes.tvs.example  $domain
19216 .endd
19217 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19218 whose names are the same as the mail domains. A similar approach can be taken
19219 if the host name can be obtained from the domain name by a string manipulation
19220 that the expansion facilities can handle. Otherwise, a lookup based on the
19221 domain can be used to find the host:
19222 .code
19223 through_firewall:
19224   driver = manualroute
19225   transport = remote_smtp
19226   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19227 .endd
19228 The result of the lookup must be the name or IP address of the host (or
19229 hosts) to which the address is to be routed. If the lookup fails, the route
19230 data is empty, causing the router to decline. The address then passes to the
19231 next router.
19232
19233 .next
19234 .cindex "batched SMTP output example"
19235 .cindex "SMTP" "batched outgoing; example"
19236 You can use &(manualroute)& to deliver messages to pipes or files in batched
19237 SMTP format for onward transportation by some other means. This is one way of
19238 storing mail for a dial-up host when it is not connected. The route list entry
19239 can be as simple as a single domain name in a configuration like this:
19240 .code
19241 save_in_file:
19242   driver = manualroute
19243   transport = batchsmtp_appendfile
19244   route_list = saved.domain.example
19245 .endd
19246 though often a pattern is used to pick up more than one domain. If there are
19247 several domains or groups of domains with different transport requirements,
19248 different transports can be listed in the routing information:
19249 .code
19250 save_in_file:
19251   driver = manualroute
19252   route_list = \
19253     *.saved.domain1.example  $domain  batch_appendfile; \
19254     *.saved.domain2.example  \
19255       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19256       batch_pipe
19257 .endd
19258 .vindex "&$domain$&"
19259 .vindex "&$host$&"
19260 The first of these just passes the domain in the &$host$& variable, which
19261 doesn't achieve much (since it is also in &$domain$&), but the second does a
19262 file lookup to find a value to pass, causing the router to decline to handle
19263 the address if the lookup fails.
19264
19265 .next
19266 .cindex "UUCP" "example of router for"
19267 Routing mail directly to UUCP software is a specific case of the use of
19268 &(manualroute)& in a gateway to another mail environment. This is an example of
19269 one way it can be done:
19270 .code
19271 # Transport
19272 uucp:
19273   driver = pipe
19274   user = nobody
19275   command = /usr/local/bin/uux -r - \
19276     ${substr_-5:$host}!rmail ${local_part}
19277   return_fail_output = true
19278
19279 # Router
19280 uucphost:
19281   transport = uucp
19282   driver = manualroute
19283   route_data = \
19284     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19285 .endd
19286 The file &_/usr/local/exim/uucphosts_& contains entries like
19287 .code
19288 darksite.ethereal.example:           darksite.UUCP
19289 .endd
19290 It can be set up more simply without adding and removing &".UUCP"& but this way
19291 makes clear the distinction between the domain name
19292 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19293 .endlist
19294 .ecindex IIDmanrou1
19295 .ecindex IIDmanrou2
19296
19297
19298
19299
19300
19301
19302
19303
19304 . ////////////////////////////////////////////////////////////////////////////
19305 . ////////////////////////////////////////////////////////////////////////////
19306
19307 .chapter "The queryprogram router" "CHAPdriverlast"
19308 .scindex IIDquerou1 "&(queryprogram)& router"
19309 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19310 .cindex "routing" "by external program"
19311 The &(queryprogram)& router routes an address by running an external command
19312 and acting on its output. This is an expensive way to route, and is intended
19313 mainly for use in lightly-loaded systems, or for performing experiments.
19314 However, if it is possible to use the precondition options (&%domains%&,
19315 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19316 be used in special cases, even on a busy host. There are the following private
19317 options:
19318 .cindex "options" "&(queryprogram)& router"
19319
19320 .option command queryprogram string&!! unset
19321 This option must be set. It specifies the command that is to be run. The
19322 command is split up into a command name and arguments, and then each is
19323 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19324 &<<CHAPpipetransport>>&).
19325
19326
19327 .option command_group queryprogram string unset
19328 .cindex "gid (group id)" "in &(queryprogram)& router"
19329 This option specifies a gid to be set when running the command while routing an
19330 address for deliver. It must be set if &%command_user%& specifies a numerical
19331 uid. If it begins with a digit, it is interpreted as the numerical value of the
19332 gid. Otherwise it is looked up using &[getgrnam()]&.
19333
19334
19335 .option command_user queryprogram string unset
19336 .cindex "uid (user id)" "for &(queryprogram)&"
19337 This option must be set. It specifies the uid which is set when running the
19338 command while routing an address for delivery. If the value begins with a digit,
19339 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19340 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19341 not set, a value for the gid also.
19342
19343 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19344 root, which it does during a normal delivery in a conventional configuration.
19345 However, when an address is being verified during message reception, Exim is
19346 usually running as the Exim user, not as root. If the &(queryprogram)& router
19347 is called from a non-root process, Exim cannot change uid or gid before running
19348 the command. In this circumstance the command runs under the current uid and
19349 gid.
19350
19351
19352 .option current_directory queryprogram string /
19353 This option specifies an absolute path which is made the current directory
19354 before running the command.
19355
19356
19357 .option timeout queryprogram time 1h
19358 If the command does not complete within the timeout period, its process group
19359 is killed and the message is frozen. A value of zero time specifies no
19360 timeout.
19361
19362
19363 The standard output of the command is connected to a pipe, which is read when
19364 the command terminates. It should consist of a single line of output,
19365 containing up to five fields, separated by white space. The maximum length of
19366 the line is 1023 characters. Longer lines are silently truncated. The first
19367 field is one of the following words (case-insensitive):
19368
19369 .ilist
19370 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19371 below).
19372 .next
19373 &'Decline'&: the router declines; pass the address to the next router, unless
19374 &%no_more%& is set.
19375 .next
19376 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19377 subsequent text on the line is an error message. If the router is run as part
19378 of address verification during an incoming SMTP message, the message is
19379 included in the SMTP response.
19380 .next
19381 &'Defer'&: routing could not be completed at this time; try again later. Any
19382 subsequent text on the line is an error message which is logged. It is not
19383 included in any SMTP response.
19384 .next
19385 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19386 .next
19387 &'Pass'&: pass the address to the next router (or the router specified by
19388 &%pass_router%&), overriding &%no_more%&.
19389 .next
19390 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19391 new addresses, which are routed independently, starting with the first router,
19392 or the router specified by &%redirect_router%&, if set.
19393 .endlist
19394
19395 When the first word is &'accept'&, the remainder of the line consists of a
19396 number of keyed data values, as follows (split into two lines here, to fit on
19397 the page):
19398 .code
19399 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19400 LOOKUP=byname|bydns DATA=<text>
19401 .endd
19402 The data items can be given in any order, and all are optional. If no transport
19403 is included, the transport specified by the generic &%transport%& option is
19404 used. The list of hosts and the lookup type are needed only if the transport is
19405 an &(smtp)& transport that does not itself supply a list of hosts.
19406
19407 The format of the list of hosts is the same as for the &(manualroute)& router.
19408 As well as host names and IP addresses with optional port numbers, as described
19409 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19410 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19411 (see section &<<SECThostshowused>>&).
19412
19413 If the lookup type is not specified, Exim behaves as follows when trying to
19414 find an IP address for each host: First, a DNS lookup is done. If this yields
19415 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19416 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19417 result of the lookup is the result of that call.
19418
19419 .vindex "&$address_data$&"
19420 If the DATA field is set, its value is placed in the &$address_data$&
19421 variable. For example, this return line
19422 .code
19423 accept hosts=x1.y.example:x2.y.example data="rule1"
19424 .endd
19425 routes the address to the default transport, passing a list of two hosts. When
19426 the transport runs, the string &"rule1"& is in &$address_data$&.
19427 .ecindex IIDquerou1
19428 .ecindex IIDquerou2
19429
19430
19431
19432
19433 . ////////////////////////////////////////////////////////////////////////////
19434 . ////////////////////////////////////////////////////////////////////////////
19435
19436 .chapter "The redirect router" "CHAPredirect"
19437 .scindex IIDredrou1 "&(redirect)& router"
19438 .scindex IIDredrou2 "routers" "&(redirect)&"
19439 .cindex "alias file" "in a &(redirect)& router"
19440 .cindex "address redirection" "&(redirect)& router"
19441 The &(redirect)& router handles several kinds of address redirection. Its most
19442 common uses are for resolving local part aliases from a central alias file
19443 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19444 files, but it has many other potential uses. The incoming address can be
19445 redirected in several different ways:
19446
19447 .ilist
19448 It can be replaced by one or more new addresses which are themselves routed
19449 independently.
19450 .next
19451 It can be routed to be delivered to a given file or directory.
19452 .next
19453 It can be routed to be delivered to a specified pipe command.
19454 .next
19455 It can cause an automatic reply to be generated.
19456 .next
19457 It can be forced to fail, optionally with a custom error message.
19458 .next
19459 It can be temporarily deferred, optionally with a custom message.
19460 .next
19461 It can be discarded.
19462 .endlist
19463
19464 The generic &%transport%& option must not be set for &(redirect)& routers.
19465 However, there are some private options which define transports for delivery to
19466 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19467 &%pipe_transport%& and &%reply_transport%& descriptions below.
19468
19469 If success DSNs have been requested
19470 .cindex "DSN" "success"
19471 .cindex "Delivery Status Notification" "success"
19472 redirection triggers one and the DSN options are not passed any further.
19473
19474
19475
19476 .section "Redirection data" "SECID124"
19477 The router operates by interpreting a text string which it obtains either by
19478 expanding the contents of the &%data%& option, or by reading the entire
19479 contents of a file whose name is given in the &%file%& option. These two
19480 options are mutually exclusive. The first is commonly used for handling system
19481 aliases, in a configuration like this:
19482 .code
19483 system_aliases:
19484   driver = redirect
19485   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19486 .endd
19487 If the lookup fails, the expanded string in this example is empty. When the
19488 expansion of &%data%& results in an empty string, the router declines. A forced
19489 expansion failure also causes the router to decline; other expansion failures
19490 cause delivery to be deferred.
19491
19492 A configuration using &%file%& is commonly used for handling users'
19493 &_.forward_& files, like this:
19494 .code
19495 userforward:
19496   driver = redirect
19497   check_local_user
19498   file = $home/.forward
19499   no_verify
19500 .endd
19501 If the file does not exist, or causes no action to be taken (for example, it is
19502 empty or consists only of comments), the router declines. &*Warning*&: This
19503 is not the case when the file contains syntactically valid items that happen to
19504 yield empty addresses, for example, items containing only RFC 2822 address
19505 comments.
19506
19507
19508
19509 .section "Forward files and address verification" "SECID125"
19510 .cindex "address redirection" "while verifying"
19511 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19512 &_.forward_& files, as in the example above. There are two reasons for this:
19513
19514 .ilist
19515 When Exim is receiving an incoming SMTP message from a remote host, it is
19516 running under the Exim uid, not as root. Exim is unable to change uid to read
19517 the file as the user, and it may not be able to read it as the Exim user. So in
19518 practice the router may not be able to operate.
19519 .next
19520 However, even when the router can operate, the existence of a &_.forward_& file
19521 is unimportant when verifying an address. What should be checked is whether the
19522 local part is a valid user name or not. Cutting out the redirection processing
19523 saves some resources.
19524 .endlist
19525
19526
19527
19528
19529
19530
19531 .section "Interpreting redirection data" "SECID126"
19532 .cindex "Sieve filter" "specifying in redirection data"
19533 .cindex "filter" "specifying in redirection data"
19534 The contents of the data string, whether obtained from &%data%& or &%file%&,
19535 can be interpreted in two different ways:
19536
19537 .ilist
19538 If the &%allow_filter%& option is set true, and the data begins with the text
19539 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19540 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19541 respectively. Details of the syntax and semantics of filter files are described
19542 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19543 document is intended for use by end users.
19544 .next
19545 Otherwise, the data must be a comma-separated list of redirection items, as
19546 described in the next section.
19547 .endlist
19548
19549 When a message is redirected to a file (a &"mail folder"&), the file name given
19550 in a non-filter redirection list must always be an absolute path. A filter may
19551 generate a relative path &-- how this is handled depends on the transport's
19552 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19553 for the &(appendfile)& transport.
19554
19555
19556
19557 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19558 .cindex "address redirection" "non-filter list items"
19559 When the redirection data is not an Exim or Sieve filter, for example, if it
19560 comes from a conventional alias or forward file, it consists of a list of
19561 addresses, file names, pipe commands, or certain special items (see section
19562 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19563 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19564 depending on their default values. The items in the list are separated by
19565 commas or newlines.
19566 If a comma is required in an item, the entire item must be enclosed in double
19567 quotes.
19568
19569 Lines starting with a # character are comments, and are ignored, and # may
19570 also appear following a comma, in which case everything between the # and the
19571 next newline character is ignored.
19572
19573 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19574 double quotes are retained because some forms of mail address require their use
19575 (but never to enclose the entire address). In the following description,
19576 &"item"& refers to what remains after any surrounding double quotes have been
19577 removed.
19578
19579 .vindex "&$local_part$&"
19580 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19581 and the expansion contains a reference to &$local_part$&, you should make use
19582 of the &%quote_local_part%& expansion operator, in case the local part contains
19583 special characters. For example, to redirect all mail for the domain
19584 &'obsolete.example'&, retaining the existing local part, you could use this
19585 setting:
19586 .code
19587 data = ${quote_local_part:$local_part}@newdomain.example
19588 .endd
19589
19590
19591 .section "Redirecting to a local mailbox" "SECTredlocmai"
19592 .cindex "routing" "loops in"
19593 .cindex "loop" "while routing, avoidance of"
19594 .cindex "address redirection" "to local mailbox"
19595 A redirection item may safely be the same as the address currently under
19596 consideration. This does not cause a routing loop, because a router is
19597 automatically skipped if any ancestor of the address that is being processed
19598 is the same as the current address and was processed by the current router.
19599 Such an address is therefore passed to the following routers, so it is handled
19600 as if there were no redirection. When making this loop-avoidance test, the
19601 complete local part, including any prefix or suffix, is used.
19602
19603 .cindex "address redirection" "local part without domain"
19604 Specifying the same local part without a domain is a common usage in personal
19605 filter files when the user wants to have messages delivered to the local
19606 mailbox and also forwarded elsewhere. For example, the user whose login is
19607 &'cleo'& might have a &_.forward_& file containing this:
19608 .code
19609 cleo, cleopatra@egypt.example
19610 .endd
19611 .cindex "backslash in alias file"
19612 .cindex "alias file" "backslash in"
19613 For compatibility with other MTAs, such unqualified local parts may be
19614 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19615 it does make a difference if more than one domain is being handled
19616 synonymously.
19617
19618 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19619 2822 address that does not include a domain, the item is qualified using the
19620 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19621 addresses are qualified using the value in &%qualify_recipient%&, but you can
19622 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19623
19624 Care must be taken if there are alias names for local users.
19625 Consider an MTA handling a single local domain where the system alias file
19626 contains:
19627 .code
19628 Sam.Reman: spqr
19629 .endd
19630 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19631 messages in the local mailbox, and also forward copies elsewhere. He creates
19632 this forward file:
19633 .code
19634 Sam.Reman, spqr@reme.elsewhere.example
19635 .endd
19636 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19637 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19638 second time round, because it has previously routed it,
19639 and the following routers presumably cannot handle the alias. The forward file
19640 should really contain
19641 .code
19642 spqr, spqr@reme.elsewhere.example
19643 .endd
19644 but because this is such a common error, the &%check_ancestor%& option (see
19645 below) exists to provide a way to get round it. This is normally set on a
19646 &(redirect)& router that is handling users' &_.forward_& files.
19647
19648
19649
19650 .section "Special items in redirection lists" "SECTspecitredli"
19651 In addition to addresses, the following types of item may appear in redirection
19652 lists (that is, in non-filter redirection data):
19653
19654 .ilist
19655 .cindex "pipe" "in redirection list"
19656 .cindex "address redirection" "to pipe"
19657 An item is treated as a pipe command if it begins with &"|"& and does not parse
19658 as a valid RFC 2822 address that includes a domain. A transport for running the
19659 command must be specified by the &%pipe_transport%& option.
19660 Normally, either the router or the transport specifies a user and a group under
19661 which to run the delivery. The default is to use the Exim user and group.
19662
19663 Single or double quotes can be used for enclosing the individual arguments of
19664 the pipe command; no interpretation of escapes is done for single quotes. If
19665 the command contains a comma character, it is necessary to put the whole item
19666 in double quotes, for example:
19667 .code
19668 "|/some/command ready,steady,go"
19669 .endd
19670 since items in redirection lists are terminated by commas. Do not, however,
19671 quote just the command. An item such as
19672 .code
19673 |"/some/command ready,steady,go"
19674 .endd
19675 is interpreted as a pipe with a rather strange command name, and no arguments.
19676
19677 Note that the above example assumes that the text comes from a lookup source
19678 of some sort, so that the quotes are part of the data.  If composing a
19679 redirect router with a &%data%& option directly specifying this command, the
19680 quotes will be used by the configuration parser to define the extent of one
19681 string, but will not be passed down into the redirect router itself.  There
19682 are two main approaches to get around this: escape quotes to be part of the
19683 data itself, or avoid using this mechanism and instead create a custom
19684 transport with the &%command%& option set and reference that transport from
19685 an &%accept%& router.
19686
19687 .next
19688 .cindex "file" "in redirection list"
19689 .cindex "address redirection" "to file"
19690 An item is interpreted as a path name if it begins with &"/"& and does not
19691 parse as a valid RFC 2822 address that includes a domain. For example,
19692 .code
19693 /home/world/minbari
19694 .endd
19695 is treated as a file name, but
19696 .code
19697 /s=molari/o=babylon/@x400gate.way
19698 .endd
19699 is treated as an address. For a file name, a transport must be specified using
19700 the &%file_transport%& option. However, if the generated path name ends with a
19701 forward slash character, it is interpreted as a directory name rather than a
19702 file name, and &%directory_transport%& is used instead.
19703
19704 Normally, either the router or the transport specifies a user and a group under
19705 which to run the delivery. The default is to use the Exim user and group.
19706
19707 .cindex "&_/dev/null_&"
19708 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19709 bypassed at a high level, and the log entry shows &"**bypassed**"&
19710 instead of a transport name. In this case the user and group are not used.
19711
19712 .next
19713 .cindex "included address list"
19714 .cindex "address redirection" "included external list"
19715 If an item is of the form
19716 .code
19717 :include:<path name>
19718 .endd
19719 a list of further items is taken from the given file and included at that
19720 point. &*Note*&: Such a file can not be a filter file; it is just an
19721 out-of-line addition to the list. The items in the included list are separated
19722 by commas or newlines and are not subject to expansion. If this is the first
19723 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19724 the alias name. This example is incorrect:
19725 .code
19726 list1    :include:/opt/lists/list1
19727 .endd
19728 It must be given as
19729 .code
19730 list1:   :include:/opt/lists/list1
19731 .endd
19732 .next
19733 .cindex "address redirection" "to black hole"
19734 Sometimes you want to throw away mail to a particular local part. Making the
19735 &%data%& option expand to an empty string does not work, because that causes
19736 the router to decline. Instead, the alias item
19737 .cindex "black hole"
19738 .cindex "abandoning mail"
19739 &':blackhole:'& can be used. It does what its name implies. No delivery is
19740 done, and no error message is generated. This has the same effect as specifying
19741 &_/dev/null_& as a destination, but it can be independently disabled.
19742
19743 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19744 delivery is done for the original local part, even if other redirection items
19745 are present. If you are generating a multi-item list (for example, by reading a
19746 database) and need the ability to provide a no-op item, you must use
19747 &_/dev/null_&.
19748
19749 .next
19750 .cindex "delivery" "forcing failure"
19751 .cindex "delivery" "forcing deferral"
19752 .cindex "failing delivery" "forcing"
19753 .cindex "deferred delivery, forcing"
19754 .cindex "customizing" "failure message"
19755 An attempt to deliver a particular address can be deferred or forced to fail by
19756 redirection items of the form
19757 .code
19758 :defer:
19759 :fail:
19760 .endd
19761 respectively. When a redirection list contains such an item, it applies
19762 to the entire redirection; any other items in the list are ignored. Any
19763 text following &':fail:'& or &':defer:'& is placed in the error text
19764 associated with the failure. For example, an alias file might contain:
19765 .code
19766 X.Employee:  :fail: Gone away, no forwarding address
19767 .endd
19768 In the case of an address that is being verified from an ACL or as the subject
19769 of a
19770 .cindex "VRFY" "error text, display of"
19771 VRFY command, the text is included in the SMTP error response by
19772 default.
19773 .cindex "EXPN" "error text, display of"
19774 The text is not included in the response to an EXPN command. In non-SMTP cases
19775 the text is included in the error message that Exim generates.
19776
19777 .cindex "SMTP" "error codes"
19778 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19779 &':fail:'&. However, if the message starts with three digits followed by a
19780 space, optionally followed by an extended code of the form &'n.n.n'&, also
19781 followed by a space, and the very first digit is the same as the default error
19782 code, the code from the message is used instead. If the very first digit is
19783 incorrect, a panic error is logged, and the default code is used. You can
19784 suppress the use of the supplied code in a redirect router by setting the
19785 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19786 ignored.
19787
19788 .vindex "&$acl_verify_message$&"
19789 In an ACL, an explicitly provided message overrides the default, but the
19790 default message is available in the variable &$acl_verify_message$& and can
19791 therefore be included in a custom message if this is desired.
19792
19793 Normally the error text is the rest of the redirection list &-- a comma does
19794 not terminate it &-- but a newline does act as a terminator. Newlines are not
19795 normally present in alias expansions. In &(lsearch)& lookups they are removed
19796 as part of the continuation process, but they may exist in other kinds of
19797 lookup and in &':include:'& files.
19798
19799 During routing for message delivery (as opposed to verification), a redirection
19800 containing &':fail:'& causes an immediate failure of the incoming address,
19801 whereas &':defer:'& causes the message to remain on the queue so that a
19802 subsequent delivery attempt can happen at a later time. If an address is
19803 deferred for too long, it will ultimately fail, because the normal retry
19804 rules still apply.
19805
19806 .next
19807 .cindex "alias file" "exception to default"
19808 Sometimes it is useful to use a single-key search type with a default (see
19809 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19810 for exceptions to the default. These can be handled by aliasing them to
19811 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19812 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19813 results in an empty redirection list has the same effect.
19814 .endlist
19815
19816
19817 .section "Duplicate addresses" "SECTdupaddr"
19818 .cindex "duplicate addresses"
19819 .cindex "address duplicate, discarding"
19820 .cindex "pipe" "duplicated"
19821 Exim removes duplicate addresses from the list to which it is delivering, so as
19822 to deliver just one copy to each address. This does not apply to deliveries
19823 routed to pipes by different immediate parent addresses, but an indirect
19824 aliasing scheme of the type
19825 .code
19826 pipe:       |/some/command $local_part
19827 localpart1: pipe
19828 localpart2: pipe
19829 .endd
19830 does not work with a message that is addressed to both local parts, because
19831 when the second is aliased to the intermediate local part &"pipe"& it gets
19832 discarded as being the same as a previously handled address. However, a scheme
19833 such as
19834 .code
19835 localpart1: |/some/command $local_part
19836 localpart2: |/some/command $local_part
19837 .endd
19838 does result in two different pipe deliveries, because the immediate parents of
19839 the pipes are distinct.
19840
19841
19842
19843 .section "Repeated redirection expansion" "SECID128"
19844 .cindex "repeated redirection expansion"
19845 .cindex "address redirection" "repeated for each delivery attempt"
19846 When a message cannot be delivered to all of its recipients immediately,
19847 leading to two or more delivery attempts, redirection expansion is carried out
19848 afresh each time for those addresses whose children were not all previously
19849 delivered. If redirection is being used as a mailing list, this can lead to new
19850 members of the list receiving copies of old messages. The &%one_time%& option
19851 can be used to avoid this.
19852
19853
19854 .section "Errors in redirection lists" "SECID129"
19855 .cindex "address redirection" "errors"
19856 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19857 error is skipped, and an entry is written to the main log. This may be useful
19858 for mailing lists that are automatically managed. Otherwise, if an error is
19859 detected while generating the list of new addresses, the original address is
19860 deferred. See also &%syntax_errors_to%&.
19861
19862
19863
19864 .section "Private options for the redirect router" "SECID130"
19865
19866 .cindex "options" "&(redirect)& router"
19867 The private options for the &(redirect)& router are as follows:
19868
19869
19870 .option allow_defer redirect boolean false
19871 Setting this option allows the use of &':defer:'& in non-filter redirection
19872 data, or the &%defer%& command in an Exim filter file.
19873
19874
19875 .option allow_fail redirect boolean false
19876 .cindex "failing delivery" "from filter"
19877 If this option is true, the &':fail:'& item can be used in a redirection list,
19878 and the &%fail%& command may be used in an Exim filter file.
19879
19880
19881 .option allow_filter redirect boolean false
19882 .cindex "filter" "enabling use of"
19883 .cindex "Sieve filter" "enabling use of"
19884 Setting this option allows Exim to interpret redirection data that starts with
19885 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19886 are some features of Exim filter files that some administrators may wish to
19887 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19888
19889 It is also possible to lock out Exim filters or Sieve filters while allowing
19890 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19891
19892
19893 The filter is run using the uid and gid set by the generic &%user%& and
19894 &%group%& options. These take their defaults from the password data if
19895 &%check_local_user%& is set, so in the normal case of users' personal filter
19896 files, the filter is run as the relevant user. When &%allow_filter%& is set
19897 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19898
19899
19900
19901 .option allow_freeze redirect boolean false
19902 .cindex "freezing messages" "allowing in filter"
19903 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19904 This command is more normally encountered in system filters, and is disabled by
19905 default for redirection filters because it isn't something you usually want to
19906 let ordinary users do.
19907
19908
19909
19910 .option check_ancestor redirect boolean false
19911 This option is concerned with handling generated addresses that are the same
19912 as some address in the list of redirection ancestors of the current address.
19913 Although it is turned off by default in the code, it is set in the default
19914 configuration file for handling users' &_.forward_& files. It is recommended
19915 for this use of the &(redirect)& router.
19916
19917 When &%check_ancestor%& is set, if a generated address (including the domain)
19918 is the same as any ancestor of the current address, it is replaced by a copy of
19919 the current address. This helps in the case where local part A is aliased to B,
19920 and B has a &_.forward_& file pointing back to A. For example, within a single
19921 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19922 &_&~jb/.forward_& contains:
19923 .code
19924 \Joe.Bloggs, <other item(s)>
19925 .endd
19926 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19927 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19928 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19929 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19930 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19931 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19932 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19933 original address. See also the &%repeat_use%& option below.
19934
19935
19936 .option check_group redirect boolean "see below"
19937 When the &%file%& option is used, the group owner of the file is checked only
19938 when this option is set. The permitted groups are those listed in the
19939 &%owngroups%& option, together with the user's default group if
19940 &%check_local_user%& is set. If the file has the wrong group, routing is
19941 deferred. The default setting for this option is true if &%check_local_user%&
19942 is set and the &%modemask%& option permits the group write bit, or if the
19943 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19944
19945
19946
19947 .option check_owner redirect boolean "see below"
19948 When the &%file%& option is used, the owner of the file is checked only when
19949 this option is set. If &%check_local_user%& is set, the local user is
19950 permitted; otherwise the owner must be one of those listed in the &%owners%&
19951 option. The default value for this option is true if &%check_local_user%& or
19952 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19953
19954
19955 .option data redirect string&!! unset
19956 This option is mutually exclusive with &%file%&. One or other of them must be
19957 set, but not both. The contents of &%data%& are expanded, and then used as the
19958 list of forwarding items, or as a set of filtering instructions. If the
19959 expansion is forced to fail, or the result is an empty string or a string that
19960 has no effect (consists entirely of comments), the router declines.
19961
19962 When filtering instructions are used, the string must begin with &"#Exim
19963 filter"&, and all comments in the string, including this initial one, must be
19964 terminated with newline characters. For example:
19965 .code
19966 data = #Exim filter\n\
19967        if $h_to: contains Exim then save $home/mail/exim endif
19968 .endd
19969 If you are reading the data from a database where newlines cannot be included,
19970 you can use the &${sg}$& expansion item to turn the escape string of your
19971 choice into a newline.
19972
19973
19974 .option directory_transport redirect string&!! unset
19975 A &(redirect)& router sets up a direct delivery to a directory when a path name
19976 ending with a slash is specified as a new &"address"&. The transport used is
19977 specified by this option, which, after expansion, must be the name of a
19978 configured transport. This should normally be an &(appendfile)& transport.
19979
19980
19981 .option file redirect string&!! unset
19982 This option specifies the name of a file that contains the redirection data. It
19983 is mutually exclusive with the &%data%& option. The string is expanded before
19984 use; if the expansion is forced to fail, the router declines. Other expansion
19985 failures cause delivery to be deferred. The result of a successful expansion
19986 must be an absolute path. The entire file is read and used as the redirection
19987 data. If the data is an empty string or a string that has no effect (consists
19988 entirely of comments), the router declines.
19989
19990 .cindex "NFS" "checking for file existence"
19991 If the attempt to open the file fails with a &"does not exist"& error, Exim
19992 runs a check on the containing directory,
19993 unless &%ignore_enotdir%& is true (see below).
19994 If the directory does not appear to exist, delivery is deferred. This can
19995 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19996 is a mount problem. If the containing directory does exist, but the file does
19997 not, the router declines.
19998
19999
20000 .option file_transport redirect string&!! unset
20001 .vindex "&$address_file$&"
20002 A &(redirect)& router sets up a direct delivery to a file when a path name not
20003 ending in a slash is specified as a new &"address"&. The transport used is
20004 specified by this option, which, after expansion, must be the name of a
20005 configured transport. This should normally be an &(appendfile)& transport. When
20006 it is running, the file name is in &$address_file$&.
20007
20008
20009 .option filter_prepend_home redirect boolean true
20010 When this option is true, if a &(save)& command in an Exim filter specifies a
20011 relative path, and &$home$& is defined, it is automatically prepended to the
20012 relative path. If this option is set false, this action does not happen. The
20013 relative path is then passed to the transport unmodified.
20014
20015
20016 .option forbid_blackhole redirect boolean false
20017 If this option is true, the &':blackhole:'& item may not appear in a
20018 redirection list.
20019
20020
20021 .option forbid_exim_filter redirect boolean false
20022 If this option is set true, only Sieve filters are permitted when
20023 &%allow_filter%& is true.
20024
20025
20026
20027
20028 .option forbid_file redirect boolean false
20029 .cindex "delivery" "to file; forbidding"
20030 .cindex "Sieve filter" "forbidding delivery to a file"
20031 .cindex "Sieve filter" "&""keep""& facility; disabling"
20032 If this option is true, this router may not generate a new address that
20033 specifies delivery to a local file or directory, either from a filter or from a
20034 conventional forward file. This option is forced to be true if &%one_time%& is
20035 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20036 locks out the Sieve's &"keep"& facility.
20037
20038
20039 .option forbid_filter_dlfunc redirect boolean false
20040 .cindex "filter" "locking out certain features"
20041 If this option is true, string expansions in Exim filters are not allowed to
20042 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20043 functions.
20044
20045 .option forbid_filter_existstest redirect boolean false
20046 .cindex "expansion" "statting a file"
20047 If this option is true, string expansions in Exim filters are not allowed to
20048 make use of the &%exists%& condition or the &%stat%& expansion item.
20049
20050 .option forbid_filter_logwrite redirect boolean false
20051 If this option is true, use of the logging facility in Exim filters is not
20052 permitted. Logging is in any case available only if the filter is being run
20053 under some unprivileged uid (which is normally the case for ordinary users'
20054 &_.forward_& files).
20055
20056
20057 .option forbid_filter_lookup redirect boolean false
20058 If this option is true, string expansions in Exim filter files are not allowed
20059 to make use of &%lookup%& items.
20060
20061
20062 .option forbid_filter_perl redirect boolean false
20063 This option has an effect only if Exim is built with embedded Perl support. If
20064 it is true, string expansions in Exim filter files are not allowed to make use
20065 of the embedded Perl support.
20066
20067
20068 .option forbid_filter_readfile redirect boolean false
20069 If this option is true, string expansions in Exim filter files are not allowed
20070 to make use of &%readfile%& items.
20071
20072
20073 .option forbid_filter_readsocket redirect boolean false
20074 If this option is true, string expansions in Exim filter files are not allowed
20075 to make use of &%readsocket%& items.
20076
20077
20078 .option forbid_filter_reply redirect boolean false
20079 If this option is true, this router may not generate an automatic reply
20080 message. Automatic replies can be generated only from Exim or Sieve filter
20081 files, not from traditional forward files. This option is forced to be true if
20082 &%one_time%& is set.
20083
20084
20085 .option forbid_filter_run redirect boolean false
20086 If this option is true, string expansions in Exim filter files are not allowed
20087 to make use of &%run%& items.
20088
20089
20090 .option forbid_include redirect boolean false
20091 If this option is true, items of the form
20092 .code
20093 :include:<path name>
20094 .endd
20095 are not permitted in non-filter redirection lists.
20096
20097
20098 .option forbid_pipe redirect boolean false
20099 .cindex "delivery" "to pipe; forbidding"
20100 If this option is true, this router may not generate a new address which
20101 specifies delivery to a pipe, either from an Exim filter or from a conventional
20102 forward file. This option is forced to be true if &%one_time%& is set.
20103
20104
20105 .option forbid_sieve_filter redirect boolean false
20106 If this option is set true, only Exim filters are permitted when
20107 &%allow_filter%& is true.
20108
20109
20110 .cindex "SMTP" "error codes"
20111 .option forbid_smtp_code redirect boolean false
20112 If this option is set true, any SMTP error codes that are present at the start
20113 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20114 the default codes (451 and 550, respectively) are always used.
20115
20116
20117
20118
20119 .option hide_child_in_errmsg redirect boolean false
20120 .cindex "bounce message" "redirection details; suppressing"
20121 If this option is true, it prevents Exim from quoting a child address if it
20122 generates a bounce or delay message for it. Instead it says &"an address
20123 generated from <&'the top level address'&>"&. Of course, this applies only to
20124 bounces generated locally. If a message is forwarded to another host, &'its'&
20125 bounce may well quote the generated address.
20126
20127
20128 .option ignore_eacces redirect boolean false
20129 .cindex "EACCES"
20130 If this option is set and an attempt to open a redirection file yields the
20131 EACCES error (permission denied), the &(redirect)& router behaves as if the
20132 file did not exist.
20133
20134
20135 .option ignore_enotdir redirect boolean false
20136 .cindex "ENOTDIR"
20137 If this option is set and an attempt to open a redirection file yields the
20138 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20139 router behaves as if the file did not exist.
20140
20141 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20142 router that has the &%file%& option set discovers that the file does not exist
20143 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20144 against unmounted NFS directories. If the parent can not be statted, delivery
20145 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20146 is set, because that option tells Exim to ignore &"something on the path is not
20147 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20148 that some operating systems give ENOENT where others give ENOTDIR.
20149
20150
20151
20152 .option include_directory redirect string unset
20153 If this option is set, the path names of any &':include:'& items in a
20154 redirection list must start with this directory.
20155
20156
20157 .option modemask redirect "octal integer" 022
20158 This specifies mode bits which must not be set for a file specified by the
20159 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20160
20161
20162 .option one_time redirect boolean false
20163 .cindex "one-time aliasing/forwarding expansion"
20164 .cindex "alias file" "one-time expansion"
20165 .cindex "forward file" "one-time expansion"
20166 .cindex "mailing lists" "one-time expansion"
20167 .cindex "address redirection" "one-time expansion"
20168 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20169 files each time it tries to deliver a message causes a problem when one or more
20170 of the generated addresses fails be delivered at the first attempt. The problem
20171 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20172 but of what happens when the redirection list changes during the time that the
20173 message is on Exim's queue. This is particularly true in the case of mailing
20174 lists, where new subscribers might receive copies of messages that were posted
20175 before they subscribed.
20176
20177 If &%one_time%& is set and any addresses generated by the router fail to
20178 deliver at the first attempt, the failing addresses are added to the message as
20179 &"top level"& addresses, and the parent address that generated them is marked
20180 &"delivered"&. Thus, redirection does not happen again at the next delivery
20181 attempt.
20182
20183 &*Warning 1*&: Any header line addition or removal that is specified by this
20184 router would be lost if delivery did not succeed at the first attempt. For this
20185 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20186 permitted when &%one_time%& is set.
20187
20188 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20189 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20190 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20191
20192 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20193 &%one_time%&.
20194
20195 The original top-level address is remembered with each of the generated
20196 addresses, and is output in any log messages. However, any intermediate parent
20197 addresses are not recorded. This makes a difference to the log only if
20198 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20199 typically be used for mailing lists, where there is normally just one level of
20200 expansion.
20201
20202
20203 .option owners redirect "string list" unset
20204 .cindex "ownership" "alias file"
20205 .cindex "ownership" "forward file"
20206 .cindex "alias file" "ownership"
20207 .cindex "forward file" "ownership"
20208 This specifies a list of permitted owners for the file specified by &%file%&.
20209 This list is in addition to the local user when &%check_local_user%& is set.
20210 See &%check_owner%& above.
20211
20212
20213 .option owngroups redirect "string list" unset
20214 This specifies a list of permitted groups for the file specified by &%file%&.
20215 The list is in addition to the local user's primary group when
20216 &%check_local_user%& is set. See &%check_group%& above.
20217
20218
20219 .option pipe_transport redirect string&!! unset
20220 .vindex "&$address_pipe$&"
20221 A &(redirect)& router sets up a direct delivery to a pipe when a string
20222 starting with a vertical bar character is specified as a new &"address"&. The
20223 transport used is specified by this option, which, after expansion, must be the
20224 name of a configured transport. This should normally be a &(pipe)& transport.
20225 When the transport is run, the pipe command is in &$address_pipe$&.
20226
20227
20228 .option qualify_domain redirect string&!! unset
20229 .vindex "&$qualify_recipient$&"
20230 If this option is set, and an unqualified address (one without a domain) is
20231 generated, and that address would normally be qualified by the global setting
20232 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20233 expanding this string. If the expansion fails, the router declines. If you want
20234 to revert to the default, you can have the expansion generate
20235 &$qualify_recipient$&.
20236
20237 This option applies to all unqualified addresses generated by Exim filters,
20238 but for traditional &_.forward_& files, it applies only to addresses that are
20239 not preceded by a backslash. Sieve filters cannot generate unqualified
20240 addresses.
20241
20242 .option qualify_preserve_domain redirect boolean false
20243 .cindex "domain" "in redirection; preserving"
20244 .cindex "preserving domain in redirection"
20245 .cindex "address redirection" "domain; preserving"
20246 If this option is set, the router's local &%qualify_domain%& option must not be
20247 set (a configuration error occurs if it is). If an unqualified address (one
20248 without a domain) is generated, it is qualified with the domain of the parent
20249 address (the immediately preceding ancestor) instead of the global
20250 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20251 this applies whether or not the address is preceded by a backslash.
20252
20253
20254 .option repeat_use redirect boolean true
20255 If this option is set false, the router is skipped for a child address that has
20256 any ancestor that was routed by this router. This test happens before any of
20257 the other preconditions are tested. Exim's default anti-looping rules skip
20258 only when the ancestor is the same as the current address. See also
20259 &%check_ancestor%& above and the generic &%redirect_router%& option.
20260
20261
20262 .option reply_transport redirect string&!! unset
20263 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20264 &%vacation%& command is used in a filter file. The transport used is specified
20265 by this option, which, after expansion, must be the name of a configured
20266 transport. This should normally be an &(autoreply)& transport. Other transports
20267 are unlikely to do anything sensible or useful.
20268
20269
20270 .option rewrite redirect boolean true
20271 .cindex "address redirection" "disabling rewriting"
20272 If this option is set false, addresses generated by the router are not
20273 subject to address rewriting. Otherwise, they are treated like new addresses
20274 and are rewritten according to the global rewriting rules.
20275
20276
20277 .option sieve_subaddress redirect string&!! unset
20278 The value of this option is passed to a Sieve filter to specify the
20279 :subaddress part of an address.
20280
20281 .option sieve_useraddress redirect string&!! unset
20282 The value of this option is passed to a Sieve filter to specify the :user part
20283 of an address. However, if it is unset, the entire original local part
20284 (including any prefix or suffix) is used for :user.
20285
20286
20287 .option sieve_vacation_directory redirect string&!! unset
20288 .cindex "Sieve filter" "vacation directory"
20289 To enable the &"vacation"& extension for Sieve filters, you must set
20290 &%sieve_vacation_directory%& to the directory where vacation databases are held
20291 (do not put anything else in that directory), and ensure that the
20292 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20293 needs their own directory; Exim will create it if necessary.
20294
20295
20296
20297 .option skip_syntax_errors redirect boolean false
20298 .cindex "forward file" "broken"
20299 .cindex "address redirection" "broken files"
20300 .cindex "alias file" "broken"
20301 .cindex "broken alias or forward files"
20302 .cindex "ignoring faulty addresses"
20303 .cindex "skipping faulty addresses"
20304 .cindex "error" "skipping bad syntax"
20305 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20306 non-filter redirection data are skipped, and each failing address is logged. If
20307 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20308 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20309 are expanded and placed at the head of the error message generated by
20310 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20311 be the same address as the generic &%errors_to%& option. The
20312 &%skip_syntax_errors%& option is often used when handling mailing lists.
20313
20314 If all the addresses in a redirection list are skipped because of syntax
20315 errors, the router declines to handle the original address, and it is passed to
20316 the following routers.
20317
20318 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20319 error in the filter causes filtering to be abandoned without any action being
20320 taken. The incident is logged, and the router declines to handle the address,
20321 so it is passed to the following routers.
20322
20323 .cindex "Sieve filter" "syntax errors in"
20324 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20325 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20326 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20327
20328 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20329 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20330 option, used with an address that does not get redirected, can be used to
20331 notify users of these errors, by means of a router like this:
20332 .code
20333 userforward:
20334   driver = redirect
20335   allow_filter
20336   check_local_user
20337   file = $home/.forward
20338   file_transport = address_file
20339   pipe_transport = address_pipe
20340   reply_transport = address_reply
20341   no_verify
20342   skip_syntax_errors
20343   syntax_errors_to = real-$local_part@$domain
20344   syntax_errors_text = \
20345    This is an automatically generated message. An error has\n\
20346    been found in your .forward file. Details of the error are\n\
20347    reported below. While this error persists, you will receive\n\
20348    a copy of this message for every message that is addressed\n\
20349    to you. If your .forward file is a filter file, or if it is\n\
20350    a non-filter file containing no valid forwarding addresses,\n\
20351    a copy of each incoming message will be put in your normal\n\
20352    mailbox. If a non-filter file contains at least one valid\n\
20353    forwarding address, forwarding to the valid addresses will\n\
20354    happen, and those will be the only deliveries that occur.
20355 .endd
20356 You also need a router to ensure that local addresses that are prefixed by
20357 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20358 put this immediately before the &(userforward)& router:
20359 .code
20360 real_localuser:
20361   driver = accept
20362   check_local_user
20363   local_part_prefix = real-
20364   transport = local_delivery
20365 .endd
20366 For security, it would probably be a good idea to restrict the use of this
20367 router to locally-generated messages, using a condition such as this:
20368 .code
20369   condition = ${if match {$sender_host_address}\
20370                          {\N^(|127\.0\.0\.1)$\N}}
20371 .endd
20372
20373
20374 .option syntax_errors_text redirect string&!! unset
20375 See &%skip_syntax_errors%& above.
20376
20377
20378 .option syntax_errors_to redirect string unset
20379 See &%skip_syntax_errors%& above.
20380 .ecindex IIDredrou1
20381 .ecindex IIDredrou2
20382
20383
20384
20385
20386
20387
20388 . ////////////////////////////////////////////////////////////////////////////
20389 . ////////////////////////////////////////////////////////////////////////////
20390
20391 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20392          "Environment for local transports"
20393 .scindex IIDenvlotra1 "local transports" "environment for"
20394 .scindex IIDenvlotra2 "environment for local transports"
20395 .scindex IIDenvlotra3 "transport" "local; environment for"
20396 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20397 transport can be thought of as similar to a pipe.) Exim always runs transports
20398 in subprocesses, under specified uids and gids. Typical deliveries to local
20399 mailboxes run under the uid and gid of the local user.
20400
20401 Exim also sets a specific current directory while running the transport; for
20402 some transports a home directory setting is also relevant. The &(pipe)&
20403 transport is the only one that sets up environment variables; see section
20404 &<<SECTpipeenv>>& for details.
20405
20406 The values used for the uid, gid, and the directories may come from several
20407 different places. In many cases, the router that handles the address associates
20408 settings with that address as a result of its &%check_local_user%&, &%group%&,
20409 or &%user%& options. However, values may also be given in the transport's own
20410 configuration, and these override anything that comes from the router.
20411
20412
20413
20414 .section "Concurrent deliveries" "SECID131"
20415 .cindex "concurrent deliveries"
20416 .cindex "simultaneous deliveries"
20417 If two different messages for the same local recipient arrive more or less
20418 simultaneously, the two delivery processes are likely to run concurrently. When
20419 the &(appendfile)& transport is used to write to a file, Exim applies locking
20420 rules to stop concurrent processes from writing to the same file at the same
20421 time.
20422
20423 However, when you use a &(pipe)& transport, it is up to you to arrange any
20424 locking that is needed. Here is a silly example:
20425 .code
20426 my_transport:
20427   driver = pipe
20428   command = /bin/sh -c 'cat >>/some/file'
20429 .endd
20430 This is supposed to write the message at the end of the file. However, if two
20431 messages arrive at the same time, the file will be scrambled. You can use the
20432 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20433 file using the same algorithm that Exim itself uses.
20434
20435
20436
20437
20438 .section "Uids and gids" "SECTenvuidgid"
20439 .cindex "local transports" "uid and gid"
20440 .cindex "transport" "local; uid and gid"
20441 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20442 overrides any group that the router set in the address, even if &%user%& is not
20443 set for the transport. This makes it possible, for example, to run local mail
20444 delivery under the uid of the recipient (set by the router), but in a special
20445 group (set by the transport). For example:
20446 .code
20447 # Routers ...
20448 # User/group are set by check_local_user in this router
20449 local_users:
20450   driver = accept
20451   check_local_user
20452   transport = group_delivery
20453
20454 # Transports ...
20455 # This transport overrides the group
20456 group_delivery:
20457   driver = appendfile
20458   file = /var/spool/mail/$local_part
20459   group = mail
20460 .endd
20461 If &%user%& is set for a transport, its value overrides what is set in the
20462 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20463 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20464 set.
20465
20466 .oindex "&%initgroups%&"
20467 When the uid is taken from the transport's configuration, the &[initgroups()]&
20468 function is called for the groups associated with that uid if the
20469 &%initgroups%& option is set for the transport. When the uid is not specified
20470 by the transport, but is associated with the address by a router, the option
20471 for calling &[initgroups()]& is taken from the router configuration.
20472
20473 .cindex "&(pipe)& transport" "uid for"
20474 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20475 is set and &%user%& is not set, the uid of the process that called Exim to
20476 receive the message is used, and if &%group%& is not set, the corresponding
20477 original gid is also used.
20478
20479 This is the detailed preference order for obtaining a gid; the first of the
20480 following that is set is used:
20481
20482 .ilist
20483 A &%group%& setting of the transport;
20484 .next
20485 A &%group%& setting of the router;
20486 .next
20487 A gid associated with a user setting of the router, either as a result of
20488 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20489 .next
20490 The group associated with a non-numeric &%user%& setting of the transport;
20491 .next
20492 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20493 the uid is the creator's uid;
20494 .next
20495 The Exim gid if the Exim uid is being used as a default.
20496 .endlist
20497
20498 If, for example, the user is specified numerically on the router and there are
20499 no group settings, no gid is available. In this situation, an error occurs.
20500 This is different for the uid, for which there always is an ultimate default.
20501 The first of the following that is set is used:
20502
20503 .ilist
20504 A &%user%& setting of the transport;
20505 .next
20506 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20507 .next
20508 A &%user%& setting of the router;
20509 .next
20510 A &%check_local_user%& setting of the router;
20511 .next
20512 The Exim uid.
20513 .endlist
20514
20515 Of course, an error will still occur if the uid that is chosen is on the
20516 &%never_users%& list.
20517
20518
20519
20520
20521
20522 .section "Current and home directories" "SECID132"
20523 .cindex "current directory for local transport"
20524 .cindex "home directory" "for local transport"
20525 .cindex "transport" "local; home directory for"
20526 .cindex "transport" "local; current directory for"
20527 Routers may set current and home directories for local transports by means of
20528 the &%transport_current_directory%& and &%transport_home_directory%& options.
20529 However, if the transport's &%current_directory%& or &%home_directory%& options
20530 are set, they override the router's values. In detail, the home directory
20531 for a local transport is taken from the first of these values that is set:
20532
20533 .ilist
20534 The &%home_directory%& option on the transport;
20535 .next
20536 The &%transport_home_directory%& option on the router;
20537 .next
20538 The password data if &%check_local_user%& is set on the router;
20539 .next
20540 The &%router_home_directory%& option on the router.
20541 .endlist
20542
20543 The current directory is taken from the first of these values that is set:
20544
20545 .ilist
20546 The &%current_directory%& option on the transport;
20547 .next
20548 The &%transport_current_directory%& option on the router.
20549 .endlist
20550
20551
20552 If neither the router nor the transport sets a current directory, Exim uses the
20553 value of the home directory, if it is set. Otherwise it sets the current
20554 directory to &_/_& before running a local transport.
20555
20556
20557
20558 .section "Expansion variables derived from the address" "SECID133"
20559 .vindex "&$domain$&"
20560 .vindex "&$local_part$&"
20561 .vindex "&$original_domain$&"
20562 Normally a local delivery is handling a single address, and in that case the
20563 variables such as &$domain$& and &$local_part$& are set during local
20564 deliveries. However, in some circumstances more than one address may be handled
20565 at once (for example, while writing batch SMTP for onward transmission by some
20566 other means). In this case, the variables associated with the local part are
20567 never set, &$domain$& is set only if all the addresses have the same domain,
20568 and &$original_domain$& is never set.
20569 .ecindex IIDenvlotra1
20570 .ecindex IIDenvlotra2
20571 .ecindex IIDenvlotra3
20572
20573
20574
20575
20576
20577
20578
20579 . ////////////////////////////////////////////////////////////////////////////
20580 . ////////////////////////////////////////////////////////////////////////////
20581
20582 .chapter "Generic options for transports" "CHAPtransportgeneric"
20583 .scindex IIDgenoptra1 "generic options" "transport"
20584 .scindex IIDgenoptra2 "options" "generic; for transports"
20585 .scindex IIDgenoptra3 "transport" "generic options for"
20586 The following generic options apply to all transports:
20587
20588
20589 .option body_only transports boolean false
20590 .cindex "transport" "body only"
20591 .cindex "message" "transporting body only"
20592 .cindex "body of message" "transporting"
20593 If this option is set, the message's headers are not transported. It is
20594 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20595 or &(pipe)& transports, the settings of &%message_prefix%& and
20596 &%message_suffix%& should be checked, because this option does not
20597 automatically suppress them.
20598
20599
20600 .option current_directory transports string&!! unset
20601 .cindex "transport" "current directory for"
20602 This specifies the current directory that is to be set while running the
20603 transport, overriding any value that may have been set by the router.
20604 If the expansion fails for any reason, including forced failure, an error is
20605 logged, and delivery is deferred.
20606
20607
20608 .option disable_logging transports boolean false
20609 If this option is set true, nothing is logged for any
20610 deliveries by the transport or for any
20611 transport errors. You should not set this option unless you really, really know
20612 what you are doing.
20613
20614
20615 .option debug_print transports string&!! unset
20616 .cindex "testing" "variables in drivers"
20617 If this option is set and debugging is enabled (see the &%-d%& command line
20618 option), the string is expanded and included in the debugging output when the
20619 transport is run.
20620 If expansion of the string fails, the error message is written to the debugging
20621 output, and Exim carries on processing.
20622 This facility is provided to help with checking out the values of variables and
20623 so on when debugging driver configurations. For example, if a &%headers_add%&
20624 option is not working properly, &%debug_print%& could be used to output the
20625 variables it references. A newline is added to the text if it does not end with
20626 one.
20627 The variables &$transport_name$& and &$router_name$& contain the name of the
20628 transport and the router that called it.
20629
20630 .option delivery_date_add transports boolean false
20631 .cindex "&'Delivery-date:'& header line"
20632 If this option is true, a &'Delivery-date:'& header is added to the message.
20633 This gives the actual time the delivery was made. As this is not a standard
20634 header, Exim has a configuration option (&%delivery_date_remove%&) which
20635 requests its removal from incoming messages, so that delivered messages can
20636 safely be resent to other recipients.
20637
20638
20639 .option driver transports string unset
20640 This specifies which of the available transport drivers is to be used.
20641 There is no default, and this option must be set for every transport.
20642
20643
20644 .option envelope_to_add transports boolean false
20645 .cindex "&'Envelope-to:'& header line"
20646 If this option is true, an &'Envelope-to:'& header is added to the message.
20647 This gives the original address(es) in the incoming envelope that caused this
20648 delivery to happen. More than one address may be present if the transport is
20649 configured to handle several addresses at once, or if more than one original
20650 address was redirected to the same final address. As this is not a standard
20651 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20652 its removal from incoming messages, so that delivered messages can safely be
20653 resent to other recipients.
20654
20655
20656 .option event_action transports string&!! unset
20657 .cindex events
20658 This option declares a string to be expanded for Exim's events mechanism.
20659 For details see &<<CHAPevents>>&.
20660 .wen
20661
20662
20663 .option group transports string&!! "Exim group"
20664 .cindex "transport" "group; specifying"
20665 This option specifies a gid for running the transport process, overriding any
20666 value that the router supplies, and also overriding any value associated with
20667 &%user%& (see below).
20668
20669
20670 .option headers_add transports list&!! unset
20671 .cindex "header lines" "adding in transport"
20672 .cindex "transport" "header lines; adding"
20673 This option specifies a list of text headers,
20674 newline-separated (by default, changeable in the usual way),
20675 which are (separately) expanded and added to the header
20676 portion of a message as it is transported, as described in section
20677 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20678 routers. If the result of the expansion is an empty string, or if the expansion
20679 is forced to fail, no action is taken. Other expansion failures are treated as
20680 errors and cause the delivery to be deferred.
20681
20682 Unlike most options, &%headers_add%& can be specified multiple times
20683 for a transport; all listed headers are added.
20684
20685
20686 .option headers_only transports boolean false
20687 .cindex "transport" "header lines only"
20688 .cindex "message" "transporting headers only"
20689 .cindex "header lines" "transporting"
20690 If this option is set, the message's body is not transported. It is mutually
20691 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20692 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20693 checked, since this option does not automatically suppress them.
20694
20695
20696 .option headers_remove transports list&!! unset
20697 .cindex "header lines" "removing"
20698 .cindex "transport" "header lines; removing"
20699 This option specifies a list of header names,
20700 colon-separated (by default, changeable in the usual way);
20701 these headers are omitted from the message as it is transported, as described
20702 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20703 routers.
20704 Each list item is separately expanded.
20705 If the result of the expansion is an empty string, or if the expansion
20706 is forced to fail, no action is taken. Other expansion failures are treated as
20707 errors and cause the delivery to be deferred.
20708
20709 Unlike most options, &%headers_remove%& can be specified multiple times
20710 for a router; all listed headers are removed.
20711
20712 &*Warning*&: Because of the separate expansion of the list items,
20713 items that contain a list separator must have it doubled.
20714 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20715
20716
20717
20718 .option headers_rewrite transports string unset
20719 .cindex "transport" "header lines; rewriting"
20720 .cindex "rewriting" "at transport time"
20721 This option allows addresses in header lines to be rewritten at transport time,
20722 that is, as the message is being copied to its destination. The contents of the
20723 option are a colon-separated list of rewriting rules. Each rule is in exactly
20724 the same form as one of the general rewriting rules that are applied when a
20725 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20726 example,
20727 .code
20728 headers_rewrite = a@b c@d f : \
20729                   x@y w@z
20730 .endd
20731 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20732 &'w@z'& in all address-bearing header lines. The rules are applied to the
20733 header lines just before they are written out at transport time, so they affect
20734 only those copies of the message that pass through the transport. However, only
20735 the message's original header lines, and any that were added by a system
20736 filter, are rewritten. If a router or transport adds header lines, they are not
20737 affected by this option. These rewriting rules are &'not'& applied to the
20738 envelope. You can change the return path using &%return_path%&, but you cannot
20739 change envelope recipients at this time.
20740
20741
20742 .option home_directory transports string&!! unset
20743 .cindex "transport" "home directory for"
20744 .vindex "&$home$&"
20745 This option specifies a home directory setting for a local transport,
20746 overriding any value that may be set by the router. The home directory is
20747 placed in &$home$& while expanding the transport's private options. It is also
20748 used as the current directory if no current directory is set by the
20749 &%current_directory%& option on the transport or the
20750 &%transport_current_directory%& option on the router. If the expansion fails
20751 for any reason, including forced failure, an error is logged, and delivery is
20752 deferred.
20753
20754
20755 .option initgroups transports boolean false
20756 .cindex "additional groups"
20757 .cindex "groups" "additional"
20758 .cindex "transport" "group; additional"
20759 If this option is true and the uid for the delivery process is provided by the
20760 transport, the &[initgroups()]& function is called when running the transport
20761 to ensure that any additional groups associated with the uid are set up.
20762
20763
20764 .new
20765 .option max_parallel transports integer&!! unset
20766 .cindex limit "transport parallelism"
20767 .cindex transport "parallel processes"
20768 .cindex transport "concurrency limit"
20769 .cindex "delivery" "parallelism for transport"
20770 If this option is set and expands to an integer greater than zero
20771 it limits the number of concurrent runs of the transport.
20772 The control does not apply to shadow transports.
20773
20774 .cindex "hints database" "transport concurrency control"
20775 Exim implements this control by means of a hints database in which a record is
20776 incremented whenever a transport process is beaing created. The record
20777 is decremented and possibly removed when the process terminates.
20778 Obviously there is scope for
20779 records to get left lying around if there is a system or program crash. To
20780 guard against this, Exim ignores any records that are more than six hours old.
20781
20782 If you use this option, you should also arrange to delete the
20783 relevant hints database whenever your system reboots. The names of the files
20784 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20785 may be one or two files, depending on the type of DBM in use. The same files
20786 are used for ETRN and smtp transport serialization.
20787 .wen
20788
20789
20790 .option message_size_limit transports string&!! 0
20791 .cindex "limit" "message size per transport"
20792 .cindex "size" "of message, limit"
20793 .cindex "transport" "message size; limiting"
20794 This option controls the size of messages passed through the transport. It is
20795 expanded before use; the result of the expansion must be a sequence of decimal
20796 digits, optionally followed by K or M. If the expansion fails for any reason,
20797 including forced failure, or if the result is not of the required form,
20798 delivery is deferred. If the value is greater than zero and the size of a
20799 message exceeds this limit, the address is failed. If there is any chance that
20800 the resulting bounce message could be routed to the same transport, you should
20801 ensure that &%return_size_limit%& is less than the transport's
20802 &%message_size_limit%&, as otherwise the bounce message will fail to get
20803 delivered.
20804
20805
20806
20807 .option rcpt_include_affixes transports boolean false
20808 .cindex "prefix" "for local part, including in envelope"
20809 .cindex "suffix for local part" "including in envelope"
20810 .cindex "local part" "prefix"
20811 .cindex "local part" "suffix"
20812 When this option is false (the default), and an address that has had any
20813 affixes (prefixes or suffixes) removed from the local part is delivered by any
20814 form of SMTP or LMTP, the affixes are not included. For example, if a router
20815 that contains
20816 .code
20817 local_part_prefix = *-
20818 .endd
20819 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20820 is delivered with
20821 .code
20822 RCPT TO:<xyz@some.domain>
20823 .endd
20824 This is also the case when an ACL-time callout is being used to verify a
20825 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20826 whole local part is included in the RCPT command. This option applies to BSMTP
20827 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20828 &(lmtp)& and &(smtp)& transports.
20829
20830
20831 .option retry_use_local_part transports boolean "see below"
20832 .cindex "hints database" "retry keys"
20833 When a delivery suffers a temporary failure, a retry record is created
20834 in Exim's hints database. For remote deliveries, the key for the retry record
20835 is based on the name and/or IP address of the failing remote host. For local
20836 deliveries, the key is normally the entire address, including both the local
20837 part and the domain. This is suitable for most common cases of local delivery
20838 temporary failure &-- for example, exceeding a mailbox quota should delay only
20839 deliveries to that mailbox, not to the whole domain.
20840
20841 However, in some special cases you may want to treat a temporary local delivery
20842 as a failure associated with the domain, and not with a particular local part.
20843 (For example, if you are storing all mail for some domain in files.) You can do
20844 this by setting &%retry_use_local_part%& false.
20845
20846 For all the local transports, its default value is true. For remote transports,
20847 the default value is false for tidiness, but changing the value has no effect
20848 on a remote transport in the current implementation.
20849
20850
20851 .option return_path transports string&!! unset
20852 .cindex "envelope sender"
20853 .cindex "transport" "return path; changing"
20854 .cindex "return path" "changing in transport"
20855 If this option is set, the string is expanded at transport time and replaces
20856 the existing return path (envelope sender) value in the copy of the message
20857 that is being delivered. An empty return path is permitted. This feature is
20858 designed for remote deliveries, where the value of this option is used in the
20859 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20860 only effect is to change the address that is placed in the &'Return-path:'&
20861 header line, if one is added to the message (see the next option).
20862
20863 &*Note:*& A changed return path is not logged unless you add
20864 &%return_path_on_delivery%& to the log selector.
20865
20866 .vindex "&$return_path$&"
20867 The expansion can refer to the existing value via &$return_path$&. This is
20868 either the message's envelope sender, or an address set by the
20869 &%errors_to%& option on a router. If the expansion is forced to fail, no
20870 replacement occurs; if it fails for another reason, delivery is deferred. This
20871 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20872 section &<<SECTverp>>&.
20873
20874 &*Note*&: If a delivery error is detected locally, including the case when a
20875 remote server rejects a message at SMTP time, the bounce message is not sent to
20876 the value of this option. It is sent to the previously set errors address.
20877 This defaults to the incoming sender address, but can be changed by setting
20878 &%errors_to%& in a router.
20879
20880
20881
20882 .option return_path_add transports boolean false
20883 .cindex "&'Return-path:'& header line"
20884 If this option is true, a &'Return-path:'& header is added to the message.
20885 Although the return path is normally available in the prefix line of BSD
20886 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20887 have easy access to it.
20888
20889 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20890 the delivery SMTP server makes the final delivery"&. This implies that this
20891 header should not be present in incoming messages. Exim has a configuration
20892 option, &%return_path_remove%&, which requests removal of this header from
20893 incoming messages, so that delivered messages can safely be resent to other
20894 recipients.
20895
20896
20897 .option shadow_condition transports string&!! unset
20898 See &%shadow_transport%& below.
20899
20900
20901 .option shadow_transport transports string unset
20902 .cindex "shadow transport"
20903 .cindex "transport" "shadow"
20904 A local transport may set the &%shadow_transport%& option to the name of
20905 another local transport. Shadow remote transports are not supported.
20906
20907 Whenever a delivery to the main transport succeeds, and either
20908 &%shadow_condition%& is unset, or its expansion does not result in the empty
20909 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20910 passed to the shadow transport, with the same delivery address or addresses. If
20911 expansion fails, no action is taken except that non-forced expansion failures
20912 cause a log line to be written.
20913
20914 The result of the shadow transport is discarded and does not affect the
20915 subsequent processing of the message. Only a single level of shadowing is
20916 provided; the &%shadow_transport%& option is ignored on any transport when it
20917 is running as a shadow. Options concerned with output from pipes are also
20918 ignored. The log line for the successful delivery has an item added on the end,
20919 of the form
20920 .code
20921 ST=<shadow transport name>
20922 .endd
20923 If the shadow transport did not succeed, the error message is put in
20924 parentheses afterwards. Shadow transports can be used for a number of different
20925 purposes, including keeping more detailed log information than Exim normally
20926 provides, and implementing automatic acknowledgment policies based on message
20927 headers that some sites insist on.
20928
20929
20930 .option transport_filter transports string&!! unset
20931 .cindex "transport" "filter"
20932 .cindex "filter" "transport filter"
20933 This option sets up a filtering (in the Unix shell sense) process for messages
20934 at transport time. It should not be confused with mail filtering as set up by
20935 individual users or via a system filter.
20936 .new
20937 If unset, or expanding to an empty string, no filtering is done.
20938 .wen
20939
20940 When the message is about to be written out, the command specified by
20941 &%transport_filter%& is started up in a separate, parallel process, and
20942 the entire message, including the header lines, is passed to it on its standard
20943 input (this in fact is done from a third process, to avoid deadlock). The
20944 command must be specified as an absolute path.
20945
20946 The lines of the message that are written to the transport filter are
20947 terminated by newline (&"\n"&). The message is passed to the filter before any
20948 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20949 lines beginning with a dot, and also before any processing implied by the
20950 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20951 &(pipe)& transports.
20952
20953 The standard error for the filter process is set to the same destination as its
20954 standard output; this is read and written to the message's ultimate
20955 destination. The process that writes the message to the filter, the
20956 filter itself, and the original process that reads the result and delivers it
20957 are all run in parallel, like a shell pipeline.
20958
20959 The filter can perform any transformations it likes, but of course should take
20960 care not to break RFC 2822 syntax. Exim does not check the result, except to
20961 test for a final newline when SMTP is in use. All messages transmitted over
20962 SMTP must end with a newline, so Exim supplies one if it is missing.
20963
20964 .cindex "content scanning" "per user"
20965 A transport filter can be used to provide content-scanning on a per-user basis
20966 at delivery time if the only required effect of the scan is to modify the
20967 message. For example, a content scan could insert a new header line containing
20968 a spam score. This could be interpreted by a filter in the user's MUA. It is
20969 not possible to discard a message at this stage.
20970
20971 .cindex "SMTP" "SIZE"
20972 A problem might arise if the filter increases the size of a message that is
20973 being sent down an SMTP connection. If the receiving SMTP server has indicated
20974 support for the SIZE parameter, Exim will have sent the size of the message
20975 at the start of the SMTP session. If what is actually sent is substantially
20976 more, the server might reject the message. This can be worked round by setting
20977 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20978 additions to the message, or to disable the use of SIZE altogether.
20979
20980 .vindex "&$pipe_addresses$&"
20981 The value of the &%transport_filter%& option is the command string for starting
20982 the filter, which is run directly from Exim, not under a shell. The string is
20983 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20984 Exim breaks it up into arguments and then expands each argument separately (see
20985 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20986 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20987 of arguments, one for each address that applies to this delivery. (This isn't
20988 an ideal name for this feature here, but as it was already implemented for the
20989 &(pipe)& transport, it seemed sensible not to change it.)
20990
20991 .vindex "&$host$&"
20992 .vindex "&$host_address$&"
20993 The expansion variables &$host$& and &$host_address$& are available when the
20994 transport is a remote one. They contain the name and IP address of the host to
20995 which the message is being sent. For example:
20996 .code
20997 transport_filter = /some/directory/transport-filter.pl \
20998   $host $host_address $sender_address $pipe_addresses
20999 .endd
21000
21001 Two problems arise if you want to use more complicated expansion items to
21002 generate transport filter commands, both of which due to the fact that the
21003 command is split up &'before'& expansion.
21004 .ilist
21005 If an expansion item contains white space, you must quote it, so that it is all
21006 part of the same command item. If the entire option setting is one such
21007 expansion item, you have to take care what kind of quoting you use. For
21008 example:
21009 .code
21010 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21011 .endd
21012 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21013 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21014 stripped by Exim when it read the option's value. When the value is used, if
21015 the single quotes were missing, the line would be split into two items,
21016 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21017 Exim tried to expand the first one.
21018 .next
21019 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21020 expansion cannot generate multiple arguments, or a command name followed by
21021 arguments. Consider this example:
21022 .code
21023 transport_filter = ${lookup{$host}lsearch{/a/file}\
21024                     {$value}{/bin/cat}}
21025 .endd
21026 The result of the lookup is interpreted as the name of the command, even
21027 if it contains white space. The simplest way round this is to use a shell:
21028 .code
21029 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21030                                {$value}{/bin/cat}}
21031 .endd
21032 .endlist
21033
21034 The filter process is run under the same uid and gid as the normal delivery.
21035 For remote deliveries this is the Exim uid/gid by default. The command should
21036 normally yield a zero return code. Transport filters are not supposed to fail.
21037 A non-zero code is taken to mean that the transport filter encountered some
21038 serious problem. Delivery of the message is deferred; the message remains on
21039 the queue and is tried again later. It is not possible to cause a message to be
21040 bounced from a transport filter.
21041
21042 If a transport filter is set on an autoreply transport, the original message is
21043 passed through the filter as it is being copied into the newly generated
21044 message, which happens if the &%return_message%& option is set.
21045
21046
21047 .option transport_filter_timeout transports time 5m
21048 .cindex "transport" "filter, timeout"
21049 When Exim is reading the output of a transport filter, it applies a timeout
21050 that can be set by this option. Exceeding the timeout is normally treated as a
21051 temporary delivery failure. However, if a transport filter is used with a
21052 &(pipe)& transport, a timeout in the transport filter is treated in the same
21053 way as a timeout in the pipe command itself. By default, a timeout is a hard
21054 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21055 becomes a temporary error.
21056
21057
21058 .option user transports string&!! "Exim user"
21059 .cindex "uid (user id)" "local delivery"
21060 .cindex "transport" "user, specifying"
21061 This option specifies the user under whose uid the delivery process is to be
21062 run, overriding any uid that may have been set by the router. If the user is
21063 given as a name, the uid is looked up from the password data, and the
21064 associated group is taken as the value of the gid to be used if the &%group%&
21065 option is not set.
21066
21067 For deliveries that use local transports, a user and group are normally
21068 specified explicitly or implicitly (for example, as a result of
21069 &%check_local_user%&) by the router or transport.
21070
21071 .cindex "hints database" "access by remote transport"
21072 For remote transports, you should leave this option unset unless you really are
21073 sure you know what you are doing. When a remote transport is running, it needs
21074 to be able to access Exim's hints databases, because each host may have its own
21075 retry data.
21076 .ecindex IIDgenoptra1
21077 .ecindex IIDgenoptra2
21078 .ecindex IIDgenoptra3
21079
21080
21081
21082
21083
21084
21085 . ////////////////////////////////////////////////////////////////////////////
21086 . ////////////////////////////////////////////////////////////////////////////
21087
21088 .chapter "Address batching in local transports" "CHAPbatching" &&&
21089          "Address batching"
21090 .cindex "transport" "local; address batching in"
21091 The only remote transport (&(smtp)&) is normally configured to handle more than
21092 one address at a time, so that when several addresses are routed to the same
21093 remote host, just one copy of the message is sent. Local transports, however,
21094 normally handle one address at a time. That is, a separate instance of the
21095 transport is run for each address that is routed to the transport. A separate
21096 copy of the message is delivered each time.
21097
21098 .cindex "batched local delivery"
21099 .oindex "&%batch_max%&"
21100 .oindex "&%batch_id%&"
21101 In special cases, it may be desirable to handle several addresses at once in a
21102 local transport, for example:
21103
21104 .ilist
21105 In an &(appendfile)& transport, when storing messages in files for later
21106 delivery by some other means, a single copy of the message with multiple
21107 recipients saves space.
21108 .next
21109 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21110 a single copy saves time, and is the normal way LMTP is expected to work.
21111 .next
21112 In a &(pipe)& transport, when passing the message
21113 to a scanner program or
21114 to some other delivery mechanism such as UUCP, multiple recipients may be
21115 acceptable.
21116 .endlist
21117
21118 These three local transports all have the same options for controlling multiple
21119 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21120 repeating the information for each transport, these options are described here.
21121
21122 The &%batch_max%& option specifies the maximum number of addresses that can be
21123 delivered together in a single run of the transport. Its default value is one
21124 (no batching). When more than one address is routed to a transport that has a
21125 &%batch_max%& value greater than one, the addresses are delivered in a batch
21126 (that is, in a single run of the transport with multiple recipients), subject
21127 to certain conditions:
21128
21129 .ilist
21130 .vindex "&$local_part$&"
21131 If any of the transport's options contain a reference to &$local_part$&, no
21132 batching is possible.
21133 .next
21134 .vindex "&$domain$&"
21135 If any of the transport's options contain a reference to &$domain$&, only
21136 addresses with the same domain are batched.
21137 .next
21138 .cindex "customizing" "batching condition"
21139 If &%batch_id%& is set, it is expanded for each address, and only those
21140 addresses with the same expanded value are batched. This allows you to specify
21141 customized batching conditions. Failure of the expansion for any reason,
21142 including forced failure, disables batching, but it does not stop the delivery
21143 from taking place.
21144 .next
21145 Batched addresses must also have the same errors address (where to send
21146 delivery errors), the same header additions and removals, the same user and
21147 group for the transport, and if a host list is present, the first host must
21148 be the same.
21149 .endlist
21150
21151 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21152 both when the file or pipe command is specified in the transport, and when it
21153 is specified by a &(redirect)& router, but all the batched addresses must of
21154 course be routed to the same file or pipe command. These two transports have an
21155 option called &%use_bsmtp%&, which causes them to deliver the message in
21156 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21157 &%check_string%& and &%escape_string%& options are forced to the values
21158 .code
21159 check_string = "."
21160 escape_string = ".."
21161 .endd
21162 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21163 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21164 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21165
21166 .cindex "&'Envelope-to:'& header line"
21167 If the generic &%envelope_to_add%& option is set for a batching transport, the
21168 &'Envelope-to:'& header that is added to the message contains all the addresses
21169 that are being processed together. If you are using a batching &(appendfile)&
21170 transport without &%use_bsmtp%&, the only way to preserve the recipient
21171 addresses is to set the &%envelope_to_add%& option.
21172
21173 .cindex "&(pipe)& transport" "with multiple addresses"
21174 .vindex "&$pipe_addresses$&"
21175 If you are using a &(pipe)& transport without BSMTP, and setting the
21176 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21177 the command. This is not a true variable; it is a bit of magic that causes each
21178 of the recipient addresses to be inserted into the command as a separate
21179 argument. This provides a way of accessing all the addresses that are being
21180 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21181 are specified by a &(redirect)& router.
21182
21183
21184
21185
21186 . ////////////////////////////////////////////////////////////////////////////
21187 . ////////////////////////////////////////////////////////////////////////////
21188
21189 .chapter "The appendfile transport" "CHAPappendfile"
21190 .scindex IIDapptra1 "&(appendfile)& transport"
21191 .scindex IIDapptra2 "transports" "&(appendfile)&"
21192 .cindex "directory creation"
21193 .cindex "creating directories"
21194 The &(appendfile)& transport delivers a message by appending it to an existing
21195 file, or by creating an entirely new file in a specified directory. Single
21196 files to which messages are appended can be in the traditional Unix mailbox
21197 format, or optionally in the MBX format supported by the Pine MUA and
21198 University of Washington IMAP daemon, &'inter alia'&. When each message is
21199 being delivered as a separate file, &"maildir"& format can optionally be used
21200 to give added protection against failures that happen part-way through the
21201 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21202 supported. For all file formats, Exim attempts to create as many levels of
21203 directory as necessary, provided that &%create_directory%& is set.
21204
21205 The code for the optional formats is not included in the Exim binary by
21206 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21207 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21208 included.
21209
21210 .cindex "quota" "system"
21211 Exim recognizes system quota errors, and generates an appropriate message. Exim
21212 also supports its own quota control within the transport, for use when the
21213 system facility is unavailable or cannot be used for some reason.
21214
21215 If there is an error while appending to a file (for example, quota exceeded or
21216 partition filled), Exim attempts to reset the file's length and last
21217 modification time back to what they were before. If there is an error while
21218 creating an entirely new file, the new file is removed.
21219
21220 Before appending to a file, a number of security checks are made, and the
21221 file is locked. A detailed description is given below, after the list of
21222 private options.
21223
21224 The &(appendfile)& transport is most commonly used for local deliveries to
21225 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21226 putting messages into files for remote delivery by some means other than Exim.
21227 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21228 option).
21229
21230
21231
21232 .section "The file and directory options" "SECTfildiropt"
21233 The &%file%& option specifies a single file, to which the message is appended;
21234 the &%directory%& option specifies a directory, in which a new file containing
21235 the message is created. Only one of these two options can be set, and for
21236 normal deliveries to mailboxes, one of them &'must'& be set.
21237
21238 .vindex "&$address_file$&"
21239 .vindex "&$local_part$&"
21240 However, &(appendfile)& is also used for delivering messages to files or
21241 directories whose names (or parts of names) are obtained from alias,
21242 forwarding, or filtering operations (for example, a &%save%& command in a
21243 user's Exim filter). When such a transport is running, &$local_part$& contains
21244 the local part that was aliased or forwarded, and &$address_file$& contains the
21245 name (or partial name) of the file or directory generated by the redirection
21246 operation. There are two cases:
21247
21248 .ilist
21249 If neither &%file%& nor &%directory%& is set, the redirection operation
21250 must specify an absolute path (one that begins with &`/`&). This is the most
21251 common case when users with local accounts use filtering to sort mail into
21252 different folders. See for example, the &(address_file)& transport in the
21253 default configuration. If the path ends with a slash, it is assumed to be the
21254 name of a directory. A delivery to a directory can also be forced by setting
21255 &%maildir_format%& or &%mailstore_format%&.
21256 .next
21257 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21258 used to determine the file or directory name for the delivery. Normally, the
21259 contents of &$address_file$& are used in some way in the string expansion.
21260 .endlist
21261
21262
21263 .cindex "Sieve filter" "configuring &(appendfile)&"
21264 .cindex "Sieve filter" "relative mailbox path handling"
21265 As an example of the second case, consider an environment where users do not
21266 have home directories. They may be permitted to use Exim filter commands of the
21267 form:
21268 .code
21269 save folder23
21270 .endd
21271 or Sieve filter commands of the form:
21272 .code
21273 require "fileinto";
21274 fileinto "folder23";
21275 .endd
21276 In this situation, the expansion of &%file%& or &%directory%& in the transport
21277 must transform the relative path into an appropriate absolute file name. In the
21278 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21279 is used as a result of a &"keep"& action in the filter. This example shows one
21280 way of handling this requirement:
21281 .code
21282 file = ${if eq{$address_file}{inbox} \
21283             {/var/mail/$local_part} \
21284             {${if eq{${substr_0_1:$address_file}}{/} \
21285                   {$address_file} \
21286                   {$home/mail/$address_file} \
21287             }} \
21288        }
21289 .endd
21290 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21291 location, absolute paths are used without change, and other folders are in the
21292 &_mail_& directory within the home directory.
21293
21294 &*Note 1*&: While processing an Exim filter, a relative path such as
21295 &_folder23_& is turned into an absolute path if a home directory is known to
21296 the router. In particular, this is the case if &%check_local_user%& is set. If
21297 you want to prevent this happening at routing time, you can set
21298 &%router_home_directory%& empty. This forces the router to pass the relative
21299 path to the transport.
21300
21301 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21302 the &%file%& or &%directory%& option is still used if it is set.
21303
21304
21305
21306
21307 .section "Private options for appendfile" "SECID134"
21308 .cindex "options" "&(appendfile)& transport"
21309
21310
21311
21312 .option allow_fifo appendfile boolean false
21313 .cindex "fifo (named pipe)"
21314 .cindex "named pipe (fifo)"
21315 .cindex "pipe" "named (fifo)"
21316 Setting this option permits delivery to named pipes (FIFOs) as well as to
21317 regular files. If no process is reading the named pipe at delivery time, the
21318 delivery is deferred.
21319
21320
21321 .option allow_symlink appendfile boolean false
21322 .cindex "symbolic link" "to mailbox"
21323 .cindex "mailbox" "symbolic link"
21324 By default, &(appendfile)& will not deliver if the path name for the file is
21325 that of a symbolic link. Setting this option relaxes that constraint, but there
21326 are security issues involved in the use of symbolic links. Be sure you know
21327 what you are doing if you set this. Details of exactly what this option affects
21328 are included in the discussion which follows this list of options.
21329
21330
21331 .option batch_id appendfile string&!! unset
21332 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21333 However, batching is automatically disabled for &(appendfile)& deliveries that
21334 happen as a result of forwarding or aliasing or other redirection directly to a
21335 file.
21336
21337
21338 .option batch_max appendfile integer 1
21339 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21340
21341
21342 .option check_group appendfile boolean false
21343 When this option is set, the group owner of the file defined by the &%file%&
21344 option is checked to see that it is the same as the group under which the
21345 delivery process is running. The default setting is false because the default
21346 file mode is 0600, which means that the group is irrelevant.
21347
21348
21349 .option check_owner appendfile boolean true
21350 When this option is set, the owner of the file defined by the &%file%& option
21351 is checked to ensure that it is the same as the user under which the delivery
21352 process is running.
21353
21354
21355 .option check_string appendfile string "see below"
21356 .cindex "&""From""& line"
21357 As &(appendfile)& writes the message, the start of each line is tested for
21358 matching &%check_string%&, and if it does, the initial matching characters are
21359 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21360 a literal string, not a regular expression, and the case of any letters it
21361 contains is significant.
21362
21363 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21364 are forced to &"."& and &".."& respectively, and any settings in the
21365 configuration are ignored. Otherwise, they default to &"From&~"& and
21366 &">From&~"& when the &%file%& option is set, and unset when any of the
21367 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21368
21369 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21370 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21371 &"From&~"& indicates the start of a new message. All four options need changing
21372 if another format is used. For example, to deliver to mailboxes in MMDF format:
21373 .cindex "MMDF format mailbox"
21374 .cindex "mailbox" "MMDF format"
21375 .code
21376 check_string = "\1\1\1\1\n"
21377 escape_string = "\1\1\1\1 \n"
21378 message_prefix = "\1\1\1\1\n"
21379 message_suffix = "\1\1\1\1\n"
21380 .endd
21381 .option create_directory appendfile boolean true
21382 .cindex "directory creation"
21383 When this option is true, Exim attempts to create any missing superior
21384 directories for the file that it is about to write. A created directory's mode
21385 is given by the &%directory_mode%& option.
21386
21387 The group ownership of a newly created directory is highly dependent on the
21388 operating system (and possibly the file system) that is being used. For
21389 example, in Solaris, if the parent directory has the setgid bit set, its group
21390 is propagated to the child; if not, the currently set group is used. However,
21391 in FreeBSD, the parent's group is always used.
21392
21393
21394
21395 .option create_file appendfile string anywhere
21396 This option constrains the location of files and directories that are created
21397 by this transport. It applies to files defined by the &%file%& option and
21398 directories defined by the &%directory%& option. In the case of maildir
21399 delivery, it applies to the top level directory, not the maildir directories
21400 beneath.
21401
21402 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21403 &"belowhome"&. In the second and third cases, a home directory must have been
21404 set for the transport. This option is not useful when an explicit file name is
21405 given for normal mailbox deliveries. It is intended for the case when file
21406 names are generated from users' &_.forward_& files. These are usually handled
21407 by an &(appendfile)& transport called &%address_file%&. See also
21408 &%file_must_exist%&.
21409
21410
21411 .option directory appendfile string&!! unset
21412 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21413 or &%directory%& must be set, unless the delivery is the direct result of a
21414 redirection (see section &<<SECTfildiropt>>&).
21415
21416 When &%directory%& is set, the string is expanded, and the message is delivered
21417 into a new file or files in or below the given directory, instead of being
21418 appended to a single mailbox file. A number of different formats are provided
21419 (see &%maildir_format%& and &%mailstore_format%&), and see section
21420 &<<SECTopdir>>& for further details of this form of delivery.
21421
21422
21423 .option directory_file appendfile string&!! "see below"
21424 .cindex "base62"
21425 .vindex "&$inode$&"
21426 When &%directory%& is set, but neither &%maildir_format%& nor
21427 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21428 whose name is obtained by expanding this string. The default value is:
21429 .code
21430 q${base62:$tod_epoch}-$inode
21431 .endd
21432 This generates a unique name from the current time, in base 62 form, and the
21433 inode of the file. The variable &$inode$& is available only when expanding this
21434 option.
21435
21436
21437 .option directory_mode appendfile "octal integer" 0700
21438 If &(appendfile)& creates any directories as a result of the
21439 &%create_directory%& option, their mode is specified by this option.
21440
21441
21442 .option escape_string appendfile string "see description"
21443 See &%check_string%& above.
21444
21445
21446 .option file appendfile string&!! unset
21447 This option is mutually exclusive with the &%directory%& option, but one of
21448 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21449 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21450 specifies a single file, to which the message is appended. One or more of
21451 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21452 &%file%&.
21453
21454 .cindex "NFS" "lock file"
21455 .cindex "locking files"
21456 .cindex "lock files"
21457 If you are using more than one host to deliver over NFS into the same
21458 mailboxes, you should always use lock files.
21459
21460 The string value is expanded for each delivery, and must yield an absolute
21461 path. The most common settings of this option are variations on one of these
21462 examples:
21463 .code
21464 file = /var/spool/mail/$local_part
21465 file = /home/$local_part/inbox
21466 file = $home/inbox
21467 .endd
21468 .cindex "&""sticky""& bit"
21469 In the first example, all deliveries are done into the same directory. If Exim
21470 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21471 create a file in the directory, so the &"sticky"& bit must be turned on for
21472 deliveries to be possible, or alternatively the &%group%& option can be used to
21473 run the delivery under a group id which has write access to the directory.
21474
21475
21476
21477 .option file_format appendfile string unset
21478 .cindex "file" "mailbox; checking existing format"
21479 This option requests the transport to check the format of an existing file
21480 before adding to it. The check consists of matching a specific string at the
21481 start of the file. The value of the option consists of an even number of
21482 colon-separated strings. The first of each pair is the test string, and the
21483 second is the name of a transport. If the transport associated with a matched
21484 string is not the current transport, control is passed over to the other
21485 transport. For example, suppose the standard &(local_delivery)& transport has
21486 this added to it:
21487 .code
21488 file_format = "From       : local_delivery :\
21489                \1\1\1\1\n : local_mmdf_delivery"
21490 .endd
21491 Mailboxes that begin with &"From"& are still handled by this transport, but if
21492 a mailbox begins with four binary ones followed by a newline, control is passed
21493 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21494 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21495 is assumed to match the current transport. If the start of a mailbox doesn't
21496 match any string, or if the transport named for a given string is not defined,
21497 delivery is deferred.
21498
21499
21500 .option file_must_exist appendfile boolean false
21501 If this option is true, the file specified by the &%file%& option must exist.
21502 A temporary error occurs if it does not, causing delivery to be deferred.
21503 If this option is false, the file is created if it does not exist.
21504
21505
21506 .option lock_fcntl_timeout appendfile time 0s
21507 .cindex "timeout" "mailbox locking"
21508 .cindex "mailbox" "locking, blocking and non-blocking"
21509 .cindex "locking files"
21510 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21511 when locking an open mailbox file. If the call fails, the delivery process
21512 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21513 Non-blocking calls are used so that the file is not kept open during the wait
21514 for the lock; the reason for this is to make it as safe as possible for
21515 deliveries over NFS in the case when processes might be accessing an NFS
21516 mailbox without using a lock file. This should not be done, but
21517 misunderstandings and hence misconfigurations are not unknown.
21518
21519 On a busy system, however, the performance of a non-blocking lock approach is
21520 not as good as using a blocking lock with a timeout. In this case, the waiting
21521 is done inside the system call, and Exim's delivery process acquires the lock
21522 and can proceed as soon as the previous lock holder releases it.
21523
21524 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21525 timeout, are used. There may still be some retrying: the maximum number of
21526 retries is
21527 .code
21528 (lock_retries * lock_interval) / lock_fcntl_timeout
21529 .endd
21530 rounded up to the next whole number. In other words, the total time during
21531 which &(appendfile)& is trying to get a lock is roughly the same, unless
21532 &%lock_fcntl_timeout%& is set very large.
21533
21534 You should consider setting this option if you are getting a lot of delayed
21535 local deliveries because of errors of the form
21536 .code
21537 failed to lock mailbox /some/file (fcntl)
21538 .endd
21539
21540 .option lock_flock_timeout appendfile time 0s
21541 This timeout applies to file locking when using &[flock()]& (see
21542 &%use_flock%&); the timeout operates in a similar manner to
21543 &%lock_fcntl_timeout%&.
21544
21545
21546 .option lock_interval appendfile time 3s
21547 This specifies the time to wait between attempts to lock the file. See below
21548 for details of locking.
21549
21550
21551 .option lock_retries appendfile integer 10
21552 This specifies the maximum number of attempts to lock the file. A value of zero
21553 is treated as 1. See below for details of locking.
21554
21555
21556 .option lockfile_mode appendfile "octal integer" 0600
21557 This specifies the mode of the created lock file, when a lock file is being
21558 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21559
21560
21561 .option lockfile_timeout appendfile time 30m
21562 .cindex "timeout" "mailbox locking"
21563 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21564 exists and is older than this value, it is assumed to have been left behind by
21565 accident, and Exim attempts to remove it.
21566
21567
21568 .option mailbox_filecount appendfile string&!! unset
21569 .cindex "mailbox" "specifying size of"
21570 .cindex "size" "of mailbox"
21571 If this option is set, it is expanded, and the result is taken as the current
21572 number of files in the mailbox. It must be a decimal number, optionally
21573 followed by K or M. This provides a way of obtaining this information from an
21574 external source that maintains the data.
21575
21576
21577 .option mailbox_size appendfile string&!! unset
21578 .cindex "mailbox" "specifying size of"
21579 .cindex "size" "of mailbox"
21580 If this option is set, it is expanded, and the result is taken as the current
21581 size the mailbox. It must be a decimal number, optionally followed by K or M.
21582 This provides a way of obtaining this information from an external source that
21583 maintains the data. This is likely to be helpful for maildir deliveries where
21584 it is computationally expensive to compute the size of a mailbox.
21585
21586
21587
21588 .option maildir_format appendfile boolean false
21589 .cindex "maildir format" "specifying"
21590 If this option is set with the &%directory%& option, the delivery is into a new
21591 file, in the &"maildir"& format that is used by other mail software. When the
21592 transport is activated directly from a &(redirect)& router (for example, the
21593 &(address_file)& transport in the default configuration), setting
21594 &%maildir_format%& causes the path received from the router to be treated as a
21595 directory, whether or not it ends with &`/`&. This option is available only if
21596 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21597 &<<SECTmaildirdelivery>>& below for further details.
21598
21599
21600 .option maildir_quota_directory_regex appendfile string "See below"
21601 .cindex "maildir format" "quota; directories included in"
21602 .cindex "quota" "maildir; directories included in"
21603 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21604 a regular expression for specifying directories, relative to the quota
21605 directory (see &%quota_directory%&), that should be included in the quota
21606 calculation. The default value is:
21607 .code
21608 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21609 .endd
21610 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21611 (directories whose names begin with a dot). If you want to exclude the
21612 &_Trash_&
21613 folder from the count (as some sites do), you need to change this setting to
21614 .code
21615 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21616 .endd
21617 This uses a negative lookahead in the regular expression to exclude the
21618 directory whose name is &_.Trash_&. When a directory is excluded from quota
21619 calculations, quota processing is bypassed for any messages that are delivered
21620 directly into that directory.
21621
21622
21623 .option maildir_retries appendfile integer 10
21624 This option specifies the number of times to retry when writing a file in
21625 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21626
21627
21628 .option maildir_tag appendfile string&!! unset
21629 This option applies only to deliveries in maildir format, and is described in
21630 section &<<SECTmaildirdelivery>>& below.
21631
21632
21633 .option maildir_use_size_file appendfile&!! boolean false
21634 .cindex "maildir format" "&_maildirsize_& file"
21635 The result of string expansion for this option must be a valid boolean value.
21636 If it is true, it enables support for &_maildirsize_& files. Exim
21637 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21638 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21639 value is zero. See &%maildir_quota_directory_regex%& above and section
21640 &<<SECTmaildirdelivery>>& below for further details.
21641
21642 .option maildirfolder_create_regex appendfile string unset
21643 .cindex "maildir format" "&_maildirfolder_& file"
21644 .cindex "&_maildirfolder_&, creating"
21645 The value of this option is a regular expression. If it is unset, it has no
21646 effect. Otherwise, before a maildir delivery takes place, the pattern is
21647 matched against the name of the maildir directory, that is, the directory
21648 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21649 delivery. If there is a match, Exim checks for the existence of a file called
21650 &_maildirfolder_& in the directory, and creates it if it does not exist.
21651 See section &<<SECTmaildirdelivery>>& for more details.
21652
21653
21654 .option mailstore_format appendfile boolean false
21655 .cindex "mailstore format" "specifying"
21656 If this option is set with the &%directory%& option, the delivery is into two
21657 new files in  &"mailstore"& format. The option is available only if
21658 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21659 below for further details.
21660
21661
21662 .option mailstore_prefix appendfile string&!! unset
21663 This option applies only to deliveries in mailstore format, and is described in
21664 section &<<SECTopdir>>& below.
21665
21666
21667 .option mailstore_suffix appendfile string&!! unset
21668 This option applies only to deliveries in mailstore format, and is described in
21669 section &<<SECTopdir>>& below.
21670
21671
21672 .option mbx_format appendfile boolean false
21673 .cindex "locking files"
21674 .cindex "file" "locking"
21675 .cindex "file" "MBX format"
21676 .cindex "MBX format, specifying"
21677 This option is available only if Exim has been compiled with SUPPORT_MBX
21678 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21679 the message is appended to the mailbox file in MBX format instead of
21680 traditional Unix format. This format is supported by Pine4 and its associated
21681 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21682
21683 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21684 automatically changed by the use of &%mbx_format%&. They should normally be set
21685 empty when using MBX format, so this option almost always appears in this
21686 combination:
21687 .code
21688 mbx_format = true
21689 message_prefix =
21690 message_suffix =
21691 .endd
21692 If none of the locking options are mentioned in the configuration,
21693 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21694 is possible to specify the other kinds of locking with &%mbx_format%&, but
21695 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21696 interworks with &'c-client'&, providing for shared access to the mailbox. It
21697 should not be used if any program that does not use this form of locking is
21698 going to access the mailbox, nor should it be used if the mailbox file is NFS
21699 mounted, because it works only when the mailbox is accessed from a single host.
21700
21701 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21702 the standard version of &'c-client'&, because as long as it has a mailbox open
21703 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21704 append messages to it.
21705
21706
21707 .option message_prefix appendfile string&!! "see below"
21708 .cindex "&""From""& line"
21709 The string specified here is expanded and output at the start of every message.
21710 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21711 in which case it is:
21712 .code
21713 message_prefix = "From ${if def:return_path{$return_path}\
21714   {MAILER-DAEMON}} $tod_bsdinbox\n"
21715 .endd
21716 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21717 &`\n`& to &`\r\n`& in &%message_prefix%&.
21718
21719 .option message_suffix appendfile string&!! "see below"
21720 The string specified here is expanded and output at the end of every message.
21721 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21722 in which case it is a single newline character. The suffix can be suppressed by
21723 setting
21724 .code
21725 message_suffix =
21726 .endd
21727 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21728 &`\n`& to &`\r\n`& in &%message_suffix%&.
21729
21730 .option mode appendfile "octal integer" 0600
21731 If the output file is created, it is given this mode. If it already exists and
21732 has wider permissions, they are reduced to this mode. If it has narrower
21733 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21734 if the delivery is the result of a &%save%& command in a filter file specifying
21735 a particular mode, the mode of the output file is always forced to take that
21736 value, and this option is ignored.
21737
21738
21739 .option mode_fail_narrower appendfile boolean true
21740 This option applies in the case when an existing mailbox file has a narrower
21741 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21742 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21743 continues with the delivery attempt, using the existing mode of the file.
21744
21745
21746 .option notify_comsat appendfile boolean false
21747 If this option is true, the &'comsat'& daemon is notified after every
21748 successful delivery to a user mailbox. This is the daemon that notifies logged
21749 on users about incoming mail.
21750
21751
21752 .option quota appendfile string&!! unset
21753 .cindex "quota" "imposed by Exim"
21754 This option imposes a limit on the size of the file to which Exim is appending,
21755 or to the total space used in the directory tree when the &%directory%& option
21756 is set. In the latter case, computation of the space used is expensive, because
21757 all the files in the directory (and any sub-directories) have to be
21758 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21759 &%maildir_use_size_file%& for ways to avoid this in environments where users
21760 have no shell access to their mailboxes).
21761
21762 As there is no interlock against two simultaneous deliveries into a
21763 multi-file mailbox, it is possible for the quota to be overrun in this case.
21764 For single-file mailboxes, of course, an interlock is a necessity.
21765
21766 A file's size is taken as its &'used'& value. Because of blocking effects, this
21767 may be a lot less than the actual amount of disk space allocated to the file.
21768 If the sizes of a number of files are being added up, the rounding effect can
21769 become quite noticeable, especially on systems that have large block sizes.
21770 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21771 the obvious value which users understand most easily.
21772
21773 The value of the option is expanded, and must then be a numerical value
21774 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21775 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21776 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21777 be handled.
21778
21779 &*Note*&: A value of zero is interpreted as &"no quota"&.
21780
21781 The expansion happens while Exim is running as root, before it changes uid for
21782 the delivery. This means that files that are inaccessible to the end user can
21783 be used to hold quota values that are looked up in the expansion. When delivery
21784 fails because this quota is exceeded, the handling of the error is as for
21785 system quota failures.
21786
21787 By default, Exim's quota checking mimics system quotas, and restricts the
21788 mailbox to the specified maximum size, though the value is not accurate to the
21789 last byte, owing to separator lines and additional headers that may get added
21790 during message delivery. When a mailbox is nearly full, large messages may get
21791 refused even though small ones are accepted, because the size of the current
21792 message is added to the quota when the check is made. This behaviour can be
21793 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21794 for exceeding the quota does not include the current message. Thus, deliveries
21795 continue until the quota has been exceeded; thereafter, no further messages are
21796 delivered. See also &%quota_warn_threshold%&.
21797
21798
21799 .option quota_directory appendfile string&!! unset
21800 This option defines the directory to check for quota purposes when delivering
21801 into individual files. The default is the delivery directory, or, if a file
21802 called &_maildirfolder_& exists in a maildir directory, the parent of the
21803 delivery directory.
21804
21805
21806 .option quota_filecount appendfile string&!! 0
21807 This option applies when the &%directory%& option is set. It limits the total
21808 number of files in the directory (compare the inode limit in system quotas). It
21809 can only be used if &%quota%& is also set. The value is expanded; an expansion
21810 failure causes delivery to be deferred. A value of zero is interpreted as
21811 &"no quota"&.
21812
21813
21814 .option quota_is_inclusive appendfile boolean true
21815 See &%quota%& above.
21816
21817
21818 .option quota_size_regex appendfile string unset
21819 This option applies when one of the delivery modes that writes a separate file
21820 for each message is being used. When Exim wants to find the size of one of
21821 these files in order to test the quota, it first checks &%quota_size_regex%&.
21822 If this is set to a regular expression that matches the file name, and it
21823 captures one string, that string is interpreted as a representation of the
21824 file's size. The value of &%quota_size_regex%& is not expanded.
21825
21826 This feature is useful only when users have no shell access to their mailboxes
21827 &-- otherwise they could defeat the quota simply by renaming the files. This
21828 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21829 the file length to the file name. For example:
21830 .code
21831 maildir_tag = ,S=$message_size
21832 quota_size_regex = ,S=(\d+)
21833 .endd
21834 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21835 number of lines in the message.
21836
21837 The regular expression should not assume that the length is at the end of the
21838 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21839 sometimes add other information onto the ends of message file names.
21840
21841 Section &<<SECID136>>& contains further information.
21842
21843
21844 .option quota_warn_message appendfile string&!! "see below"
21845 See below for the use of this option. If it is not set when
21846 &%quota_warn_threshold%& is set, it defaults to
21847 .code
21848 quota_warn_message = "\
21849   To: $local_part@$domain\n\
21850   Subject: Your mailbox\n\n\
21851   This message is automatically created \
21852   by mail delivery software.\n\n\
21853   The size of your mailbox has exceeded \
21854   a warning threshold that is\n\
21855   set by the system administrator.\n"
21856 .endd
21857
21858
21859 .option quota_warn_threshold appendfile string&!! 0
21860 .cindex "quota" "warning threshold"
21861 .cindex "mailbox" "size warning"
21862 .cindex "size" "of mailbox"
21863 This option is expanded in the same way as &%quota%& (see above). If the
21864 resulting value is greater than zero, and delivery of the message causes the
21865 size of the file or total space in the directory tree to cross the given
21866 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21867 may be specified as a percentage of it by following the value with a percent
21868 sign. For example:
21869 .code
21870 quota = 10M
21871 quota_warn_threshold = 75%
21872 .endd
21873 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21874 percent sign is ignored.
21875
21876 The warning message itself is specified by the &%quota_warn_message%& option,
21877 and it must start with a &'To:'& header line containing the recipient(s) of the
21878 warning message. These do not necessarily have to include the recipient(s) of
21879 the original message. A &'Subject:'& line should also normally be supplied. You
21880 can include any other header lines that you want. If you do not include a
21881 &'From:'& line, the default is:
21882 .code
21883 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21884 .endd
21885 .oindex &%errors_reply_to%&
21886 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21887 option.
21888
21889 The &%quota%& option does not have to be set in order to use this option; they
21890 are independent of one another except when the threshold is specified as a
21891 percentage.
21892
21893
21894 .option use_bsmtp appendfile boolean false
21895 .cindex "envelope sender"
21896 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21897 format, with the envelope sender and recipient(s) included as SMTP commands. If
21898 you want to include a leading HELO command with such messages, you can do
21899 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21900 for details of batch SMTP.
21901
21902
21903 .option use_crlf appendfile boolean false
21904 .cindex "carriage return"
21905 .cindex "linefeed"
21906 This option causes lines to be terminated with the two-character CRLF sequence
21907 (carriage return, linefeed) instead of just a linefeed character. In the case
21908 of batched SMTP, the byte sequence written to the file is then an exact image
21909 of what would be sent down a real SMTP connection.
21910
21911 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21912 (which are used to supply the traditional &"From&~"& and blank line separators
21913 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21914 carriage return characters if these are needed. In cases where these options
21915 have non-empty defaults, the values end with a single linefeed, so they must be
21916 changed to end with &`\r\n`& if &%use_crlf%& is set.
21917
21918
21919 .option use_fcntl_lock appendfile boolean "see below"
21920 This option controls the use of the &[fcntl()]& function to lock a file for
21921 exclusive use when a message is being appended. It is set by default unless
21922 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21923 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21924 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21925
21926
21927 .option use_flock_lock appendfile boolean false
21928 This option is provided to support the use of &[flock()]& for file locking, for
21929 the few situations where it is needed. Most modern operating systems support
21930 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21931 each other. Exim uses &[fcntl()]& locking by default.
21932
21933 This option is required only if you are using an operating system where
21934 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21935 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21936 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21937
21938 .cindex "Solaris" "&[flock()]& support"
21939 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21940 have it (and some, I think, provide a not quite right version built on top of
21941 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21942 the ability to use it, and any attempt to do so will cause a configuration
21943 error.
21944
21945 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21946 is just being mapped onto &[fcntl()]& by the OS).
21947
21948
21949 .option use_lockfile appendfile boolean "see below"
21950 If this option is turned off, Exim does not attempt to create a lock file when
21951 appending to a mailbox file. In this situation, the only locking is by
21952 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21953 sure that every MUA that is ever going to look at your users' mailboxes uses
21954 &[fcntl()]& rather than a lock file, and even then only when you are not
21955 delivering over NFS from more than one host.
21956
21957 .cindex "NFS" "lock file"
21958 In order to append to an NFS file safely from more than one host, it is
21959 necessary to take out a lock &'before'& opening the file, and the lock file
21960 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21961 file corruption.
21962
21963 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21964 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21965 except when &%mbx_format%& is set.
21966
21967
21968 .option use_mbx_lock appendfile boolean "see below"
21969 This option is available only if Exim has been compiled with SUPPORT_MBX
21970 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21971 locking rules be used. It is set by default if &%mbx_format%& is set and none
21972 of the locking options are mentioned in the configuration. The locking rules
21973 are the same as are used by the &'c-client'& library that underlies Pine and
21974 the IMAP4 and POP daemons that come with it (see the discussion below). The
21975 rules allow for shared access to the mailbox. However, this kind of locking
21976 does not work when the mailbox is NFS mounted.
21977
21978 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21979 &%use_flock_lock%& to control what kind of locking is used in implementing the
21980 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21981 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21982
21983
21984
21985
21986 .section "Operational details for appending" "SECTopappend"
21987 .cindex "appending to a file"
21988 .cindex "file" "appending"
21989 Before appending to a file, the following preparations are made:
21990
21991 .ilist
21992 If the name of the file is &_/dev/null_&, no action is taken, and a success
21993 return is given.
21994
21995 .next
21996 .cindex "directory creation"
21997 If any directories on the file's path are missing, Exim creates them if the
21998 &%create_directory%& option is set. A created directory's mode is given by the
21999 &%directory_mode%& option.
22000
22001 .next
22002 If &%file_format%& is set, the format of an existing file is checked. If this
22003 indicates that a different transport should be used, control is passed to that
22004 transport.
22005
22006 .next
22007 .cindex "file" "locking"
22008 .cindex "locking files"
22009 .cindex "NFS" "lock file"
22010 If &%use_lockfile%& is set, a lock file is built in a way that will work
22011 reliably over NFS, as follows:
22012
22013 .olist
22014 Create a &"hitching post"& file whose name is that of the lock file with the
22015 current time, primary host name, and process id added, by opening for writing
22016 as a new file. If this fails with an access error, delivery is deferred.
22017 .next
22018 Close the hitching post file, and hard link it to the lock file name.
22019 .next
22020 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22021 Unlink the hitching post name.
22022 .next
22023 Otherwise, use &[stat()]& to get information about the hitching post file, and
22024 then unlink hitching post name. If the number of links is exactly two, creation
22025 of the lock file succeeded but something (for example, an NFS server crash and
22026 restart) caused this fact not to be communicated to the &[link()]& call.
22027 .next
22028 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22029 up to &%lock_retries%& times. However, since any program that writes to a
22030 mailbox should complete its task very quickly, it is reasonable to time out old
22031 lock files that are normally the result of user agent and system crashes. If an
22032 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22033 it before trying again.
22034 .endlist olist
22035
22036 .next
22037 A call is made to &[lstat()]& to discover whether the main file exists, and if
22038 so, what its characteristics are. If &[lstat()]& fails for any reason other
22039 than non-existence, delivery is deferred.
22040
22041 .next
22042 .cindex "symbolic link" "to mailbox"
22043 .cindex "mailbox" "symbolic link"
22044 If the file does exist and is a symbolic link, delivery is deferred, unless the
22045 &%allow_symlink%& option is set, in which case the ownership of the link is
22046 checked, and then &[stat()]& is called to find out about the real file, which
22047 is then subjected to the checks below. The check on the top-level link
22048 ownership prevents one user creating a link for another's mailbox in a sticky
22049 directory, though allowing symbolic links in this case is definitely not a good
22050 idea. If there is a chain of symbolic links, the intermediate ones are not
22051 checked.
22052
22053 .next
22054 If the file already exists but is not a regular file, or if the file's owner
22055 and group (if the group is being checked &-- see &%check_group%& above) are
22056 different from the user and group under which the delivery is running,
22057 delivery is deferred.
22058
22059 .next
22060 If the file's permissions are more generous than specified, they are reduced.
22061 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22062 is set false, in which case the delivery is tried using the existing
22063 permissions.
22064
22065 .next
22066 The file's inode number is saved, and the file is then opened for appending.
22067 If this fails because the file has vanished, &(appendfile)& behaves as if it
22068 hadn't existed (see below). For any other failures, delivery is deferred.
22069
22070 .next
22071 If the file is opened successfully, check that the inode number hasn't
22072 changed, that it is still a regular file, and that the owner and permissions
22073 have not changed. If anything is wrong, defer delivery and freeze the message.
22074
22075 .next
22076 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22077 option is set. Otherwise, check that the file is being created in a permitted
22078 directory if the &%create_file%& option is set (deferring on failure), and then
22079 open for writing as a new file, with the O_EXCL and O_CREAT options,
22080 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22081 set). In this case, which can happen if the link points to a non-existent file,
22082 the file is opened for writing using O_CREAT but not O_EXCL, because
22083 that prevents link following.
22084
22085 .next
22086 .cindex "loop" "while file testing"
22087 If opening fails because the file exists, obey the tests given above for
22088 existing files. However, to avoid looping in a situation where the file is
22089 being continuously created and destroyed, the exists/not-exists loop is broken
22090 after 10 repetitions, and the message is then frozen.
22091
22092 .next
22093 If opening fails with any other error, defer delivery.
22094
22095 .next
22096 .cindex "file" "locking"
22097 .cindex "locking files"
22098 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22099 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22100 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22101 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22102 file, and an exclusive lock on the file whose name is
22103 .code
22104 /tmp/.<device-number>.<inode-number>
22105 .endd
22106 using the device and inode numbers of the open mailbox file, in accordance with
22107 the MBX locking rules. This file is created with a mode that is specified by
22108 the &%lockfile_mode%& option.
22109
22110 If Exim fails to lock the file, there are two possible courses of action,
22111 depending on the value of the locking timeout. This is obtained from
22112 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22113
22114 If the timeout value is zero, the file is closed, Exim waits for
22115 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22116 to lock it again. This happens up to &%lock_retries%& times, after which the
22117 delivery is deferred.
22118
22119 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22120 &[flock()]& are used (with the given timeout), so there has already been some
22121 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22122 immediately. It retries up to
22123 .code
22124 (lock_retries * lock_interval) / <timeout>
22125 .endd
22126 times (rounded up).
22127 .endlist
22128
22129 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22130 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22131
22132
22133 .section "Operational details for delivery to a new file" "SECTopdir"
22134 .cindex "delivery" "to single file"
22135 .cindex "&""From""& line"
22136 When the &%directory%& option is set instead of &%file%&, each message is
22137 delivered into a newly-created file or set of files. When &(appendfile)& is
22138 activated directly from a &(redirect)& router, neither &%file%& nor
22139 &%directory%& is normally set, because the path for delivery is supplied by the
22140 router. (See for example, the &(address_file)& transport in the default
22141 configuration.) In this case, delivery is to a new file if either the path name
22142 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22143
22144 No locking is required while writing the message to a new file, so the various
22145 locking options of the transport are ignored. The &"From"& line that by default
22146 separates messages in a single file is not normally needed, nor is the escaping
22147 of message lines that start with &"From"&, and there is no need to ensure a
22148 newline at the end of each message. Consequently, the default values for
22149 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22150 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22151
22152 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22153 the files in the delivery directory by default. However, you can specify a
22154 different directory by setting &%quota_directory%&. Also, for maildir
22155 deliveries (see below) the &_maildirfolder_& convention is honoured.
22156
22157
22158 .cindex "maildir format"
22159 .cindex "mailstore format"
22160 There are three different ways in which delivery to individual files can be
22161 done, controlled by the settings of the &%maildir_format%& and
22162 &%mailstore_format%& options. Note that code to support maildir or mailstore
22163 formats is not included in the binary unless SUPPORT_MAILDIR or
22164 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22165
22166 .cindex "directory creation"
22167 In all three cases an attempt is made to create the directory and any necessary
22168 sub-directories if they do not exist, provided that the &%create_directory%&
22169 option is set (the default). The location of a created directory can be
22170 constrained by setting &%create_file%&. A created directory's mode is given by
22171 the &%directory_mode%& option. If creation fails, or if the
22172 &%create_directory%& option is not set when creation is required, delivery is
22173 deferred.
22174
22175
22176
22177 .section "Maildir delivery" "SECTmaildirdelivery"
22178 .cindex "maildir format" "description of"
22179 If the &%maildir_format%& option is true, Exim delivers each message by writing
22180 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22181 directory that is defined by the &%directory%& option (the &"delivery
22182 directory"&). If the delivery is successful, the file is renamed into the
22183 &_new_& subdirectory.
22184
22185 In the file name, <&'stime'&> is the current time of day in seconds, and
22186 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22187 Exim checks that the time-of-day clock has moved on by at least one microsecond
22188 before terminating the delivery process. This guarantees uniqueness for the
22189 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22190 opening it. If any response other than ENOENT (does not exist) is given,
22191 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22192
22193 Before Exim carries out a maildir delivery, it ensures that subdirectories
22194 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22195 do not exist, Exim tries to create them and any superior directories in their
22196 path, subject to the &%create_directory%& and &%create_file%& options. If the
22197 &%maildirfolder_create_regex%& option is set, and the regular expression it
22198 contains matches the delivery directory, Exim also ensures that a file called
22199 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22200 &_maildirfolder_& file cannot be created, delivery is deferred.
22201
22202 These features make it possible to use Exim to create all the necessary files
22203 and directories in a maildir mailbox, including subdirectories for maildir++
22204 folders. Consider this example:
22205 .code
22206 maildir_format = true
22207 directory = /var/mail/$local_part\
22208            ${if eq{$local_part_suffix}{}{}\
22209            {/.${substr_1:$local_part_suffix}}}
22210 maildirfolder_create_regex = /\.[^/]+$
22211 .endd
22212 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22213 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22214 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22215 not match this name, so Exim will not look for or create the file
22216 &_/var/mail/pimbo/maildirfolder_&, though it will create
22217 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22218
22219 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22220 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22221 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22222 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22223 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22224
22225 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22226 not inadvertently match the toplevel maildir directory, because a
22227 &_maildirfolder_& file at top level would completely break quota calculations.
22228
22229 .cindex "quota" "in maildir delivery"
22230 .cindex "maildir++"
22231 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22232 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22233 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22234 Exim assumes the directory is a maildir++ folder directory, which is one level
22235 down from the user's top level mailbox directory. This causes it to start at
22236 the parent directory instead of the current directory when calculating the
22237 amount of space used.
22238
22239 One problem with delivering into a multi-file mailbox is that it is
22240 computationally expensive to compute the size of the mailbox for quota
22241 checking. Various approaches have been taken to reduce the amount of work
22242 needed. The next two sections describe two of them. A third alternative is to
22243 use some external process for maintaining the size data, and use the expansion
22244 of the &%mailbox_size%& option as a way of importing it into Exim.
22245
22246
22247
22248
22249 .section "Using tags to record message sizes" "SECID135"
22250 If &%maildir_tag%& is set, the string is expanded for each delivery.
22251 When the maildir file is renamed into the &_new_& sub-directory, the
22252 tag is added to its name. However, if adding the tag takes the length of the
22253 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22254 the tag is dropped and the maildir file is created with no tag.
22255
22256
22257 .vindex "&$message_size$&"
22258 Tags can be used to encode the size of files in their names; see
22259 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22260 happens after the message has been written. The value of the &$message_size$&
22261 variable is set to the number of bytes actually written. If the expansion is
22262 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22263 be deferred. The expanded tag may contain any printing characters except &"/"&.
22264 Non-printing characters in the string are ignored; if the resulting string is
22265 empty, it is ignored. If it starts with an alphanumeric character, a leading
22266 colon is inserted; this default has not proven to be the path that popular
22267 maildir implementations have chosen (but changing it in Exim would break
22268 backwards compatibility).
22269
22270 For one common implementation, you might set:
22271 .code
22272 maildir_tag = ,S=${message_size}
22273 .endd
22274 but you should check the documentation of the other software to be sure.
22275
22276 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22277 as this allows Exim to extract the size from your tag, instead of having to
22278 &[stat()]& each message file.
22279
22280
22281 .section "Using a maildirsize file" "SECID136"
22282 .cindex "quota" "in maildir delivery"
22283 .cindex "maildir format" "&_maildirsize_& file"
22284 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22285 storing quota and message size information in a file called &_maildirsize_&
22286 within the toplevel maildir directory. If this file does not exist, Exim
22287 creates it, setting the quota from the &%quota%& option of the transport. If
22288 the maildir directory itself does not exist, it is created before any attempt
22289 to write a &_maildirsize_& file.
22290
22291 The &_maildirsize_& file is used to hold information about the sizes of
22292 messages in the maildir, thus speeding up quota calculations. The quota value
22293 in the file is just a cache; if the quota is changed in the transport, the new
22294 value overrides the cached value when the next message is delivered. The cache
22295 is maintained for the benefit of other programs that access the maildir and
22296 need to know the quota.
22297
22298 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22299 file is maintained (with a zero quota setting), but no quota is imposed.
22300
22301 A regular expression is available for controlling which directories in the
22302 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22303 See the description of the &%maildir_quota_directory_regex%& option above for
22304 details.
22305
22306
22307 .section "Mailstore delivery" "SECID137"
22308 .cindex "mailstore format" "description of"
22309 If the &%mailstore_format%& option is true, each message is written as two
22310 files in the given directory. A unique base name is constructed from the
22311 message id and the current delivery process, and the files that are written use
22312 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22313 contains the message's envelope, and the &_.msg_& file contains the message
22314 itself. The base name is placed in the variable &$mailstore_basename$&.
22315
22316 During delivery, the envelope is first written to a file with the suffix
22317 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22318 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22319 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22320 file before accessing either of them. An alternative approach is to wait for
22321 the absence of a &_.tmp_& file.
22322
22323 The envelope file starts with any text defined by the &%mailstore_prefix%&
22324 option, expanded and terminated by a newline if there isn't one. Then follows
22325 the sender address on one line, then all the recipient addresses, one per line.
22326 There can be more than one recipient only if the &%batch_max%& option is set
22327 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22328 appended to the file, followed by a newline if it does not end with one.
22329
22330 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22331 failure, it is ignored. Other expansion errors are treated as serious
22332 configuration errors, and delivery is deferred. The variable
22333 &$mailstore_basename$& is available for use during these expansions.
22334
22335
22336 .section "Non-special new file delivery" "SECID138"
22337 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22338 file is created directly in the named directory. For example, when delivering
22339 messages into files in batched SMTP format for later delivery to some host (see
22340 section &<<SECTbatchSMTP>>&), a setting such as
22341 .code
22342 directory = /var/bsmtp/$host
22343 .endd
22344 might be used. A message is written to a file with a temporary name, which is
22345 then renamed when the delivery is complete. The final name is obtained by
22346 expanding the contents of the &%directory_file%& option.
22347 .ecindex IIDapptra1
22348 .ecindex IIDapptra2
22349
22350
22351
22352
22353
22354
22355 . ////////////////////////////////////////////////////////////////////////////
22356 . ////////////////////////////////////////////////////////////////////////////
22357
22358 .chapter "The autoreply transport" "CHID8"
22359 .scindex IIDauttra1 "transports" "&(autoreply)&"
22360 .scindex IIDauttra2 "&(autoreply)& transport"
22361 The &(autoreply)& transport is not a true transport in that it does not cause
22362 the message to be transmitted. Instead, it generates a new mail message as an
22363 automatic reply to the incoming message. &'References:'& and
22364 &'Auto-Submitted:'& header lines are included. These are constructed according
22365 to the rules in RFCs 2822 and 3834, respectively.
22366
22367 If the router that passes the message to this transport does not have the
22368 &%unseen%& option set, the original message (for the current recipient) is not
22369 delivered anywhere. However, when the &%unseen%& option is set on the router
22370 that passes the message to this transport, routing of the address continues, so
22371 another router can set up a normal message delivery.
22372
22373
22374 The &(autoreply)& transport is usually run as the result of mail filtering, a
22375 &"vacation"& message being the standard example. However, it can also be run
22376 directly from a router like any other transport. To reduce the possibility of
22377 message cascades, messages created by the &(autoreply)& transport always have
22378 empty envelope sender addresses, like bounce messages.
22379
22380 The parameters of the message to be sent can be specified in the configuration
22381 by options described below. However, these are used only when the address
22382 passed to the transport does not contain its own reply information. When the
22383 transport is run as a consequence of a
22384 &%mail%&
22385 or &%vacation%& command in a filter file, the parameters of the message are
22386 supplied by the filter, and passed with the address. The transport's options
22387 that define the message are then ignored (so they are not usually set in this
22388 case). The message is specified entirely by the filter or by the transport; it
22389 is never built from a mixture of options. However, the &%file_optional%&,
22390 &%mode%&, and &%return_message%& options apply in all cases.
22391
22392 &(Autoreply)& is implemented as a local transport. When used as a result of a
22393 command in a user's filter file, &(autoreply)& normally runs under the uid and
22394 gid of the user, and with appropriate current and home directories (see chapter
22395 &<<CHAPenvironment>>&).
22396
22397 There is a subtle difference between routing a message to a &(pipe)& transport
22398 that generates some text to be returned to the sender, and routing it to an
22399 &(autoreply)& transport. This difference is noticeable only if more than one
22400 address from the same message is so handled. In the case of a pipe, the
22401 separate outputs from the different addresses are gathered up and returned to
22402 the sender in a single message, whereas if &(autoreply)& is used, a separate
22403 message is generated for each address that is passed to it.
22404
22405 Non-printing characters are not permitted in the header lines generated for the
22406 message that &(autoreply)& creates, with the exception of newlines that are
22407 immediately followed by white space. If any non-printing characters are found,
22408 the transport defers.
22409 Whether characters with the top bit set count as printing characters or not is
22410 controlled by the &%print_topbitchars%& global option.
22411
22412 If any of the generic options for manipulating headers (for example,
22413 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22414 of the original message that is included in the generated message when
22415 &%return_message%& is set. They do not apply to the generated message itself.
22416
22417 .vindex "&$sender_address$&"
22418 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22419 the message, indicating that there were no recipients, it does not treat this
22420 as an error. This means that autoreplies sent to &$sender_address$& when this
22421 is empty (because the incoming message is a bounce message) do not cause
22422 problems. They are just discarded.
22423
22424
22425
22426 .section "Private options for autoreply" "SECID139"
22427 .cindex "options" "&(autoreply)& transport"
22428
22429 .option bcc autoreply string&!! unset
22430 This specifies the addresses that are to receive &"blind carbon copies"& of the
22431 message when the message is specified by the transport.
22432
22433
22434 .option cc autoreply string&!! unset
22435 This specifies recipients of the message and the contents of the &'Cc:'& header
22436 when the message is specified by the transport.
22437
22438
22439 .option file autoreply string&!! unset
22440 The contents of the file are sent as the body of the message when the message
22441 is specified by the transport. If both &%file%& and &%text%& are set, the text
22442 string comes first.
22443
22444
22445 .option file_expand autoreply boolean false
22446 If this is set, the contents of the file named by the &%file%& option are
22447 subjected to string expansion as they are added to the message.
22448
22449
22450 .option file_optional autoreply boolean false
22451 If this option is true, no error is generated if the file named by the &%file%&
22452 option or passed with the address does not exist or cannot be read.
22453
22454
22455 .option from autoreply string&!! unset
22456 This specifies the contents of the &'From:'& header when the message is
22457 specified by the transport.
22458
22459
22460 .option headers autoreply string&!! unset
22461 This specifies additional RFC 2822 headers that are to be added to the message
22462 when the message is specified by the transport. Several can be given by using
22463 &"\n"& to separate them. There is no check on the format.
22464
22465
22466 .option log autoreply string&!! unset
22467 This option names a file in which a record of every message sent is logged when
22468 the message is specified by the transport.
22469
22470
22471 .option mode autoreply "octal integer" 0600
22472 If either the log file or the &"once"& file has to be created, this mode is
22473 used.
22474
22475
22476 .option never_mail autoreply "address list&!!" unset
22477 If any run of the transport creates a message with a recipient that matches any
22478 item in the list, that recipient is quietly discarded. If all recipients are
22479 discarded, no message is created. This applies both when the recipients are
22480 generated by a filter and when they are specified in the transport.
22481
22482
22483
22484 .option once autoreply string&!! unset
22485 This option names a file or DBM database in which a record of each &'To:'&
22486 recipient is kept when the message is specified by the transport. &*Note*&:
22487 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22488
22489 If &%once%& is unset, or is set to an empty string, the message is always sent.
22490 By default, if &%once%& is set to a non-empty file name, the message
22491 is not sent if a potential recipient is already listed in the database.
22492 However, if the &%once_repeat%& option specifies a time greater than zero, the
22493 message is sent if that much time has elapsed since a message was last sent to
22494 this recipient. A setting of zero time for &%once_repeat%& (the default)
22495 prevents a message from being sent a second time &-- in this case, zero means
22496 infinity.
22497
22498 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22499 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22500 greater than zero, it changes the way Exim implements the &%once%& option.
22501 Instead of using a DBM file to record every recipient it sends to, it uses a
22502 regular file, whose size will never get larger than the given value.
22503
22504 In the file, Exim keeps a linear list of recipient addresses and the times at
22505 which they were sent messages. If the file is full when a new address needs to
22506 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22507 means that a given recipient may receive multiple messages, but at
22508 unpredictable intervals that depend on the rate of turnover of addresses in the
22509 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22510
22511
22512 .option once_file_size autoreply integer 0
22513 See &%once%& above.
22514
22515
22516 .option once_repeat autoreply time&!! 0s
22517 See &%once%& above.
22518 After expansion, the value of this option must be a valid time value.
22519
22520
22521 .option reply_to autoreply string&!! unset
22522 This specifies the contents of the &'Reply-To:'& header when the message is
22523 specified by the transport.
22524
22525
22526 .option return_message autoreply boolean false
22527 If this is set, a copy of the original message is returned with the new
22528 message, subject to the maximum size set in the &%return_size_limit%& global
22529 configuration option.
22530
22531
22532 .option subject autoreply string&!! unset
22533 This specifies the contents of the &'Subject:'& header when the message is
22534 specified by the transport. It is tempting to quote the original subject in
22535 automatic responses. For example:
22536 .code
22537 subject = Re: $h_subject:
22538 .endd
22539 There is a danger in doing this, however. It may allow a third party to
22540 subscribe your users to an opt-in mailing list, provided that the list accepts
22541 bounce messages as subscription confirmations. Well-managed lists require a
22542 non-bounce message to confirm a subscription, so the danger is relatively
22543 small.
22544
22545
22546
22547 .option text autoreply string&!! unset
22548 This specifies a single string to be used as the body of the message when the
22549 message is specified by the transport. If both &%text%& and &%file%& are set,
22550 the text comes first.
22551
22552
22553 .option to autoreply string&!! unset
22554 This specifies recipients of the message and the contents of the &'To:'& header
22555 when the message is specified by the transport.
22556 .ecindex IIDauttra1
22557 .ecindex IIDauttra2
22558
22559
22560
22561
22562 . ////////////////////////////////////////////////////////////////////////////
22563 . ////////////////////////////////////////////////////////////////////////////
22564
22565 .chapter "The lmtp transport" "CHAPLMTP"
22566 .cindex "transports" "&(lmtp)&"
22567 .cindex "&(lmtp)& transport"
22568 .cindex "LMTP" "over a pipe"
22569 .cindex "LMTP" "over a socket"
22570 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22571 specified command
22572 or by interacting with a Unix domain socket.
22573 This transport is something of a cross between the &(pipe)& and &(smtp)&
22574 transports. Exim also has support for using LMTP over TCP/IP; this is
22575 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22576 to be of minority interest, the default build-time configure in &_src/EDITME_&
22577 has it commented out. You need to ensure that
22578 .code
22579 TRANSPORT_LMTP=yes
22580 .endd
22581 .cindex "options" "&(lmtp)& transport"
22582 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22583 included in the Exim binary. The private options of the &(lmtp)& transport are
22584 as follows:
22585
22586 .option batch_id lmtp string&!! unset
22587 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22588
22589
22590 .option batch_max lmtp integer 1
22591 This limits the number of addresses that can be handled in a single delivery.
22592 Most LMTP servers can handle several addresses at once, so it is normally a
22593 good idea to increase this value. See the description of local delivery
22594 batching in chapter &<<CHAPbatching>>&.
22595
22596
22597 .option command lmtp string&!! unset
22598 This option must be set if &%socket%& is not set. The string is a command which
22599 is run in a separate process. It is split up into a command name and list of
22600 arguments, each of which is separately expanded (so expansion cannot change the
22601 number of arguments). The command is run directly, not via a shell. The message
22602 is passed to the new process using the standard input and output to operate the
22603 LMTP protocol.
22604
22605 .option ignore_quota lmtp boolean false
22606 .cindex "LMTP" "ignoring quota errors"
22607 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22608 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22609 in its response to the LHLO command.
22610
22611 .option socket lmtp string&!! unset
22612 This option must be set if &%command%& is not set. The result of expansion must
22613 be the name of a Unix domain socket. The transport connects to the socket and
22614 delivers the message to it using the LMTP protocol.
22615
22616
22617 .option timeout lmtp time 5m
22618 The transport is aborted if the created process or Unix domain socket does not
22619 respond to LMTP commands or message input within this timeout. Delivery
22620 is deferred, and will be tried again later. Here is an example of a typical
22621 LMTP transport:
22622 .code
22623 lmtp:
22624   driver = lmtp
22625   command = /some/local/lmtp/delivery/program
22626   batch_max = 20
22627   user = exim
22628 .endd
22629 This delivers up to 20 addresses at a time, in a mixture of domains if
22630 necessary, running as the user &'exim'&.
22631
22632
22633
22634 . ////////////////////////////////////////////////////////////////////////////
22635 . ////////////////////////////////////////////////////////////////////////////
22636
22637 .chapter "The pipe transport" "CHAPpipetransport"
22638 .scindex IIDpiptra1 "transports" "&(pipe)&"
22639 .scindex IIDpiptra2 "&(pipe)& transport"
22640 The &(pipe)& transport is used to deliver messages via a pipe to a command
22641 running in another process. One example is the use of &(pipe)& as a
22642 pseudo-remote transport for passing messages to some other delivery mechanism
22643 (such as UUCP). Another is the use by individual users to automatically process
22644 their incoming messages. The &(pipe)& transport can be used in one of the
22645 following ways:
22646
22647 .ilist
22648 .vindex "&$local_part$&"
22649 A router routes one address to a transport in the normal way, and the
22650 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22651 contains the local part of the address (as usual), and the command that is run
22652 is specified by the &%command%& option on the transport.
22653 .next
22654 .vindex "&$pipe_addresses$&"
22655 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22656 transport can handle more than one address in a single run. In this case, when
22657 more than one address is routed to the transport, &$local_part$& is not set
22658 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22659 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22660 that are routed to the transport.
22661 .next
22662 .vindex "&$address_pipe$&"
22663 A router redirects an address directly to a pipe command (for example, from an
22664 alias or forward file). In this case, &$address_pipe$& contains the text of the
22665 pipe command, and the &%command%& option on the transport is ignored unless
22666 &%force_command%& is set. If only one address is being transported
22667 (&%batch_max%& is not greater than one, or only one address was redirected to
22668 this pipe command), &$local_part$& contains the local part that was redirected.
22669 .endlist
22670
22671
22672 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22673 deliver messages over pipes using the LMTP interactive protocol. This is
22674 implemented by the &(lmtp)& transport.
22675
22676 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22677 &_.forward_& file, the command runs under the uid and gid of that user. In
22678 other cases, the uid and gid have to be specified explicitly, either on the
22679 transport or on the router that handles the address. Current and &"home"&
22680 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22681 details of the local delivery environment and chapter &<<CHAPbatching>>&
22682 for a discussion of local delivery batching.
22683
22684
22685 .section "Concurrent delivery" "SECID140"
22686 If two messages arrive at almost the same time, and both are routed to a pipe
22687 delivery, the two pipe transports may be run concurrently. You must ensure that
22688 any pipe commands you set up are robust against this happening. If the commands
22689 write to a file, the &%exim_lock%& utility might be of use.
22690 .new
22691 Alternatively the &%max_parallel%& option could be used with a value
22692 of "1" to enforce serialization.
22693 .wen
22694
22695
22696
22697
22698 .section "Returned status and data" "SECID141"
22699 .cindex "&(pipe)& transport" "returned data"
22700 If the command exits with a non-zero return code, the delivery is deemed to
22701 have failed, unless either the &%ignore_status%& option is set (in which case
22702 the return code is treated as zero), or the return code is one of those listed
22703 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22704 later"&. In this case, delivery is deferred. Details of a permanent failure are
22705 logged, but are not included in the bounce message, which merely contains
22706 &"local delivery failed"&.
22707
22708 If the command exits on a signal and the &%freeze_signal%& option is set then
22709 the message will be frozen in the queue. If that option is not set, a bounce
22710 will be sent as normal.
22711
22712 If the return code is greater than 128 and the command being run is a shell
22713 script, it normally means that the script was terminated by a signal whose
22714 value is the return code minus 128. The &%freeze_signal%& option does not
22715 apply in this case.
22716
22717 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22718 return code is set to 127. This is the value that a shell returns if it is
22719 asked to run a non-existent command. The wording for the log line suggests that
22720 a non-existent command may be the problem.
22721
22722 The &%return_output%& option can affect the result of a pipe delivery. If it is
22723 set and the command produces any output on its standard output or standard
22724 error streams, the command is considered to have failed, even if it gave a zero
22725 return code or if &%ignore_status%& is set. The output from the command is
22726 included as part of the bounce message. The &%return_fail_output%& option is
22727 similar, except that output is returned only when the command exits with a
22728 failure return code, that is, a value other than zero or a code that matches
22729 &%temp_errors%&.
22730
22731
22732
22733 .section "How the command is run" "SECThowcommandrun"
22734 .cindex "&(pipe)& transport" "path for command"
22735 The command line is (by default) broken down into a command name and arguments
22736 by the &(pipe)& transport itself. The &%allow_commands%& and
22737 &%restrict_to_path%& options can be used to restrict the commands that may be
22738 run.
22739
22740 .cindex "quoting" "in pipe command"
22741 Unquoted arguments are delimited by white space. If an argument appears in
22742 double quotes, backslash is interpreted as an escape character in the usual
22743 way. If an argument appears in single quotes, no escaping is done.
22744
22745 String expansion is applied to the command line except when it comes from a
22746 traditional &_.forward_& file (commands from a filter file are expanded). The
22747 expansion is applied to each argument in turn rather than to the whole line.
22748 For this reason, any string expansion item that contains white space must be
22749 quoted so as to be contained within a single argument. A setting such as
22750 .code
22751 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22752 .endd
22753 will not work, because the expansion item gets split between several
22754 arguments. You have to write
22755 .code
22756 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22757 .endd
22758 to ensure that it is all in one argument. The expansion is done in this way,
22759 argument by argument, so that the number of arguments cannot be changed as a
22760 result of expansion, and quotes or backslashes in inserted variables do not
22761 interact with external quoting. However, this leads to problems if you want to
22762 generate multiple arguments (or the command name plus arguments) from a single
22763 expansion. In this situation, the simplest solution is to use a shell. For
22764 example:
22765 .code
22766 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22767 .endd
22768
22769 .cindex "transport" "filter"
22770 .cindex "filter" "transport filter"
22771 .vindex "&$pipe_addresses$&"
22772 Special handling takes place when an argument consists of precisely the text
22773 &`$pipe_addresses`&. This is not a general expansion variable; the only
22774 place this string is recognized is when it appears as an argument for a pipe or
22775 transport filter command. It causes each address that is being handled to be
22776 inserted in the argument list at that point &'as a separate argument'&. This
22777 avoids any problems with spaces or shell metacharacters, and is of use when a
22778 &(pipe)& transport is handling groups of addresses in a batch.
22779
22780 If &%force_command%& is enabled on the transport, Special handling takes place
22781 for an argument that consists of precisely the text &`$address_pipe`&.  It
22782 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22783 argument is inserted in the argument list at that point
22784 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22785 the only item in the argument; in fact, if it were then &%force_command%&
22786 should behave as a no-op.  Rather, it should be used to adjust the command
22787 run while preserving the argument vector separation.
22788
22789 After splitting up into arguments and expansion, the resulting command is run
22790 in a subprocess directly from the transport, &'not'& under a shell. The
22791 message that is being delivered is supplied on the standard input, and the
22792 standard output and standard error are both connected to a single pipe that is
22793 read by Exim. The &%max_output%& option controls how much output the command
22794 may produce, and the &%return_output%& and &%return_fail_output%& options
22795 control what is done with it.
22796
22797 Not running the command under a shell (by default) lessens the security risks
22798 in cases when a command from a user's filter file is built out of data that was
22799 taken from an incoming message. If a shell is required, it can of course be
22800 explicitly specified as the command to be run. However, there are circumstances
22801 where existing commands (for example, in &_.forward_& files) expect to be run
22802 under a shell and cannot easily be modified. To allow for these cases, there is
22803 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22804 works. Instead of breaking up the command line as just described, it expands it
22805 as a single string and passes the result to &_/bin/sh_&. The
22806 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22807 with &%use_shell%&, and the whole mechanism is inherently less secure.
22808
22809
22810
22811 .section "Environment variables" "SECTpipeenv"
22812 .cindex "&(pipe)& transport" "environment for command"
22813 .cindex "environment for pipe transport"
22814 The environment variables listed below are set up when the command is invoked.
22815 This list is a compromise for maximum compatibility with other MTAs. Note that
22816 the &%environment%& option can be used to add additional variables to this
22817 environment.
22818 .display
22819 &`DOMAIN            `&   the domain of the address
22820 &`HOME              `&   the home directory, if set
22821 &`HOST              `&   the host name when called from a router (see below)
22822 &`LOCAL_PART        `&   see below
22823 &`LOCAL_PART_PREFIX `&   see below
22824 &`LOCAL_PART_SUFFIX `&   see below
22825 &`LOGNAME           `&   see below
22826 &`MESSAGE_ID        `&   Exim's local ID for the message
22827 &`PATH              `&   as specified by the &%path%& option below
22828 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22829 &`RECIPIENT         `&   the complete recipient address
22830 &`SENDER            `&   the sender of the message (empty if a bounce)
22831 &`SHELL             `&   &`/bin/sh`&
22832 &`TZ                `&   the value of the &%timezone%& option, if set
22833 &`USER              `&   see below
22834 .endd
22835 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22836 router, LOCAL_PART is set to the local part of the address. When it is
22837 called as a result of a forward or alias expansion, LOCAL_PART is set to
22838 the local part of the address that was expanded. In both cases, any affixes are
22839 removed from the local part, and made available in LOCAL_PART_PREFIX and
22840 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22841 same value as LOCAL_PART for compatibility with other MTAs.
22842
22843 .cindex "HOST"
22844 HOST is set only when a &(pipe)& transport is called from a router that
22845 associates hosts with an address, typically when using &(pipe)& as a
22846 pseudo-remote transport. HOST is set to the first host name specified by
22847 the router.
22848
22849 .cindex "HOME"
22850 If the transport's generic &%home_directory%& option is set, its value is used
22851 for the HOME environment variable. Otherwise, a home directory may be set
22852 by the router's &%transport_home_directory%& option, which defaults to the
22853 user's home directory if &%check_local_user%& is set.
22854
22855
22856 .section "Private options for pipe" "SECID142"
22857 .cindex "options" "&(pipe)& transport"
22858
22859
22860
22861 .option allow_commands pipe "string list&!!" unset
22862 .cindex "&(pipe)& transport" "permitted commands"
22863 The string is expanded, and is then interpreted as a colon-separated list of
22864 permitted commands. If &%restrict_to_path%& is not set, the only commands
22865 permitted are those in the &%allow_commands%& list. They need not be absolute
22866 paths; the &%path%& option is still used for relative paths. If
22867 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22868 in the &%allow_commands%& list, or a name without any slashes that is found on
22869 the path. In other words, if neither &%allow_commands%& nor
22870 &%restrict_to_path%& is set, there is no restriction on the command, but
22871 otherwise only commands that are permitted by one or the other are allowed. For
22872 example, if
22873 .code
22874 allow_commands = /usr/bin/vacation
22875 .endd
22876 and &%restrict_to_path%& is not set, the only permitted command is
22877 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22878 &%use_shell%& is set.
22879
22880
22881 .option batch_id pipe string&!! unset
22882 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22883
22884
22885 .option batch_max pipe integer 1
22886 This limits the number of addresses that can be handled in a single delivery.
22887 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22888
22889
22890 .option check_string pipe string unset
22891 As &(pipe)& writes the message, the start of each line is tested for matching
22892 &%check_string%&, and if it does, the initial matching characters are replaced
22893 by the contents of &%escape_string%&, provided both are set. The value of
22894 &%check_string%& is a literal string, not a regular expression, and the case of
22895 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22896 of &%check_string%& and &%escape_string%& are forced to values that implement
22897 the SMTP escaping protocol. Any settings made in the configuration file are
22898 ignored.
22899
22900
22901 .option command pipe string&!! unset
22902 This option need not be set when &(pipe)& is being used to deliver to pipes
22903 obtained directly from address redirections. In other cases, the option must be
22904 set, to provide a command to be run. It need not yield an absolute path (see
22905 the &%path%& option below). The command is split up into separate arguments by
22906 Exim, and each argument is separately expanded, as described in section
22907 &<<SECThowcommandrun>>& above.
22908
22909
22910 .option environment pipe string&!! unset
22911 .cindex "&(pipe)& transport" "environment for command"
22912 .cindex "environment for &(pipe)& transport"
22913 This option is used to add additional variables to the environment in which the
22914 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22915 a string which is expanded, and then interpreted as a colon-separated list of
22916 environment settings of the form <&'name'&>=<&'value'&>.
22917
22918
22919 .option escape_string pipe string unset
22920 See &%check_string%& above.
22921
22922
22923 .option freeze_exec_fail pipe boolean false
22924 .cindex "exec failure"
22925 .cindex "failure of exec"
22926 .cindex "&(pipe)& transport" "failure of exec"
22927 Failure to exec the command in a pipe transport is by default treated like
22928 any other failure while running the command. However, if &%freeze_exec_fail%&
22929 is set, failure to exec is treated specially, and causes the message to be
22930 frozen, whatever the setting of &%ignore_status%&.
22931
22932
22933 .option freeze_signal pipe boolean false
22934 .cindex "signal exit"
22935 .cindex "&(pipe)& transport", "signal exit"
22936 Normally if the process run by a command in a pipe transport exits on a signal,
22937 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22938 frozen in Exim's queue instead.
22939
22940
22941 .option force_command pipe boolean false
22942 .cindex "force command"
22943 .cindex "&(pipe)& transport", "force command"
22944 Normally when a router redirects an address directly to a pipe command
22945 the &%command%& option on the transport is ignored.  If &%force_command%&
22946 is set, the &%command%& option will used. This is especially
22947 useful for forcing a wrapper or additional argument to be added to the
22948 command. For example:
22949 .code
22950 command = /usr/bin/remote_exec myhost -- $address_pipe
22951 force_command
22952 .endd
22953
22954 Note that &$address_pipe$& is handled specially in &%command%& when
22955 &%force_command%& is set, expanding out to the original argument vector as
22956 separate items, similarly to a Unix shell &`"$@"`& construct.
22957
22958
22959 .option ignore_status pipe boolean false
22960 If this option is true, the status returned by the subprocess that is set up to
22961 run the command is ignored, and Exim behaves as if zero had been returned.
22962 Otherwise, a non-zero status or termination by signal causes an error return
22963 from the transport unless the status value is one of those listed in
22964 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22965
22966 &*Note*&: This option does not apply to timeouts, which do not return a status.
22967 See the &%timeout_defer%& option for how timeouts are handled.
22968
22969
22970 .option log_defer_output pipe boolean false
22971 .cindex "&(pipe)& transport" "logging output"
22972 If this option is set, and the status returned by the command is
22973 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22974 and any output was produced on stdout or stderr, the first line of it is
22975 written to the main log.
22976
22977
22978 .option log_fail_output pipe boolean false
22979 If this option is set, and the command returns any output on stdout or
22980 stderr, and also ends with a return code that is neither zero nor one of
22981 the return codes listed in &%temp_errors%& (that is, the delivery
22982 failed), the first line of output is written to the main log. This
22983 option and &%log_output%& are mutually exclusive.  Only one of them may
22984 be set.
22985
22986
22987 .option log_output pipe boolean false
22988 If this option is set and the command returns any output on stdout or
22989 stderr, the first line of output is written to the main log, whatever
22990 the return code. This option and &%log_fail_output%& are mutually
22991 exclusive. Only one of them may be set.
22992
22993
22994 .option max_output pipe integer 20K
22995 This specifies the maximum amount of output that the command may produce on its
22996 standard output and standard error file combined. If the limit is exceeded, the
22997 process running the command is killed. This is intended as a safety measure to
22998 catch runaway processes. The limit is applied independently of the settings of
22999 the options that control what is done with such output (for example,
23000 &%return_output%&). Because of buffering effects, the amount of output may
23001 exceed the limit by a small amount before Exim notices.
23002
23003
23004 .option message_prefix pipe string&!! "see below"
23005 The string specified here is expanded and output at the start of every message.
23006 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23007 .code
23008 message_prefix = \
23009   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23010   ${tod_bsdinbox}\n
23011 .endd
23012 .cindex "Cyrus"
23013 .cindex "&%tmail%&"
23014 .cindex "&""From""& line"
23015 This is required by the commonly used &_/usr/bin/vacation_& program.
23016 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23017 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23018 setting
23019 .code
23020 message_prefix =
23021 .endd
23022 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23023 &`\n`& to &`\r\n`& in &%message_prefix%&.
23024
23025
23026 .option message_suffix pipe string&!! "see below"
23027 The string specified here is expanded and output at the end of every message.
23028 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23029 The suffix can be suppressed by setting
23030 .code
23031 message_suffix =
23032 .endd
23033 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23034 &`\n`& to &`\r\n`& in &%message_suffix%&.
23035
23036
23037 .option path pipe string "see below"
23038 This option specifies the string that is set up in the PATH environment
23039 variable of the subprocess. The default is:
23040 .code
23041 /bin:/usr/bin
23042 .endd
23043 If the &%command%& option does not yield an absolute path name, the command is
23044 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23045 apply to a command specified as a transport filter.
23046
23047
23048 .option permit_coredump pipe boolean false
23049 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23050 a core-dump of a pipe command, enable this command.  This enables core-dumps
23051 during delivery and affects both the Exim binary and the pipe command run.
23052 It is recommended that this option remain off unless and until you have a need
23053 for it and that this only be enabled when needed, as the risk of excessive
23054 resource consumption can be quite high.  Note also that Exim is typically
23055 installed as a setuid binary and most operating systems will inhibit coredumps
23056 of these by default, so further OS-specific action may be required.
23057
23058
23059 .option pipe_as_creator pipe boolean false
23060 .cindex "uid (user id)" "local delivery"
23061 If the generic &%user%& option is not set and this option is true, the delivery
23062 process is run under the uid that was in force when Exim was originally called
23063 to accept the message. If the group id is not otherwise set (via the generic
23064 &%group%& option), the gid that was in force when Exim was originally called to
23065 accept the message is used.
23066
23067
23068 .option restrict_to_path pipe boolean false
23069 When this option is set, any command name not listed in &%allow_commands%& must
23070 contain no slashes. The command is searched for only in the directories listed
23071 in the &%path%& option. This option is intended for use in the case when a pipe
23072 command has been generated from a user's &_.forward_& file. This is usually
23073 handled by a &(pipe)& transport called &%address_pipe%&.
23074
23075
23076 .option return_fail_output pipe boolean false
23077 If this option is true, and the command produced any output and ended with a
23078 return code other than zero or one of the codes listed in &%temp_errors%& (that
23079 is, the delivery failed), the output is returned in the bounce message.
23080 However, if the message has a null sender (that is, it is itself a bounce
23081 message), output from the command is discarded. This option and
23082 &%return_output%& are mutually exclusive. Only one of them may be set.
23083
23084
23085
23086 .option return_output pipe boolean false
23087 If this option is true, and the command produced any output, the delivery is
23088 deemed to have failed whatever the return code from the command, and the output
23089 is returned in the bounce message. Otherwise, the output is just discarded.
23090 However, if the message has a null sender (that is, it is a bounce message),
23091 output from the command is always discarded, whatever the setting of this
23092 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23093 of them may be set.
23094
23095
23096
23097 .option temp_errors pipe "string list" "see below"
23098 .cindex "&(pipe)& transport" "temporary failure"
23099 This option contains either a colon-separated list of numbers, or a single
23100 asterisk. If &%ignore_status%& is false
23101 and &%return_output%& is not set,
23102 and the command exits with a non-zero return code, the failure is treated as
23103 temporary and the delivery is deferred if the return code matches one of the
23104 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23105 codes are treated as permanent errors. The default setting contains the codes
23106 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23107 compiled on a system that does not define these macros, it assumes values of 75
23108 and 73, respectively.
23109
23110
23111 .option timeout pipe time 1h
23112 If the command fails to complete within this time, it is killed. This normally
23113 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23114 specifies no timeout. In order to ensure that any subprocesses created by the
23115 command are also killed, Exim makes the initial process a process group leader,
23116 and kills the whole process group on a timeout. However, this can be defeated
23117 if one of the processes starts a new process group.
23118
23119 .option timeout_defer pipe boolean false
23120 A timeout in a &(pipe)& transport, either in the command that the transport
23121 runs, or in a transport filter that is associated with it, is by default
23122 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23123 is set true, both kinds of timeout become temporary errors, causing the
23124 delivery to be deferred.
23125
23126 .option umask pipe "octal integer" 022
23127 This specifies the umask setting for the subprocess that runs the command.
23128
23129
23130 .option use_bsmtp pipe boolean false
23131 .cindex "envelope sender"
23132 If this option is set true, the &(pipe)& transport writes messages in &"batch
23133 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23134 commands. If you want to include a leading HELO command with such messages,
23135 you can do so by setting the &%message_prefix%& option. See section
23136 &<<SECTbatchSMTP>>& for details of batch SMTP.
23137
23138 .option use_classresources pipe boolean false
23139 .cindex "class resources (BSD)"
23140 This option is available only when Exim is running on FreeBSD, NetBSD, or
23141 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23142 resource limits when a &(pipe)& transport is run to perform a delivery. The
23143 limits for the uid under which the pipe is to run are obtained from the login
23144 class database.
23145
23146
23147 .option use_crlf pipe boolean false
23148 .cindex "carriage return"
23149 .cindex "linefeed"
23150 This option causes lines to be terminated with the two-character CRLF sequence
23151 (carriage return, linefeed) instead of just a linefeed character. In the case
23152 of batched SMTP, the byte sequence written to the pipe is then an exact image
23153 of what would be sent down a real SMTP connection.
23154
23155 The contents of the &%message_prefix%& and &%message_suffix%& options are
23156 written verbatim, so must contain their own carriage return characters if these
23157 are needed. When &%use_bsmtp%& is not set, the default values for both
23158 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23159 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23160
23161
23162 .option use_shell pipe boolean false
23163 .vindex "&$pipe_addresses$&"
23164 If this option is set, it causes the command to be passed to &_/bin/sh_&
23165 instead of being run directly from the transport, as described in section
23166 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23167 where the command is expected to be run under a shell and cannot easily be
23168 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23169 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23170 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23171 its &%-c%& option.
23172
23173
23174
23175 .section "Using an external local delivery agent" "SECID143"
23176 .cindex "local delivery" "using an external agent"
23177 .cindex "&'procmail'&"
23178 .cindex "external local delivery"
23179 .cindex "delivery" "&'procmail'&"
23180 .cindex "delivery" "by external agent"
23181 The &(pipe)& transport can be used to pass all messages that require local
23182 delivery to a separate local delivery agent such as &%procmail%&. When doing
23183 this, care must be taken to ensure that the pipe is run under an appropriate
23184 uid and gid. In some configurations one wants this to be a uid that is trusted
23185 by the delivery agent to supply the correct sender of the message. It may be
23186 necessary to recompile or reconfigure the delivery agent so that it trusts an
23187 appropriate user. The following is an example transport and router
23188 configuration for &%procmail%&:
23189 .code
23190 # transport
23191 procmail_pipe:
23192   driver = pipe
23193   command = /usr/local/bin/procmail -d $local_part
23194   return_path_add
23195   delivery_date_add
23196   envelope_to_add
23197   check_string = "From "
23198   escape_string = ">From "
23199   umask = 077
23200   user = $local_part
23201   group = mail
23202
23203 # router
23204 procmail:
23205   driver = accept
23206   check_local_user
23207   transport = procmail_pipe
23208 .endd
23209 In this example, the pipe is run as the local user, but with the group set to
23210 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23211 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23212 user to supply a correct sender address. If you do not specify either a
23213 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23214 home directory is the user's home directory by default.
23215
23216 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23217 .code
23218 IFS=" "
23219 .endd
23220 as shown in some &%procmail%& documentation, because Exim does not by default
23221 use a shell to run pipe commands.
23222
23223 .cindex "Cyrus"
23224 The next example shows a transport and a router for a system where local
23225 deliveries are handled by the Cyrus IMAP server.
23226 .code
23227 # transport
23228 local_delivery_cyrus:
23229   driver = pipe
23230   command = /usr/cyrus/bin/deliver \
23231             -m ${substr_1:$local_part_suffix} -- $local_part
23232   user = cyrus
23233   group = mail
23234   return_output
23235   log_output
23236   message_prefix =
23237   message_suffix =
23238
23239 # router
23240 local_user_cyrus:
23241   driver = accept
23242   check_local_user
23243   local_part_suffix = .*
23244   transport = local_delivery_cyrus
23245 .endd
23246 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23247 &%return_output%& to cause any text written by Cyrus to be returned to the
23248 sender.
23249 .ecindex IIDpiptra1
23250 .ecindex IIDpiptra2
23251
23252
23253 . ////////////////////////////////////////////////////////////////////////////
23254 . ////////////////////////////////////////////////////////////////////////////
23255
23256 .chapter "The smtp transport" "CHAPsmtptrans"
23257 .scindex IIDsmttra1 "transports" "&(smtp)&"
23258 .scindex IIDsmttra2 "&(smtp)& transport"
23259 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23260 or LMTP protocol. The list of hosts to try can either be taken from the address
23261 that is being processed (having been set up by the router), or specified
23262 explicitly for the transport. Timeout and retry processing (see chapter
23263 &<<CHAPretry>>&) is applied to each IP address independently.
23264
23265
23266 .section "Multiple messages on a single connection" "SECID144"
23267 The sending of multiple messages over a single TCP/IP connection can arise in
23268 two ways:
23269
23270 .ilist
23271 If a message contains more than &%max_rcpt%& (see below) addresses that are
23272 routed to the same host, more than one copy of the message has to be sent to
23273 that host. In this situation, multiple copies may be sent in a single run of
23274 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23275 does when it has too many addresses to send in one message also depends on the
23276 value of the global &%remote_max_parallel%& option. Details are given in
23277 section &<<SECToutSMTPTCP>>&.)
23278 .next
23279 .cindex "hints database" "remembering routing"
23280 When a message has been successfully delivered over a TCP/IP connection, Exim
23281 looks in its hints database to see if there are any other messages awaiting a
23282 connection to the same host. If there are, a new delivery process is started
23283 for one of them, and the current TCP/IP connection is passed on to it. The new
23284 process may in turn send multiple copies and possibly create yet another
23285 process.
23286 .endlist
23287
23288
23289 For each copy sent over the same TCP/IP connection, a sequence counter is
23290 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23291 no further messages are sent over that connection.
23292
23293
23294
23295 .section "Use of the $host and $host_address variables" "SECID145"
23296 .vindex "&$host$&"
23297 .vindex "&$host_address$&"
23298 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23299 &$host_address$& are the name and IP address of the first host on the host list
23300 passed by the router. However, when the transport is about to connect to a
23301 specific host, and while it is connected to that host, &$host$& and
23302 &$host_address$& are set to the values for that host. These are the values
23303 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23304 &%serialize_hosts%&, and the various TLS options are expanded.
23305
23306
23307 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23308 .vindex &$tls_bits$&
23309 .vindex &$tls_cipher$&
23310 .vindex &$tls_peerdn$&
23311 .vindex &$tls_sni$&
23312 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23313 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23314 are the values that were set when the message was received.
23315 These are the values that are used for options that are expanded before any
23316 SMTP connections are made. Just before each connection is made, these four
23317 variables are emptied. If TLS is subsequently started, they are set to the
23318 appropriate values for the outgoing connection, and these are the values that
23319 are in force when any authenticators are run and when the
23320 &%authenticated_sender%& option is expanded.
23321
23322 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23323 and will be removed in a future release.
23324
23325
23326 .section "Private options for smtp" "SECID146"
23327 .cindex "options" "&(smtp)& transport"
23328 The private options of the &(smtp)& transport are as follows:
23329
23330
23331 .option address_retry_include_sender smtp boolean true
23332 .cindex "4&'xx'& responses" "retrying after"
23333 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23334 is the combination of sender and recipient that is delayed in subsequent queue
23335 runs until the retry time is reached. You can delay the recipient without
23336 reference to the sender (which is what earlier versions of Exim did), by
23337 setting &%address_retry_include_sender%& false. However, this can lead to
23338 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23339
23340 .option allow_localhost smtp boolean false
23341 .cindex "local host" "sending to"
23342 .cindex "fallback" "hosts specified on transport"
23343 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23344 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23345 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23346 the delivery anyway. This should be used only in special cases when the
23347 configuration ensures that no looping will result (for example, a differently
23348 configured Exim is listening on the port to which the message is sent).
23349
23350
23351 .option authenticated_sender smtp string&!! unset
23352 .cindex "Cyrus"
23353 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23354 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23355 overriding any existing authenticated sender value. If the string expansion is
23356 forced to fail, the option is ignored. Other expansion failures cause delivery
23357 to be deferred. If the result of expansion is an empty string, that is also
23358 ignored.
23359
23360 The expansion happens after the outgoing connection has been made and TLS
23361 started, if required. This means that the &$host$&, &$host_address$&,
23362 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23363 particular connection.
23364
23365 If the SMTP session is not authenticated, the expansion of
23366 &%authenticated_sender%& still happens (and can cause the delivery to be
23367 deferred if it fails), but no AUTH= item is added to MAIL commands
23368 unless &%authenticated_sender_force%& is true.
23369
23370 This option allows you to use the &(smtp)& transport in LMTP mode to
23371 deliver mail to Cyrus IMAP and provide the proper local part as the
23372 &"authenticated sender"&, via a setting such as:
23373 .code
23374 authenticated_sender = $local_part
23375 .endd
23376 This removes the need for IMAP subfolders to be assigned special ACLs to
23377 allow direct delivery to those subfolders.
23378
23379 Because of expected uses such as that just described for Cyrus (when no
23380 domain is involved), there is no checking on the syntax of the provided
23381 value.
23382
23383
23384 .option authenticated_sender_force smtp boolean false
23385 If this option is set true, the &%authenticated_sender%& option's value
23386 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23387 authenticated as a client.
23388
23389
23390 .option command_timeout smtp time 5m
23391 This sets a timeout for receiving a response to an SMTP command that has been
23392 sent out. It is also used when waiting for the initial banner line from the
23393 remote host. Its value must not be zero.
23394
23395
23396 .option connect_timeout smtp time 5m
23397 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23398 to a remote host. A setting of zero allows the system timeout (typically
23399 several minutes) to act. To have any effect, the value of this option must be
23400 less than the system timeout. However, it has been observed that on some
23401 systems there is no system timeout, which is why the default value for this
23402 option is 5 minutes, a value recommended by RFC 1123.
23403
23404
23405 .option connection_max_messages smtp integer 500
23406 .cindex "SMTP" "passed connection"
23407 .cindex "SMTP" "multiple deliveries"
23408 .cindex "multiple SMTP deliveries"
23409 This controls the maximum number of separate message deliveries that are sent
23410 over a single TCP/IP connection. If the value is zero, there is no limit.
23411 For testing purposes, this value can be overridden by the &%-oB%& command line
23412 option.
23413
23414
23415 .option data_timeout smtp time 5m
23416 This sets a timeout for the transmission of each block in the data portion of
23417 the message. As a result, the overall timeout for a message depends on the size
23418 of the message. Its value must not be zero. See also &%final_timeout%&.
23419
23420
23421 .option delay_after_cutoff smtp boolean true
23422 This option controls what happens when all remote IP addresses for a given
23423 domain have been inaccessible for so long that they have passed their retry
23424 cutoff times.
23425
23426 In the default state, if the next retry time has not been reached for any of
23427 them, the address is bounced without trying any deliveries. In other words,
23428 Exim delays retrying an IP address after the final cutoff time until a new
23429 retry time is reached, and can therefore bounce an address without ever trying
23430 a delivery, when machines have been down for a long time. Some people are
23431 unhappy at this prospect, so...
23432
23433 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23434 addresses are past their final cutoff time, Exim tries to deliver to those
23435 IP addresses that have not been tried since the message arrived. If there are
23436 none, of if they all fail, the address is bounced. In other words, it does not
23437 delay when a new message arrives, but immediately tries those expired IP
23438 addresses that haven't been tried since the message arrived. If there is a
23439 continuous stream of messages for the dead hosts, unsetting
23440 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23441 to them.
23442
23443
23444 .option dns_qualify_single smtp boolean true
23445 If the &%hosts%& or &%fallback_hosts%& option is being used,
23446 and the &%gethostbyname%& option is false,
23447 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23448 in chapter &<<CHAPdnslookup>>& for more details.
23449
23450
23451 .option dns_search_parents smtp boolean false
23452 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23453 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23454 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23455 details.
23456
23457
23458 .option dnssec_request_domains smtp "domain list&!!" unset
23459 .cindex "MX record" "security"
23460 .cindex "DNSSEC" "MX lookup"
23461 .cindex "security" "MX lookup"
23462 .cindex "DNS" "DNSSEC"
23463 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23464 the dnssec request bit set.
23465 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23466
23467
23468
23469 .option dnssec_require_domains smtp "domain list&!!" unset
23470 .cindex "MX record" "security"
23471 .cindex "DNSSEC" "MX lookup"
23472 .cindex "security" "MX lookup"
23473 .cindex "DNS" "DNSSEC"
23474 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23475 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23476 (AD bit) set will be ignored and logged as a host-lookup failure.
23477 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23478
23479
23480
23481 .option dscp smtp string&!! unset
23482 .cindex "DCSP" "outbound"
23483 This option causes the DSCP value associated with a socket to be set to one
23484 of a number of fixed strings or to numeric value.
23485 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23486 Common values include &`throughput`&, &`mincost`&, and on newer systems
23487 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23488
23489 The outbound packets from Exim will be marked with this value in the header
23490 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23491 that these values will have any effect, not be stripped by networking
23492 equipment, or do much of anything without cooperation with your Network
23493 Engineer and those of all network operators between the source and destination.
23494
23495
23496 .option fallback_hosts smtp "string list" unset
23497 .cindex "fallback" "hosts specified on transport"
23498 String expansion is not applied to this option. The argument must be a
23499 colon-separated list of host names or IP addresses, optionally also including
23500 port numbers, though the separator can be changed, as described in section
23501 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23502 item in a &%route_list%& setting for the &(manualroute)& router, as described
23503 in section &<<SECTformatonehostitem>>&.
23504
23505 Fallback hosts can also be specified on routers, which associate them with the
23506 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23507 &%fallback_hosts%& specified on the transport is used only if the address does
23508 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23509 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23510 However, &%hosts_randomize%& does apply to fallback host lists.
23511
23512 If Exim is unable to deliver to any of the hosts for a particular address, and
23513 the errors are not permanent rejections, the address is put on a separate
23514 transport queue with its host list replaced by the fallback hosts, unless the
23515 address was routed via MX records and the current host was in the original MX
23516 list. In that situation, the fallback host list is not used.
23517
23518 Once normal deliveries are complete, the fallback queue is delivered by
23519 re-running the same transports with the new host lists. If several failing
23520 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23521 copy of the message is sent.
23522
23523 The resolution of the host names on the fallback list is controlled by the
23524 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23525 both to cases when the host list comes with the address and when it is taken
23526 from &%hosts%&. This option provides a &"use a smart host only if delivery
23527 fails"& facility.
23528
23529
23530 .option final_timeout smtp time 10m
23531 This is the timeout that applies while waiting for the response to the final
23532 line containing just &"."& that terminates a message. Its value must not be
23533 zero.
23534
23535 .option gethostbyname smtp boolean false
23536 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23537 being used, names are looked up using &[gethostbyname()]&
23538 (or &[getipnodebyname()]& when available)
23539 instead of using the DNS. Of course, that function may in fact use the DNS, but
23540 it may also consult other sources of information such as &_/etc/hosts_&.
23541
23542 .option gnutls_compat_mode smtp boolean unset
23543 This option controls whether GnuTLS is used in compatibility mode in an Exim
23544 server. This reduces security slightly, but improves interworking with older
23545 implementations of TLS.
23546
23547 .option helo_data smtp string&!! "see below"
23548 .cindex "HELO" "argument, setting"
23549 .cindex "EHLO" "argument, setting"
23550 .cindex "LHLO argument setting"
23551 The value of this option is expanded after a connection to a another host has
23552 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23553 command that starts the outgoing SMTP or LMTP session. The default value of the
23554 option is:
23555 .code
23556 $primary_hostname
23557 .endd
23558 During the expansion, the variables &$host$& and &$host_address$& are set to
23559 the identity of the remote host, and the variables &$sending_ip_address$& and
23560 &$sending_port$& are set to the local IP address and port number that are being
23561 used. These variables can be used to generate different values for different
23562 servers or different local IP addresses. For example, if you want the string
23563 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23564 interface address, you could use this:
23565 .code
23566 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23567   {$primary_hostname}}
23568 .endd
23569 The use of &%helo_data%& applies both to sending messages and when doing
23570 callouts.
23571
23572 .option hosts smtp "string list&!!" unset
23573 Hosts are associated with an address by a router such as &(dnslookup)&, which
23574 finds the hosts by looking up the address domain in the DNS, or by
23575 &(manualroute)&, which has lists of hosts in its configuration. However,
23576 email addresses can be passed to the &(smtp)& transport by any router, and not
23577 all of them can provide an associated list of hosts.
23578
23579 The &%hosts%& option specifies a list of hosts to be used if the address being
23580 processed does not have any hosts associated with it. The hosts specified by
23581 &%hosts%& are also used, whether or not the address has its own hosts, if
23582 &%hosts_override%& is set.
23583
23584 The string is first expanded, before being interpreted as a colon-separated
23585 list of host names or IP addresses, possibly including port numbers. The
23586 separator may be changed to something other than colon, as described in section
23587 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23588 item in a &%route_list%& setting for the &(manualroute)& router, as described
23589 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23590 of the &(manualroute)& router is not available here.
23591
23592 If the expansion fails, delivery is deferred. Unless the failure was caused by
23593 the inability to complete a lookup, the error is logged to the panic log as
23594 well as the main log. Host names are looked up either by searching directly for
23595 address records in the DNS or by calling &[gethostbyname()]& (or
23596 &[getipnodebyname()]& when available), depending on the setting of the
23597 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23598 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23599 address are used.
23600
23601 During delivery, the hosts are tried in order, subject to their retry status,
23602 unless &%hosts_randomize%& is set.
23603
23604
23605 .option hosts_avoid_esmtp smtp "host list&!!" unset
23606 .cindex "ESMTP, avoiding use of"
23607 .cindex "HELO" "forcing use of"
23608 .cindex "EHLO" "avoiding use of"
23609 .cindex "PIPELINING" "avoiding the use of"
23610 This option is for use with broken hosts that announce ESMTP facilities (for
23611 example, PIPELINING) and then fail to implement them properly. When a host
23612 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23613 start of the SMTP session. This means that it cannot use any of the ESMTP
23614 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23615
23616
23617 .option hosts_avoid_pipelining smtp "host list&!!" unset
23618 .cindex "PIPELINING" "avoiding the use of"
23619 Exim will not use the SMTP PIPELINING extension when delivering to any host
23620 that matches this list, even if the server host advertises PIPELINING support.
23621
23622
23623 .option hosts_avoid_tls smtp "host list&!!" unset
23624 .cindex "TLS" "avoiding for certain hosts"
23625 Exim will not try to start a TLS session when delivering to any host that
23626 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23627
23628 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23629 .cindex "TLS" "avoiding for certain hosts"
23630 Exim will not try to start a TLS session for a verify callout,
23631 or when delivering in cutthrough mode,
23632 to any host that matches this list.
23633
23634
23635 .option hosts_max_try smtp integer 5
23636 .cindex "host" "maximum number to try"
23637 .cindex "limit" "number of hosts tried"
23638 .cindex "limit" "number of MX tried"
23639 .cindex "MX record" "maximum tried"
23640 This option limits the number of IP addresses that are tried for any one
23641 delivery in cases where there are temporary delivery errors. Section
23642 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23643
23644
23645 .option hosts_max_try_hardlimit smtp integer 50
23646 This is an additional check on the maximum number of IP addresses that Exim
23647 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23648 why it exists.
23649
23650
23651
23652 .option hosts_nopass_tls smtp "host list&!!" unset
23653 .cindex "TLS" "passing connection"
23654 .cindex "multiple SMTP deliveries"
23655 .cindex "TLS" "multiple message deliveries"
23656 For any host that matches this list, a connection on which a TLS session has
23657 been started will not be passed to a new delivery process for sending another
23658 message on the same connection. See section &<<SECTmulmessam>>& for an
23659 explanation of when this might be needed.
23660
23661
23662 .option hosts_override smtp boolean false
23663 If this option is set and the &%hosts%& option is also set, any hosts that are
23664 attached to the address are ignored, and instead the hosts specified by the
23665 &%hosts%& option are always used. This option does not apply to
23666 &%fallback_hosts%&.
23667
23668
23669 .option hosts_randomize smtp boolean false
23670 .cindex "randomized host list"
23671 .cindex "host" "list of; randomized"
23672 .cindex "fallback" "randomized hosts"
23673 If this option is set, and either the list of hosts is taken from the
23674 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23675 were not obtained from MX records (this includes fallback hosts from the
23676 router), and were not randomized by the router, the order of trying the hosts
23677 is randomized each time the transport runs. Randomizing the order of a host
23678 list can be used to do crude load sharing.
23679
23680 When &%hosts_randomize%& is true, a host list may be split into groups whose
23681 order is separately randomized. This makes it possible to set up MX-like
23682 behaviour. The boundaries between groups are indicated by an item that is just
23683 &`+`& in the host list. For example:
23684 .code
23685 hosts = host1:host2:host3:+:host4:host5
23686 .endd
23687 The order of the first three hosts and the order of the last two hosts is
23688 randomized for each use, but the first three always end up before the last two.
23689 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23690
23691 .option hosts_require_auth smtp "host list&!!" unset
23692 .cindex "authentication" "required by client"
23693 This option provides a list of servers for which authentication must succeed
23694 before Exim will try to transfer a message. If authentication fails for
23695 servers which are not in this list, Exim tries to send unauthenticated. If
23696 authentication fails for one of these servers, delivery is deferred. This
23697 temporary error is detectable in the retry rules, so it can be turned into a
23698 hard failure if required. See also &%hosts_try_auth%&, and chapter
23699 &<<CHAPSMTPAUTH>>& for details of authentication.
23700
23701
23702 .option hosts_request_ocsp smtp "host list&!!" *
23703 .cindex "TLS" "requiring for certain servers"
23704 Exim will request a Certificate Status on a
23705 TLS session for any host that matches this list.
23706 &%tls_verify_certificates%& should also be set for the transport.
23707
23708 .option hosts_require_ocsp smtp "host list&!!" unset
23709 .cindex "TLS" "requiring for certain servers"
23710 Exim will request, and check for a valid Certificate Status being given, on a
23711 TLS session for any host that matches this list.
23712 &%tls_verify_certificates%& should also be set for the transport.
23713
23714 .option hosts_require_tls smtp "host list&!!" unset
23715 .cindex "TLS" "requiring for certain servers"
23716 Exim will insist on using a TLS session when delivering to any host that
23717 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23718 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23719 incoming messages, use an appropriate ACL.
23720
23721 .option hosts_try_auth smtp "host list&!!" unset
23722 .cindex "authentication" "optional in client"
23723 This option provides a list of servers to which, provided they announce
23724 authentication support, Exim will attempt to authenticate as a client when it
23725 connects. If authentication fails, Exim will try to transfer the message
23726 unauthenticated. See also &%hosts_require_auth%&, and chapter
23727 &<<CHAPSMTPAUTH>>& for details of authentication.
23728
23729 .option hosts_try_prdr smtp "host list&!!" *
23730 .cindex "PRDR" "enabling, optional in client"
23731 This option provides a list of servers to which, provided they announce
23732 PRDR support, Exim will attempt to negotiate PRDR
23733 for multi-recipient messages.
23734 The option can usually be left as default.
23735
23736 .option interface smtp "string list&!!" unset
23737 .cindex "bind IP address"
23738 .cindex "IP address" "binding"
23739 .vindex "&$host$&"
23740 .vindex "&$host_address$&"
23741 This option specifies which interface to bind to when making an outgoing SMTP
23742 call. The value is an IP address, not an interface name such as
23743 &`eth0`&. Do not confuse this with the interface address that was used when a
23744 message was received, which is in &$received_ip_address$&, formerly known as
23745 &$interface_address$&. The name was changed to minimize confusion with the
23746 outgoing interface address. There is no variable that contains an outgoing
23747 interface address because, unless it is set by this option, its value is
23748 unknown.
23749
23750 During the expansion of the &%interface%& option the variables &$host$& and
23751 &$host_address$& refer to the host to which a connection is about to be made
23752 during the expansion of the string. Forced expansion failure, or an empty
23753 string result causes the option to be ignored. Otherwise, after expansion, the
23754 string must be a list of IP addresses, colon-separated by default, but the
23755 separator can be changed in the usual way. For example:
23756 .code
23757 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23758 .endd
23759 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23760 connection. If none of them are the correct type, the option is ignored. If
23761 &%interface%& is not set, or is ignored, the system's IP functions choose which
23762 interface to use if the host has more than one.
23763
23764
23765 .option keepalive smtp boolean true
23766 .cindex "keepalive" "on outgoing connection"
23767 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23768 connections. When set, it causes the kernel to probe idle connections
23769 periodically, by sending packets with &"old"& sequence numbers. The other end
23770 of the connection should send a acknowledgment if the connection is still okay
23771 or a reset if the connection has been aborted. The reason for doing this is
23772 that it has the beneficial effect of freeing up certain types of connection
23773 that can get stuck when the remote host is disconnected without tidying up the
23774 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23775 unreachable hosts.
23776
23777
23778 .option lmtp_ignore_quota smtp boolean false
23779 .cindex "LMTP" "ignoring quota errors"
23780 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23781 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23782 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23783
23784 .option max_rcpt smtp integer 100
23785 .cindex "RCPT" "maximum number of outgoing"
23786 This option limits the number of RCPT commands that are sent in a single
23787 SMTP message transaction. Each set of addresses is treated independently, and
23788 so can cause parallel connections to the same host if &%remote_max_parallel%&
23789 permits this.
23790
23791
23792 .option multi_domain smtp boolean&!! true
23793 .vindex "&$domain$&"
23794 When this option is set, the &(smtp)& transport can handle a number of
23795 addresses containing a mixture of different domains provided they all resolve
23796 to the same list of hosts. Turning the option off restricts the transport to
23797 handling only one domain at a time. This is useful if you want to use
23798 &$domain$& in an expansion for the transport, because it is set only when there
23799 is a single domain involved in a remote delivery.
23800
23801 It is expanded per-address and can depend on any of
23802 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23803 &$host$&, &$host_address$& and &$host_port$&.
23804
23805 .option port smtp string&!! "see below"
23806 .cindex "port" "sending TCP/IP"
23807 .cindex "TCP/IP" "setting outgoing port"
23808 This option specifies the TCP/IP port on the server to which Exim connects.
23809 &*Note:*& Do not confuse this with the port that was used when a message was
23810 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23811 The name was changed to minimize confusion with the outgoing port. There is no
23812 variable that contains an outgoing port.
23813
23814 If the value of this option begins with a digit it is taken as a port number;
23815 otherwise it is looked up using &[getservbyname()]&. The default value is
23816 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23817 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23818 is deferred.
23819
23820
23821
23822 .option protocol smtp string smtp
23823 .cindex "LMTP" "over TCP/IP"
23824 .cindex "ssmtp protocol" "outbound"
23825 .cindex "TLS" "SSL-on-connect outbound"
23826 .vindex "&$port$&"
23827 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23828 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23829 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23830 deliveries into closed message stores. Exim also has support for running LMTP
23831 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23832
23833 If this option is set to &"smtps"&, the default value for the &%port%& option
23834 changes to &"smtps"&, and the transport initiates TLS immediately after
23835 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23836 The Internet standards bodies strongly discourage use of this mode.
23837
23838
23839 .option retry_include_ip_address smtp boolean&!! true
23840 Exim normally includes both the host name and the IP address in the key it
23841 constructs for indexing retry data after a temporary delivery failure. This
23842 means that when one of several IP addresses for a host is failing, it gets
23843 tried periodically (controlled by the retry rules), but use of the other IP
23844 addresses is not affected.
23845
23846 However, in some dialup environments hosts are assigned a different IP address
23847 each time they connect. In this situation the use of the IP address as part of
23848 the retry key leads to undesirable behaviour. Setting this option false causes
23849 Exim to use only the host name.
23850 Since it is expanded it can be made to depend on the host or domain.
23851
23852
23853 .option serialize_hosts smtp "host list&!!" unset
23854 .cindex "serializing connections"
23855 .cindex "host" "serializing connections"
23856 Because Exim operates in a distributed manner, if several messages for the same
23857 host arrive at around the same time, more than one simultaneous connection to
23858 the remote host can occur. This is not usually a problem except when there is a
23859 slow link between the hosts. In that situation it may be helpful to restrict
23860 Exim to one connection at a time. This can be done by setting
23861 &%serialize_hosts%& to match the relevant hosts.
23862
23863 .cindex "hints database" "serializing deliveries to a host"
23864 Exim implements serialization by means of a hints database in which a record is
23865 written whenever a process connects to one of the restricted hosts. The record
23866 is deleted when the connection is completed. Obviously there is scope for
23867 records to get left lying around if there is a system or program crash. To
23868 guard against this, Exim ignores any records that are more than six hours old.
23869
23870 If you set up this kind of serialization, you should also arrange to delete the
23871 relevant hints database whenever your system reboots. The names of the files
23872 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23873 may be one or two files, depending on the type of DBM in use. The same files
23874 are used for ETRN serialization.
23875
23876 .new
23877 See also the &%max_parallel%& generic transport option.
23878 .wen
23879
23880
23881 .option size_addition smtp integer 1024
23882 .cindex "SMTP" "SIZE"
23883 .cindex "message" "size issue for transport filter"
23884 .cindex "size" "of message"
23885 .cindex "transport" "filter"
23886 .cindex "filter" "transport filter"
23887 If a remote SMTP server indicates that it supports the SIZE option of the
23888 MAIL command, Exim uses this to pass over the message size at the start of
23889 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23890 sends, to allow for headers and other text that may be added during delivery by
23891 configuration options or in a transport filter. It may be necessary to increase
23892 this if a lot of text is added to messages.
23893
23894 Alternatively, if the value of &%size_addition%& is set negative, it disables
23895 the use of the SIZE option altogether.
23896
23897
23898 .new
23899 .option socks_proxy smtp string&!! unset
23900 .cindex proxy SOCKS
23901 This option enables use of SOCKS proxies for connections made by the
23902 transport.  For details see &<<SECTproxySOCKS>>&.
23903 .wen
23904
23905
23906 .option tls_certificate smtp string&!! unset
23907 .cindex "TLS" "client certificate, location of"
23908 .cindex "certificate" "client, location of"
23909 .vindex "&$host$&"
23910 .vindex "&$host_address$&"
23911 The value of this option must be the absolute path to a file which contains the
23912 client's certificate, for possible use when sending a message over an encrypted
23913 connection. The values of &$host$& and &$host_address$& are set to the name and
23914 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23915 details of TLS.
23916
23917 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23918 certificate when sending messages as a client. The global option of the same
23919 name specifies the certificate for Exim as a server; it is not automatically
23920 assumed that the same certificate should be used when Exim is operating as a
23921 client.
23922
23923
23924 .option tls_crl smtp string&!! unset
23925 .cindex "TLS" "client certificate revocation list"
23926 .cindex "certificate" "revocation list for client"
23927 This option specifies a certificate revocation list. The expanded value must
23928 be the name of a file that contains a CRL in PEM format.
23929
23930
23931 .option tls_dh_min_bits smtp integer 1024
23932 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23933 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23934 key agreement is negotiated, the server will provide a large prime number
23935 for use.  This option establishes the minimum acceptable size of that number.
23936 If the parameter offered by the server is too small, then the TLS handshake
23937 will fail.
23938
23939 Only supported when using GnuTLS.
23940
23941
23942 .option tls_privatekey smtp string&!! unset
23943 .cindex "TLS" "client private key, location of"
23944 .vindex "&$host$&"
23945 .vindex "&$host_address$&"
23946 The value of this option must be the absolute path to a file which contains the
23947 client's private key. This is used when sending a message over an encrypted
23948 connection using a client certificate. The values of &$host$& and
23949 &$host_address$& are set to the name and address of the server during the
23950 expansion. If this option is unset, or the expansion is forced to fail, or the
23951 result is an empty string, the private key is assumed to be in the same file as
23952 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23953
23954
23955 .option tls_require_ciphers smtp string&!! unset
23956 .cindex "TLS" "requiring specific ciphers"
23957 .cindex "cipher" "requiring specific"
23958 .vindex "&$host$&"
23959 .vindex "&$host_address$&"
23960 The value of this option must be a list of permitted cipher suites, for use
23961 when setting up an outgoing encrypted connection. (There is a global option of
23962 the same name for controlling incoming connections.) The values of &$host$& and
23963 &$host_address$& are set to the name and address of the server during the
23964 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23965 is used in different ways by OpenSSL and GnuTLS (see sections
23966 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23967 ciphers is a preference order.
23968
23969
23970
23971 .option tls_sni smtp string&!! unset
23972 .cindex "TLS" "Server Name Indication"
23973 .vindex "&$tls_sni$&"
23974 If this option is set then it sets the $tls_out_sni variable and causes any
23975 TLS session to pass this value as the Server Name Indication extension to
23976 the remote side, which can be used by the remote side to select an appropriate
23977 certificate and private key for the session.
23978
23979 See &<<SECTtlssni>>& for more information.
23980
23981 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23982 TLS extensions.
23983
23984
23985
23986
23987 .option tls_tempfail_tryclear smtp boolean true
23988 .cindex "4&'xx'& responses" "to STARTTLS"
23989 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23990 setting up a TLS session, this option determines whether or not Exim should try
23991 to deliver the message unencrypted. If it is set false, delivery to the
23992 current host is deferred; if there are other hosts, they are tried. If this
23993 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23994 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23995 TLS negotiation fails, Exim closes the current connection (because it is in an
23996 unknown state), opens a new one to the same host, and then tries the delivery
23997 in clear.
23998
23999
24000 .option tls_try_verify_hosts smtp "host list&!!" *
24001 .cindex "TLS" "server certificate verification"
24002 .cindex "certificate" "verification of server"
24003 This option gives a list of hosts for which, on encrypted connections,
24004 certificate verification will be tried but need not succeed.
24005 The &%tls_verify_certificates%& option must also be set.
24006 Note that unless the host is in this list
24007 TLS connections will be denied to hosts using self-signed certificates
24008 when &%tls_verify_certificates%& is matched.
24009 The &$tls_out_certificate_verified$& variable is set when
24010 certificate verification succeeds.
24011
24012
24013 .option tls_verify_cert_hostnames smtp "host list&!!" *
24014 .cindex "TLS" "server certificate hostname verification"
24015 .cindex "certificate" "verification of server"
24016 This option give a list of hosts for which,
24017 while verifying the server certificate,
24018 checks will be included on the host name
24019 (note that this will generally be the result of a DNS MX lookup)
24020 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24021 limited to being the initial component of a 3-or-more component FQDN.
24022
24023 There is no equivalent checking on client certificates.
24024
24025
24026 .option tls_verify_certificates smtp string&!! system
24027 .cindex "TLS" "server certificate verification"
24028 .cindex "certificate" "verification of server"
24029 .vindex "&$host$&"
24030 .vindex "&$host_address$&"
24031 The value of this option must be either the
24032 word "system"
24033 or the absolute path to
24034 a file or directory containing permitted certificates for servers,
24035 for use when setting up an encrypted connection.
24036
24037 The "system" value for the option will use a location compiled into the SSL library.
24038 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24039 is taken as empty and an explicit location
24040 must be specified.
24041
24042 The use of a directory for the option value is not available for GnuTLS versions
24043 preceding 3.3.6 and a single file must be used.
24044
24045 With OpenSSL the certificates specified
24046 explicitly
24047 either by file or directory
24048 are added to those given by the system default location.
24049
24050 The values of &$host$& and
24051 &$host_address$& are set to the name and address of the server during the
24052 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24053
24054 For back-compatibility,
24055 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24056 (a single-colon empty list counts as being set)
24057 and certificate verification fails the TLS connection is closed.
24058
24059
24060 .option tls_verify_hosts smtp "host list&!!" unset
24061 .cindex "TLS" "server certificate verification"
24062 .cindex "certificate" "verification of server"
24063 This option gives a list of hosts for which. on encrypted connections,
24064 certificate verification must succeed.
24065 The &%tls_verify_certificates%& option must also be set.
24066 If both this option and &%tls_try_verify_hosts%& are unset
24067 operation is as if this option selected all hosts.
24068
24069
24070
24071
24072 .section "How the limits for the number of hosts to try are used" &&&
24073          "SECTvalhosmax"
24074 .cindex "host" "maximum number to try"
24075 .cindex "limit" "hosts; maximum number tried"
24076 There are two options that are concerned with the number of hosts that are
24077 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24078 &%hosts_max_try_hardlimit%&.
24079
24080
24081 The &%hosts_max_try%& option limits the number of hosts that are tried
24082 for a single delivery. However, despite the term &"host"& in its name, the
24083 option actually applies to each IP address independently. In other words, a
24084 multihomed host is treated as several independent hosts, just as it is for
24085 retrying.
24086
24087 Many of the larger ISPs have multiple MX records which often point to
24088 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24089 created as a result of routing one of these domains.
24090
24091 Trying every single IP address on such a long list does not seem sensible; if
24092 several at the top of the list fail, it is reasonable to assume there is some
24093 problem that is likely to affect all of them. Roughly speaking, the value of
24094 &%hosts_max_try%& is the maximum number that are tried before deferring the
24095 delivery. However, the logic cannot be quite that simple.
24096
24097 Firstly, IP addresses that are skipped because their retry times have not
24098 arrived do not count, and in addition, addresses that are past their retry
24099 limits are also not counted, even when they are tried. This means that when
24100 some IP addresses are past their retry limits, more than the value of
24101 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24102 that all IP addresses are considered before timing out an email address (but
24103 see below for an exception).
24104
24105 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24106 list to see if there is a subsequent host with a different (higher valued) MX.
24107 If there is, that host is considered next, and the current IP address is used
24108 but not counted. This behaviour helps in the case of a domain with a retry rule
24109 that hardly ever delays any hosts, as is now explained:
24110
24111 Consider the case of a long list of hosts with one MX value, and a few with a
24112 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24113 hosts at the top of the list are tried at first. With the default retry rule,
24114 which specifies increasing retry times, the higher MX hosts are eventually
24115 tried when those at the top of the list are skipped because they have not
24116 reached their retry times.
24117
24118 However, it is common practice to put a fixed short retry time on domains for
24119 large ISPs, on the grounds that their servers are rarely down for very long.
24120 Unfortunately, these are exactly the domains that tend to resolve to long lists
24121 of hosts. The short retry time means that the lowest MX hosts are tried every
24122 time. The attempts may be in a different order because of random sorting, but
24123 without the special MX check, the higher MX hosts would never be tried until
24124 all the lower MX hosts had timed out (which might be several days), because
24125 there are always some lower MX hosts that have reached their retry times. With
24126 the special check, Exim considers at least one IP address from each MX value at
24127 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24128 reached.
24129
24130 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24131 particular, Exim normally eventually tries all the IP addresses before timing
24132 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24133 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24134 been set up with hundreds of IP addresses for some domains. It can
24135 take a very long time indeed for an address to time out in these cases.
24136
24137 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24138 Exim never tries more than this number of IP addresses; if it hits this limit
24139 and they are all timed out, the email address is bounced, even though not all
24140 possible IP addresses have been tried.
24141 .ecindex IIDsmttra1
24142 .ecindex IIDsmttra2
24143
24144
24145
24146
24147
24148 . ////////////////////////////////////////////////////////////////////////////
24149 . ////////////////////////////////////////////////////////////////////////////
24150
24151 .chapter "Address rewriting" "CHAPrewrite"
24152 .scindex IIDaddrew "rewriting" "addresses"
24153 There are some circumstances in which Exim automatically rewrites domains in
24154 addresses. The two most common are when an address is given without a domain
24155 (referred to as an &"unqualified address"&) or when an address contains an
24156 abbreviated domain that is expanded by DNS lookup.
24157
24158 Unqualified envelope addresses are accepted only for locally submitted
24159 messages, or for messages that are received from hosts matching
24160 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24161 appropriate. Unqualified addresses in header lines are qualified if they are in
24162 locally submitted messages, or messages from hosts that are permitted to send
24163 unqualified envelope addresses. Otherwise, unqualified addresses in header
24164 lines are neither qualified nor rewritten.
24165
24166 One situation in which Exim does &'not'& automatically rewrite a domain is
24167 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24168 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24169 do this. The new RFCs do not contain this suggestion.
24170
24171
24172 .section "Explicitly configured address rewriting" "SECID147"
24173 This chapter describes the rewriting rules that can be used in the
24174 main rewrite section of the configuration file, and also in the generic
24175 &%headers_rewrite%& option that can be set on any transport.
24176
24177 Some people believe that configured address rewriting is a Mortal Sin.
24178 Others believe that life is not possible without it. Exim provides the
24179 facility; you do not have to use it.
24180
24181 The main rewriting rules that appear in the &"rewrite"& section of the
24182 configuration file are applied to addresses in incoming messages, both envelope
24183 addresses and addresses in header lines. Each rule specifies the types of
24184 address to which it applies.
24185
24186 Whether or not addresses in header lines are rewritten depends on the origin of
24187 the headers and the type of rewriting. Global rewriting, that is, rewriting
24188 rules from the rewrite section of the configuration file, is applied only to
24189 those headers that were received with the message. Header lines that are added
24190 by ACLs or by a system filter or by individual routers or transports (which
24191 are specific to individual recipient addresses) are not rewritten by the global
24192 rules.
24193
24194 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24195 applies all headers except those added by routers and transports. That is, as
24196 well as the headers that were received with the message, it also applies to
24197 headers that were added by an ACL or a system filter.
24198
24199
24200 In general, rewriting addresses from your own system or domain has some
24201 legitimacy. Rewriting other addresses should be done only with great care and
24202 in special circumstances. The author of Exim believes that rewriting should be
24203 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24204 Although it can sometimes be used as a routing tool, this is very strongly
24205 discouraged.
24206
24207 There are two commonly encountered circumstances where rewriting is used, as
24208 illustrated by these examples:
24209
24210 .ilist
24211 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24212 exchange mail with each other behind a firewall, but there is only a single
24213 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24214 &'hitch.fict.example'& when sending mail off-site.
24215 .next
24216 A host rewrites the local parts of its own users so that, for example,
24217 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24218 .endlist
24219
24220
24221
24222 .section "When does rewriting happen?" "SECID148"
24223 .cindex "rewriting" "timing of"
24224 .cindex "&ACL;" "rewriting addresses in"
24225 Configured address rewriting can take place at several different stages of a
24226 message's processing.
24227
24228 .vindex "&$sender_address$&"
24229 At the start of an ACL for MAIL, the sender address may have been rewritten
24230 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24231 ordinary rewrite rules have yet been applied. If, however, the sender address
24232 is verified in the ACL, it is rewritten before verification, and remains
24233 rewritten thereafter. The subsequent value of &$sender_address$& is the
24234 rewritten address. This also applies if sender verification happens in a
24235 RCPT ACL. Otherwise, when the sender address is not verified, it is
24236 rewritten as soon as a message's header lines have been received.
24237
24238 .vindex "&$domain$&"
24239 .vindex "&$local_part$&"
24240 Similarly, at the start of an ACL for RCPT, the current recipient's address
24241 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24242 rewrite rules have yet been applied to it. However, the behaviour is different
24243 from the sender address when a recipient is verified. The address is rewritten
24244 for the verification, but the rewriting is not remembered at this stage. The
24245 value of &$local_part$& and &$domain$& after verification are always the same
24246 as they were before (that is, they contain the unrewritten &-- except for
24247 SMTP-time rewriting &-- address).
24248
24249 As soon as a message's header lines have been received, all the envelope
24250 recipient addresses are permanently rewritten, and rewriting is also applied to
24251 the addresses in the header lines (if configured). This happens before adding
24252 any header lines that were specified in MAIL or RCPT ACLs, and
24253 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24254 before the DATA ACL and &[local_scan()]& functions are run.
24255
24256 When an address is being routed, either for delivery or for verification,
24257 rewriting is applied immediately to child addresses that are generated by
24258 redirection, unless &%no_rewrite%& is set on the router.
24259
24260 .cindex "envelope sender" "rewriting at transport time"
24261 .cindex "rewriting" "at transport time"
24262 .cindex "header lines" "rewriting at transport time"
24263 At transport time, additional rewriting of addresses in header lines can be
24264 specified by setting the generic &%headers_rewrite%& option on a transport.
24265 This option contains rules that are identical in form to those in the rewrite
24266 section of the configuration file. They are applied to the original message
24267 header lines and any that were added by ACLs or a system filter. They are not
24268 applied to header lines that are added by routers or the transport.
24269
24270 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24271 transport option. However, it is not possible to rewrite envelope recipients at
24272 transport time.
24273
24274
24275
24276
24277 .section "Testing the rewriting rules that apply on input" "SECID149"
24278 .cindex "rewriting" "testing"
24279 .cindex "testing" "rewriting"
24280 Exim's input rewriting configuration appears in a part of the run time
24281 configuration file headed by &"begin rewrite"&. It can be tested by the
24282 &%-brw%& command line option. This takes an address (which can be a full RFC
24283 2822 address) as its argument. The output is a list of how the address would be
24284 transformed by the rewriting rules for each of the different places it might
24285 appear in an incoming message, that is, for each different header and for the
24286 envelope sender and recipient fields. For example,
24287 .code
24288 exim -brw ph10@exim.workshop.example
24289 .endd
24290 might produce the output
24291 .code
24292 sender: Philip.Hazel@exim.workshop.example
24293 from: Philip.Hazel@exim.workshop.example
24294 to: ph10@exim.workshop.example
24295 cc: ph10@exim.workshop.example
24296 bcc: ph10@exim.workshop.example
24297 reply-to: Philip.Hazel@exim.workshop.example
24298 env-from: Philip.Hazel@exim.workshop.example
24299 env-to: ph10@exim.workshop.example
24300 .endd
24301 which shows that rewriting has been set up for that address when used in any of
24302 the source fields, but not when it appears as a recipient address. At the
24303 present time, there is no equivalent way of testing rewriting rules that are
24304 set for a particular transport.
24305
24306
24307 .section "Rewriting rules" "SECID150"
24308 .cindex "rewriting" "rules"
24309 The rewrite section of the configuration file consists of lines of rewriting
24310 rules in the form
24311 .display
24312 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24313 .endd
24314 Rewriting rules that are specified for the &%headers_rewrite%& generic
24315 transport option are given as a colon-separated list. Each item in the list
24316 takes the same form as a line in the main rewriting configuration (except that
24317 any colons must be doubled, of course).
24318
24319 The formats of source patterns and replacement strings are described below.
24320 Each is terminated by white space, unless enclosed in double quotes, in which
24321 case normal quoting conventions apply inside the quotes. The flags are single
24322 characters which may appear in any order. Spaces and tabs between them are
24323 ignored.
24324
24325 For each address that could potentially be rewritten, the rules are scanned in
24326 order, and replacements for the address from earlier rules can themselves be
24327 replaced by later rules (but see the &"q"& and &"R"& flags).
24328
24329 The order in which addresses are rewritten is undefined, may change between
24330 releases, and must not be relied on, with one exception: when a message is
24331 received, the envelope sender is always rewritten first, before any header
24332 lines are rewritten. For example, the replacement string for a rewrite of an
24333 address in &'To:'& must not assume that the message's address in &'From:'& has
24334 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24335 that the envelope sender has already been rewritten.
24336
24337 .vindex "&$domain$&"
24338 .vindex "&$local_part$&"
24339 The variables &$local_part$& and &$domain$& can be used in the replacement
24340 string to refer to the address that is being rewritten. Note that lookup-driven
24341 rewriting can be done by a rule of the form
24342 .code
24343 *@*   ${lookup ...
24344 .endd
24345 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24346 refer to the address that is being rewritten.
24347
24348
24349 .section "Rewriting patterns" "SECID151"
24350 .cindex "rewriting" "patterns"
24351 .cindex "address list" "in a rewriting pattern"
24352 The source pattern in a rewriting rule is any item which may appear in an
24353 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24354 single-item address list, which means that it is expanded before being tested
24355 against the address. As always, if you use a regular expression as a pattern,
24356 you must take care to escape dollar and backslash characters, or use the &`\N`&
24357 facility to suppress string expansion within the regular expression.
24358
24359 Domains in patterns should be given in lower case. Local parts in patterns are
24360 case-sensitive. If you want to do case-insensitive matching of local parts, you
24361 can use a regular expression that starts with &`^(?i)`&.
24362
24363 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24364 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24365 depending on the type of match which occurred. These can be used in the
24366 replacement string to insert portions of the incoming address. &$0$& always
24367 refers to the complete incoming address. When a regular expression is used, the
24368 numerical variables are set from its capturing subexpressions. For other types
24369 of pattern they are set as follows:
24370
24371 .ilist
24372 If a local part or domain starts with an asterisk, the numerical variables
24373 refer to the character strings matched by asterisks, with &$1$& associated with
24374 the first asterisk, and &$2$& with the second, if present. For example, if the
24375 pattern
24376 .code
24377 *queen@*.fict.example
24378 .endd
24379 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24380 .code
24381 $0 = hearts-queen@wonderland.fict.example
24382 $1 = hearts-
24383 $2 = wonderland
24384 .endd
24385 Note that if the local part does not start with an asterisk, but the domain
24386 does, it is &$1$& that contains the wild part of the domain.
24387
24388 .next
24389 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24390 of the domain are placed in the next available numerical variables. Suppose,
24391 for example, that the address &'foo@bar.baz.example'& is processed by a
24392 rewriting rule of the form
24393 .display
24394 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24395 .endd
24396 and the key in the file that matches the domain is &`*.baz.example`&. Then
24397 .code
24398 $1 = foo
24399 $2 = bar
24400 $3 = baz.example
24401 .endd
24402 If the address &'foo@baz.example'& is looked up, this matches the same
24403 wildcard file entry, and in this case &$2$& is set to the empty string, but
24404 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24405 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24406 whole domain. For non-partial domain lookups, no numerical variables are set.
24407 .endlist
24408
24409
24410 .section "Rewriting replacements" "SECID152"
24411 .cindex "rewriting" "replacements"
24412 If the replacement string for a rule is a single asterisk, addresses that
24413 match the pattern and the flags are &'not'& rewritten, and no subsequent
24414 rewriting rules are scanned. For example,
24415 .code
24416 hatta@lookingglass.fict.example  *  f
24417 .endd
24418 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24419 &'From:'& headers.
24420
24421 .vindex "&$domain$&"
24422 .vindex "&$local_part$&"
24423 If the replacement string is not a single asterisk, it is expanded, and must
24424 yield a fully qualified address. Within the expansion, the variables
24425 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24426 Any letters they contain retain their original case &-- they are not lower
24427 cased. The numerical variables are set up according to the type of pattern that
24428 matched the address, as described above. If the expansion is forced to fail by
24429 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24430 current rule is abandoned, but subsequent rules may take effect. Any other
24431 expansion failure causes the entire rewriting operation to be abandoned, and an
24432 entry written to the panic log.
24433
24434
24435
24436 .section "Rewriting flags" "SECID153"
24437 There are three different kinds of flag that may appear on rewriting rules:
24438
24439 .ilist
24440 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24441 c, f, h, r, s, t.
24442 .next
24443 A flag that specifies rewriting at SMTP time: S.
24444 .next
24445 Flags that control the rewriting process: Q, q, R, w.
24446 .endlist
24447
24448 For rules that are part of the &%headers_rewrite%& generic transport option,
24449 E, F, T, and S are not permitted.
24450
24451
24452
24453 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24454          "SECID154"
24455 .cindex "rewriting" "flags"
24456 If none of the following flag letters, nor the &"S"& flag (see section
24457 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24458 and to both the sender and recipient fields of the envelope, whereas a
24459 transport-time rewriting rule just applies to all headers. Otherwise, the
24460 rewriting rule is skipped unless the relevant addresses are being processed.
24461 .display
24462 &`E`&       rewrite all envelope fields
24463 &`F`&       rewrite the envelope From field
24464 &`T`&       rewrite the envelope To field
24465 &`b`&       rewrite the &'Bcc:'& header
24466 &`c`&       rewrite the &'Cc:'& header
24467 &`f`&       rewrite the &'From:'& header
24468 &`h`&       rewrite all headers
24469 &`r`&       rewrite the &'Reply-To:'& header
24470 &`s`&       rewrite the &'Sender:'& header
24471 &`t`&       rewrite the &'To:'& header
24472 .endd
24473 "All headers" means all of the headers listed above that can be selected
24474 individually, plus their &'Resent-'& versions. It does not include
24475 other headers such as &'Subject:'& etc.
24476
24477 You should be particularly careful about rewriting &'Sender:'& headers, and
24478 restrict this to special known cases in your own domains.
24479
24480
24481 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24482 .cindex "SMTP" "rewriting malformed addresses"
24483 .cindex "RCPT" "rewriting argument of"
24484 .cindex "MAIL" "rewriting argument of"
24485 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24486 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24487 before any other processing; even before syntax checking. The pattern is
24488 required to be a regular expression, and it is matched against the whole of the
24489 data for the command, including any surrounding angle brackets.
24490
24491 .vindex "&$domain$&"
24492 .vindex "&$local_part$&"
24493 This form of rewrite rule allows for the handling of addresses that are not
24494 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24495 input). Because the input is not required to be a syntactically valid address,
24496 the variables &$local_part$& and &$domain$& are not available during the
24497 expansion of the replacement string. The result of rewriting replaces the
24498 original address in the MAIL or RCPT command.
24499
24500
24501 .section "Flags controlling the rewriting process" "SECID155"
24502 There are four flags which control the way the rewriting process works. These
24503 take effect only when a rule is invoked, that is, when the address is of the
24504 correct type (matches the flags) and matches the pattern:
24505
24506 .ilist
24507 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24508 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24509 absence of &"Q"& the rewritten address must always include a domain.
24510 .next
24511 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24512 even if no rewriting actually takes place because of a &"fail"& in the
24513 expansion. The &"q"& flag is not effective if the address is of the wrong type
24514 (does not match the flags) or does not match the pattern.
24515 .next
24516 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24517 address, up to ten times. It can be combined with the &"q"& flag, to stop
24518 rewriting once it fails to match (after at least one successful rewrite).
24519 .next
24520 .cindex "rewriting" "whole addresses"
24521 When an address in a header is rewritten, the rewriting normally applies only
24522 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24523 left unchanged. For example, rewriting might change
24524 .code
24525 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24526 .endd
24527 into
24528 .code
24529 From: Ford Prefect <prefectf@hitch.fict.example>
24530 .endd
24531 .cindex "RFC 2047"
24532 Sometimes there is a need to replace the whole address item, and this can be
24533 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24534 causes an address in a header line to be rewritten, the entire address is
24535 replaced, not just the working part. The replacement must be a complete RFC
24536 2822 address, including the angle brackets if necessary. If text outside angle
24537 brackets contains a character whose value is greater than 126 or less than 32
24538 (except for tab), the text is encoded according to RFC 2047. The character set
24539 is taken from &%headers_charset%&, which gets its default at build time.
24540
24541 When the &"w"& flag is set on a rule that causes an envelope address to be
24542 rewritten, all but the working part of the replacement address is discarded.
24543 .endlist
24544
24545
24546 .section "Rewriting examples" "SECID156"
24547 Here is an example of the two common rewriting paradigms:
24548 .code
24549 *@*.hitch.fict.example  $1@hitch.fict.example
24550 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24551                      {$value}fail}@hitch.fict.example bctfrF
24552 .endd
24553 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24554 the string expansion to fail if the lookup does not succeed. In this context it
24555 has the effect of leaving the original address unchanged, but Exim goes on to
24556 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24557 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24558 explicitly, which would cause the rewritten address to be the same as before,
24559 at the cost of a small bit of processing. Not supplying either of these is an
24560 error, since the rewritten address would then contain no local part.
24561
24562 The first example above replaces the domain with a superior, more general
24563 domain. This may not be desirable for certain local parts. If the rule
24564 .code
24565 root@*.hitch.fict.example  *
24566 .endd
24567 were inserted before the first rule, rewriting would be suppressed for the
24568 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24569
24570 Rewriting can be made conditional on a number of tests, by making use of
24571 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24572 messages that originate outside the local host:
24573 .code
24574 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24575                          {$1@hitch.fict.example}fail}"
24576 .endd
24577 The replacement string is quoted in this example because it contains white
24578 space.
24579
24580 .cindex "rewriting" "bang paths"
24581 .cindex "bang paths" "rewriting"
24582 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24583 an address it treats it as an unqualified local part which it qualifies with
24584 the local qualification domain (if the source of the message is local or if the
24585 remote host is permitted to send unqualified addresses). Rewriting can
24586 sometimes be used to handle simple bang paths with a fixed number of
24587 components. For example, the rule
24588 .code
24589 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24590 .endd
24591 rewrites a two-component bang path &'host.name!user'& as the domain address
24592 &'user@host.name'&. However, there is a security implication in using this as
24593 a global rewriting rule for envelope addresses. It can provide a backdoor
24594 method for using your system as a relay, because the incoming addresses appear
24595 to be local. If the bang path addresses are received via SMTP, it is safer to
24596 use the &"S"& flag to rewrite them as they are received, so that relay checking
24597 can be done on the rewritten addresses.
24598 .ecindex IIDaddrew
24599
24600
24601
24602
24603
24604 . ////////////////////////////////////////////////////////////////////////////
24605 . ////////////////////////////////////////////////////////////////////////////
24606
24607 .chapter "Retry configuration" "CHAPretry"
24608 .scindex IIDretconf1 "retry" "configuration, description of"
24609 .scindex IIDregconf2 "configuration file" "retry section"
24610 The &"retry"& section of the runtime configuration file contains a list of
24611 retry rules that control how often Exim tries to deliver messages that cannot
24612 be delivered at the first attempt. If there are no retry rules (the section is
24613 empty or not present), there are no retries. In this situation, temporary
24614 errors are treated as permanent. The default configuration contains a single,
24615 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24616 line option can be used to test which retry rule will be used for a given
24617 address, domain and error.
24618
24619 The most common cause of retries is temporary failure to deliver to a remote
24620 host because the host is down, or inaccessible because of a network problem.
24621 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24622 address) basis, not on a per-message basis. Thus, if one message has recently
24623 been delayed, delivery of a new message to the same host is not immediately
24624 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24625 log selector is set, the message
24626 .cindex "retry" "time not reached"
24627 &"retry time not reached"& is written to the main log whenever a delivery is
24628 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24629 the handling of errors during remote deliveries.
24630
24631 Retry processing applies to routing as well as to delivering, except as covered
24632 in the next paragraph. The retry rules do not distinguish between these
24633 actions. It is not possible, for example, to specify different behaviour for
24634 failures to route the domain &'snark.fict.example'& and failures to deliver to
24635 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24636 added complication, so did not implement it. However, although they share the
24637 same retry rule, the actual retry times for routing and transporting a given
24638 domain are maintained independently.
24639
24640 When a delivery is not part of a queue run (typically an immediate delivery on
24641 receipt of a message), the routers are always run, and local deliveries are
24642 always attempted, even if retry times are set for them. This makes for better
24643 behaviour if one particular message is causing problems (for example, causing
24644 quota overflow, or provoking an error in a filter file). If such a delivery
24645 suffers a temporary failure, the retry data is updated as normal, and
24646 subsequent delivery attempts from queue runs occur only when the retry time for
24647 the local address is reached.
24648
24649 .section "Changing retry rules" "SECID157"
24650 If you change the retry rules in your configuration, you should consider
24651 whether or not to delete the retry data that is stored in Exim's spool area in
24652 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24653 always safe; that is why they are called &"hints"&.
24654
24655 The hints retry data contains suggested retry times based on the previous
24656 rules. In the case of a long-running problem with a remote host, it might
24657 record the fact that the host has timed out. If your new rules increase the
24658 timeout time for such a host, you should definitely remove the old retry data
24659 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24660 messages that it should now be retaining.
24661
24662
24663
24664 .section "Format of retry rules" "SECID158"
24665 .cindex "retry" "rules"
24666 Each retry rule occupies one line and consists of three or four parts,
24667 separated by white space: a pattern, an error name, an optional list of sender
24668 addresses, and a list of retry parameters. The pattern and sender lists must be
24669 enclosed in double quotes if they contain white space. The rules are searched
24670 in order until one is found where the pattern, error name, and sender list (if
24671 present) match the failing host or address, the error that occurred, and the
24672 message's sender, respectively.
24673
24674
24675 The pattern is any single item that may appear in an address list (see section
24676 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24677 which means that it is expanded before being tested against the address that
24678 has been delayed. A negated address list item is permitted. Address
24679 list processing treats a plain domain name as if it were preceded by &"*@"&,
24680 which makes it possible for many retry rules to start with just a domain. For
24681 example,
24682 .code
24683 lookingglass.fict.example        *  F,24h,30m;
24684 .endd
24685 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24686 whereas
24687 .code
24688 alice@lookingglass.fict.example  *  F,24h,30m;
24689 .endd
24690 applies only to temporary failures involving the local part &%alice%&.
24691 In practice, almost all rules start with a domain name pattern without a local
24692 part.
24693
24694 .cindex "regular expressions" "in retry rules"
24695 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24696 must match a complete address, not just a domain, because that is how regular
24697 expressions work in address lists.
24698 .display
24699 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24700 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24701 .endd
24702
24703
24704 .section "Choosing which retry rule to use for address errors" "SECID159"
24705 When Exim is looking for a retry rule after a routing attempt has failed (for
24706 example, after a DNS timeout), each line in the retry configuration is tested
24707 against the complete address only if &%retry_use_local_part%& is set for the
24708 router. Otherwise, only the domain is used, except when matching against a
24709 regular expression, when the local part of the address is replaced with &"*"&.
24710 A domain on its own can match a domain pattern, or a pattern that starts with
24711 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24712 &%check_local_user%& is true, and false for other routers.
24713
24714 Similarly, when Exim is looking for a retry rule after a local delivery has
24715 failed (for example, after a mailbox full error), each line in the retry
24716 configuration is tested against the complete address only if
24717 &%retry_use_local_part%& is set for the transport (it defaults true for all
24718 local transports).
24719
24720 .cindex "4&'xx'& responses" "retry rules for"
24721 However, when Exim is looking for a retry rule after a remote delivery attempt
24722 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24723 whole address is always used as the key when searching the retry rules. The
24724 rule that is found is used to create a retry time for the combination of the
24725 failing address and the message's sender. It is the combination of sender and
24726 recipient that is delayed in subsequent queue runs until its retry time is
24727 reached. You can delay the recipient without regard to the sender by setting
24728 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24729 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24730 commands.
24731
24732
24733
24734 .section "Choosing which retry rule to use for host and message errors" &&&
24735          "SECID160"
24736 For a temporary error that is not related to an individual address (for
24737 example, a connection timeout), each line in the retry configuration is checked
24738 twice. First, the name of the remote host is used as a domain name (preceded by
24739 &"*@"& when matching a regular expression). If this does not match the line,
24740 the domain from the email address is tried in a similar fashion. For example,
24741 suppose the MX records for &'a.b.c.example'& are
24742 .code
24743 a.b.c.example  MX  5  x.y.z.example
24744                MX  6  p.q.r.example
24745                MX  7  m.n.o.example
24746 .endd
24747 and the retry rules are
24748 .code
24749 p.q.r.example    *      F,24h,30m;
24750 a.b.c.example    *      F,4d,45m;
24751 .endd
24752 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24753 first rule matches neither the host nor the domain, so Exim looks at the second
24754 rule. This does not match the host, but it does match the domain, so it is used
24755 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24756 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24757 first retry rule is used, because it matches the host.
24758
24759 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24760 first rule to determine retry times, but for all the other hosts for the domain
24761 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24762 routing to &'a.b.c.example'& suffers a temporary failure.
24763
24764 &*Note*&: The host name is used when matching the patterns, not its IP address.
24765 However, if a message is routed directly to an IP address without the use of a
24766 host name, for example, if a &(manualroute)& router contains a setting such as:
24767 .code
24768 route_list = *.a.example  192.168.34.23
24769 .endd
24770 then the &"host name"& that is used when searching for a retry rule is the
24771 textual form of the IP address.
24772
24773 .section "Retry rules for specific errors" "SECID161"
24774 .cindex "retry" "specific errors; specifying"
24775 The second field in a retry rule is the name of a particular error, or an
24776 asterisk, which matches any error. The errors that can be tested for are:
24777
24778 .vlist
24779 .vitem &%auth_failed%&
24780 Authentication failed when trying to send to a host in the
24781 &%hosts_require_auth%& list in an &(smtp)& transport.
24782
24783 .vitem &%data_4xx%&
24784 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24785 after the command, or after sending the message's data.
24786
24787 .vitem &%mail_4xx%&
24788 A 4&'xx'& error was received for an outgoing MAIL command.
24789
24790 .vitem &%rcpt_4xx%&
24791 A 4&'xx'& error was received for an outgoing RCPT command.
24792 .endlist
24793
24794 For the three 4&'xx'& errors, either the first or both of the x's can be given
24795 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24796 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24797 and have retries every ten minutes with a one-hour timeout, you could set up a
24798 retry rule of this form:
24799 .code
24800 the.domain.name  rcpt_452   F,1h,10m
24801 .endd
24802 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24803 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24804
24805 .vlist
24806 .vitem &%lost_connection%&
24807 A server unexpectedly closed the SMTP connection. There may, of course,
24808 legitimate reasons for this (host died, network died), but if it repeats a lot
24809 for the same host, it indicates something odd.
24810
24811 .vitem &%lookup%&
24812 A DNS lookup for a host failed.
24813 Note that a &%dnslookup%& router will need to have matched
24814 its &%fail_defer_domains%& option for this retry type to be usable.
24815 Also note that a &%manualroute%& router will probably need
24816 its &%host_find_failed%& option set to &%defer%&.
24817
24818 .vitem &%refused_MX%&
24819 A connection to a host obtained from an MX record was refused.
24820
24821 .vitem &%refused_A%&
24822 A connection to a host not obtained from an MX record was refused.
24823
24824 .vitem &%refused%&
24825 A connection was refused.
24826
24827 .vitem &%timeout_connect_MX%&
24828 A connection attempt to a host obtained from an MX record timed out.
24829
24830 .vitem &%timeout_connect_A%&
24831 A connection attempt to a host not obtained from an MX record timed out.
24832
24833 .vitem &%timeout_connect%&
24834 A connection attempt timed out.
24835
24836 .vitem &%timeout_MX%&
24837 There was a timeout while connecting or during an SMTP session with a host
24838 obtained from an MX record.
24839
24840 .vitem &%timeout_A%&
24841 There was a timeout while connecting or during an SMTP session with a host not
24842 obtained from an MX record.
24843
24844 .vitem &%timeout%&
24845 There was a timeout while connecting or during an SMTP session.
24846
24847 .vitem &%tls_required%&
24848 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24849 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24850 to STARTTLS, or there was a problem setting up the TLS connection.
24851
24852 .vitem &%quota%&
24853 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24854 transport.
24855
24856 .vitem &%quota_%&<&'time'&>
24857 .cindex "quota" "error testing in retry rule"
24858 .cindex "retry" "quota error testing"
24859 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24860 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24861 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24862 for four days.
24863 .endlist
24864
24865 .cindex "mailbox" "time of last read"
24866 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24867 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24868 it should be based on the last time that the user accessed the mailbox.
24869 However, it is not always possible to determine this. Exim uses the following
24870 heuristic rules:
24871
24872 .ilist
24873 If the mailbox is a single file, the time of last access (the &"atime"&) is
24874 used. As no new messages are being delivered (because the mailbox is over
24875 quota), Exim does not access the file, so this is the time of last user access.
24876 .next
24877 .cindex "maildir format" "time of last read"
24878 For a maildir delivery, the time of last modification of the &_new_&
24879 subdirectory is used. As the mailbox is over quota, no new files are created in
24880 the &_new_& subdirectory, because no new messages are being delivered. Any
24881 change to the &_new_& subdirectory is therefore assumed to be the result of an
24882 MUA moving a new message to the &_cur_& directory when it is first read. The
24883 time that is used is therefore the last time that the user read a new message.
24884 .next
24885 For other kinds of multi-file mailbox, the time of last access cannot be
24886 obtained, so a retry rule that uses this type of error field is never matched.
24887 .endlist
24888
24889 The quota errors apply both to system-enforced quotas and to Exim's own quota
24890 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24891 when a local delivery is deferred because a partition is full (the ENOSPC
24892 error).
24893
24894
24895
24896 .section "Retry rules for specified senders" "SECID162"
24897 .cindex "retry" "rules; sender-specific"
24898 You can specify retry rules that apply only when the failing message has a
24899 specific sender. In particular, this can be used to define retry rules that
24900 apply only to bounce messages. The third item in a retry rule can be of this
24901 form:
24902 .display
24903 &`senders=`&<&'address list'&>
24904 .endd
24905 The retry timings themselves are then the fourth item. For example:
24906 .code
24907 *   rcpt_4xx   senders=:   F,1h,30m
24908 .endd
24909 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24910 host. If the address list contains white space, it must be enclosed in quotes.
24911 For example:
24912 .code
24913 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24914 .endd
24915 &*Warning*&: This facility can be unhelpful if it is used for host errors
24916 (which do not depend on the recipient). The reason is that the sender is used
24917 only to match the retry rule. Once the rule has been found for a host error,
24918 its contents are used to set a retry time for the host, and this will apply to
24919 all messages, not just those with specific senders.
24920
24921 When testing retry rules using &%-brt%&, you can supply a sender using the
24922 &%-f%& command line option, like this:
24923 .code
24924 exim -f "" -brt user@dom.ain
24925 .endd
24926 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24927 list is never matched.
24928
24929
24930
24931
24932
24933 .section "Retry parameters" "SECID163"
24934 .cindex "retry" "parameters in rules"
24935 The third (or fourth, if a senders list is present) field in a retry rule is a
24936 sequence of retry parameter sets, separated by semicolons. Each set consists of
24937 .display
24938 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24939 .endd
24940 The letter identifies the algorithm for computing a new retry time; the cutoff
24941 time is the time beyond which this algorithm no longer applies, and the
24942 arguments vary the algorithm's action. The cutoff time is measured from the
24943 time that the first failure for the domain (combined with the local part if
24944 relevant) was detected, not from the time the message was received.
24945
24946 .cindex "retry" "algorithms"
24947 .cindex "retry" "fixed intervals"
24948 .cindex "retry" "increasing intervals"
24949 .cindex "retry" "random intervals"
24950 The available algorithms are:
24951
24952 .ilist
24953 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24954 the interval.
24955 .next
24956 &'G'&: retry at geometrically increasing intervals. The first argument
24957 specifies a starting value for the interval, and the second a multiplier, which
24958 is used to increase the size of the interval at each retry.
24959 .next
24960 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24961 retry, the previous interval is multiplied by the factor in order to get a
24962 maximum for the next interval. The minimum interval is the first argument of
24963 the parameter, and an actual interval is chosen randomly between them. Such a
24964 rule has been found to be helpful in cluster configurations when all the
24965 members of the cluster restart at once, and may therefore synchronize their
24966 queue processing times.
24967 .endlist
24968
24969 When computing the next retry time, the algorithm definitions are scanned in
24970 order until one whose cutoff time has not yet passed is reached. This is then
24971 used to compute a new retry time that is later than the current time. In the
24972 case of fixed interval retries, this simply means adding the interval to the
24973 current time. For geometrically increasing intervals, retry intervals are
24974 computed from the rule's parameters until one that is greater than the previous
24975 interval is found. The main configuration variable
24976 .cindex "limit" "retry interval"
24977 .cindex "retry" "interval, maximum"
24978 .oindex "&%retry_interval_max%&"
24979 &%retry_interval_max%& limits the maximum interval between retries. It
24980 cannot be set greater than &`24h`&, which is its default value.
24981
24982 A single remote domain may have a number of hosts associated with it, and each
24983 host may have more than one IP address. Retry algorithms are selected on the
24984 basis of the domain name, but are applied to each IP address independently. If,
24985 for example, a host has two IP addresses and one is unusable, Exim will
24986 generate retry times for it and will not try to use it until its next retry
24987 time comes. Thus the good IP address is likely to be tried first most of the
24988 time.
24989
24990 .cindex "hints database" "use for retrying"
24991 Retry times are hints rather than promises. Exim does not make any attempt to
24992 run deliveries exactly at the computed times. Instead, a queue runner process
24993 starts delivery processes for delayed messages periodically, and these attempt
24994 new deliveries only for those addresses that have passed their next retry time.
24995 If a new message arrives for a deferred address, an immediate delivery attempt
24996 occurs only if the address has passed its retry time. In the absence of new
24997 messages, the minimum time between retries is the interval between queue runner
24998 processes. There is not much point in setting retry times of five minutes if
24999 your queue runners happen only once an hour, unless there are a significant
25000 number of incoming messages (which might be the case on a system that is
25001 sending everything to a smart host, for example).
25002
25003 The data in the retry hints database can be inspected by using the
25004 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25005 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25006 &'exinext'& utility script can be used to find out what the next retry times
25007 are for the hosts associated with a particular mail domain, and also for local
25008 deliveries that have been deferred.
25009
25010
25011 .section "Retry rule examples" "SECID164"
25012 Here are some example retry rules:
25013 .code
25014 alice@wonderland.fict.example quota_5d  F,7d,3h
25015 wonderland.fict.example       quota_5d
25016 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25017 lookingglass.fict.example     *         F,24h,30m;
25018 *                 refused_A   F,2h,20m;
25019 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25020 .endd
25021 The first rule sets up special handling for mail to
25022 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25023 mailbox has not been read for at least 5 days. Retries continue every three
25024 hours for 7 days. The second rule handles over-quota errors for all other local
25025 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25026 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25027 fail are bounced immediately if the mailbox has not been read for at least 5
25028 days.
25029
25030 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25031 happen every 15 minutes for an hour, then with geometrically increasing
25032 intervals until two days have passed since a delivery first failed. After the
25033 first hour there is a delay of one hour, then two hours, then four hours, and
25034 so on (this is a rather extreme example).
25035
25036 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25037 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25038 all other domains, with special action for connection refusal from hosts that
25039 were not obtained from an MX record.
25040
25041 The final rule in a retry configuration should always have asterisks in the
25042 first two fields so as to provide a general catch-all for any addresses that do
25043 not have their own special handling. This example tries every 15 minutes for 2
25044 hours, then with intervals starting at one hour and increasing by a factor of
25045 1.5 up to 16 hours, then every 8 hours up to 5 days.
25046
25047
25048
25049 .section "Timeout of retry data" "SECID165"
25050 .cindex "timeout" "of retry data"
25051 .oindex "&%retry_data_expire%&"
25052 .cindex "hints database" "data expiry"
25053 .cindex "retry" "timeout of data"
25054 Exim timestamps the data that it writes to its retry hints database. When it
25055 consults the data during a delivery it ignores any that is older than the value
25056 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25057 been tried for 7 days, Exim will try to deliver to it immediately a message
25058 arrives, and if that fails, it will calculate a retry time as if it were
25059 failing for the first time.
25060
25061 This improves the behaviour for messages routed to rarely-used hosts such as MX
25062 backups. If such a host was down at one time, and happens to be down again when
25063 Exim tries a month later, using the old retry data would imply that it had been
25064 down all the time, which is not a justified assumption.
25065
25066 If a host really is permanently dead, this behaviour causes a burst of retries
25067 every now and again, but only if messages routed to it are rare. If there is a
25068 message at least once every 7 days the retry data never expires.
25069
25070
25071
25072
25073 .section "Long-term failures" "SECID166"
25074 .cindex "delivery failure, long-term"
25075 .cindex "retry" "after long-term failure"
25076 Special processing happens when an email address has been failing for so long
25077 that the cutoff time for the last algorithm is reached. For example, using the
25078 default retry rule:
25079 .code
25080 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25081 .endd
25082 the cutoff time is four days. Reaching the retry cutoff is independent of how
25083 long any specific message has been failing; it is the length of continuous
25084 failure for the recipient address that counts.
25085
25086 When the cutoff time is reached for a local delivery, or for all the IP
25087 addresses associated with a remote delivery, a subsequent delivery failure
25088 causes Exim to give up on the address, and a bounce message is generated.
25089 In order to cater for new messages that use the failing address, a next retry
25090 time is still computed from the final algorithm, and is used as follows:
25091
25092 For local deliveries, one delivery attempt is always made for any subsequent
25093 messages. If this delivery fails, the address fails immediately. The
25094 post-cutoff retry time is not used.
25095
25096 If the delivery is remote, there are two possibilities, controlled by the
25097 .oindex "&%delay_after_cutoff%&"
25098 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25099 default. Until the post-cutoff retry time for one of the IP addresses is
25100 reached, the failing email address is bounced immediately, without a delivery
25101 attempt taking place. After that time, one new delivery attempt is made to
25102 those IP addresses that are past their retry times, and if that still fails,
25103 the address is bounced and new retry times are computed.
25104
25105 In other words, when all the hosts for a given email address have been failing
25106 for a long time, Exim bounces rather then defers until one of the hosts' retry
25107 times is reached. Then it tries once, and bounces if that attempt fails. This
25108 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25109 to a broken destination, but if the host does recover, Exim will eventually
25110 notice.
25111
25112 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25113 addresses are past their final cutoff time, Exim tries to deliver to those IP
25114 addresses that have not been tried since the message arrived. If there are
25115 no suitable IP addresses, or if they all fail, the address is bounced. In other
25116 words, it does not delay when a new message arrives, but tries the expired
25117 addresses immediately, unless they have been tried since the message arrived.
25118 If there is a continuous stream of messages for the failing domains, setting
25119 &%delay_after_cutoff%& false means that there will be many more attempts to
25120 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25121 true.
25122
25123 .section "Deliveries that work intermittently" "SECID167"
25124 .cindex "retry" "intermittently working deliveries"
25125 Some additional logic is needed to cope with cases where a host is
25126 intermittently available, or when a message has some attribute that prevents
25127 its delivery when others to the same address get through. In this situation,
25128 because some messages are successfully delivered, the &"retry clock"& for the
25129 host or address keeps getting reset by the successful deliveries, and so
25130 failing messages remain on the queue for ever because the cutoff time is never
25131 reached.
25132
25133 Two exceptional actions are applied to prevent this happening. The first
25134 applies to errors that are related to a message rather than a remote host.
25135 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25136 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25137 commands, and quota failures. For this type of error, if a message's arrival
25138 time is earlier than the &"first failed"& time for the error, the earlier time
25139 is used when scanning the retry rules to decide when to try next and when to
25140 time out the address.
25141
25142 The exceptional second action applies in all cases. If a message has been on
25143 the queue for longer than the cutoff time of any applicable retry rule for a
25144 given address, a delivery is attempted for that address, even if it is not yet
25145 time, and if this delivery fails, the address is timed out. A new retry time is
25146 not computed in this case, so that other messages for the same address are
25147 considered immediately.
25148 .ecindex IIDretconf1
25149 .ecindex IIDregconf2
25150
25151
25152
25153
25154
25155
25156 . ////////////////////////////////////////////////////////////////////////////
25157 . ////////////////////////////////////////////////////////////////////////////
25158
25159 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25160 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25161 .scindex IIDauthconf2 "authentication"
25162 The &"authenticators"& section of Exim's run time configuration is concerned
25163 with SMTP authentication. This facility is an extension to the SMTP protocol,
25164 described in RFC 2554, which allows a client SMTP host to authenticate itself
25165 to a server. This is a common way for a server to recognize clients that are
25166 permitted to use it as a relay. SMTP authentication is not of relevance to the
25167 transfer of mail between servers that have no managerial connection with each
25168 other.
25169
25170 .cindex "AUTH" "description of"
25171 Very briefly, the way SMTP authentication works is as follows:
25172
25173 .ilist
25174 The server advertises a number of authentication &'mechanisms'& in response to
25175 the client's EHLO command.
25176 .next
25177 The client issues an AUTH command, naming a specific mechanism. The command
25178 may, optionally, contain some authentication data.
25179 .next
25180 The server may issue one or more &'challenges'&, to which the client must send
25181 appropriate responses. In simple authentication mechanisms, the challenges are
25182 just prompts for user names and passwords. The server does not have to issue
25183 any challenges &-- in some mechanisms the relevant data may all be transmitted
25184 with the AUTH command.
25185 .next
25186 The server either accepts or denies authentication.
25187 .next
25188 If authentication succeeds, the client may optionally make use of the AUTH
25189 option on the MAIL command to pass an authenticated sender in subsequent
25190 mail transactions. Authentication lasts for the remainder of the SMTP
25191 connection.
25192 .next
25193 If authentication fails, the client may give up, or it may try a different
25194 authentication mechanism, or it may try transferring mail over the
25195 unauthenticated connection.
25196 .endlist
25197
25198 If you are setting up a client, and want to know which authentication
25199 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25200 SMTP port) on the server, and issue an EHLO command. The response to this
25201 includes the list of supported mechanisms. For example:
25202 .display
25203 &`$ `&&*&`telnet server.example 25`&*&
25204 &`Trying 192.168.34.25...`&
25205 &`Connected to server.example.`&
25206 &`Escape character is &#x0027;^]&#x0027;.`&
25207 &`220 server.example ESMTP Exim 4.20 ...`&
25208 &*&`ehlo client.example`&*&
25209 &`250-server.example Hello client.example [10.8.4.5]`&
25210 &`250-SIZE 52428800`&
25211 &`250-PIPELINING`&
25212 &`250-AUTH PLAIN`&
25213 &`250 HELP`&
25214 .endd
25215 The second-last line of this example output shows that the server supports
25216 authentication using the PLAIN mechanism. In Exim, the different authentication
25217 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25218 routers and transports, which authenticators are included in the binary is
25219 controlled by build-time definitions. The following are currently available,
25220 included by setting
25221 .code
25222 AUTH_CRAM_MD5=yes
25223 AUTH_CYRUS_SASL=yes
25224 AUTH_DOVECOT=yes
25225 AUTH_GSASL=yes
25226 AUTH_HEIMDAL_GSSAPI=yes
25227 AUTH_PLAINTEXT=yes
25228 AUTH_SPA=yes
25229 AUTH_TLS=yes
25230 .endd
25231 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25232 authentication mechanism (RFC 2195), and the second provides an interface to
25233 the Cyrus SASL authentication library.
25234 The third is an interface to Dovecot's authentication system, delegating the
25235 work via a socket interface.
25236 The fourth provides an interface to the GNU SASL authentication library, which
25237 provides mechanisms but typically not data sources.
25238 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25239 supporting setting a server keytab.
25240 The sixth can be configured to support
25241 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25242 not formally documented, but used by several MUAs. The seventh authenticator
25243 supports Microsoft's &'Secure Password Authentication'& mechanism.
25244 The eighth is an Exim authenticator but not an SMTP one;
25245 instead it can use information from a TLS negotiation.
25246
25247 The authenticators are configured using the same syntax as other drivers (see
25248 section &<<SECTfordricon>>&). If no authenticators are required, no
25249 authentication section need be present in the configuration file. Each
25250 authenticator can in principle have both server and client functions. When Exim
25251 is receiving SMTP mail, it is acting as a server; when it is sending out
25252 messages over SMTP, it is acting as a client. Authenticator configuration
25253 options are provided for use in both these circumstances.
25254
25255 To make it clear which options apply to which situation, the prefixes
25256 &%server_%& and &%client_%& are used on option names that are specific to
25257 either the server or the client function, respectively. Server and client
25258 functions are disabled if none of their options are set. If an authenticator is
25259 to be used for both server and client functions, a single definition, using
25260 both sets of options, is required. For example:
25261 .code
25262 cram:
25263   driver = cram_md5
25264   public_name = CRAM-MD5
25265   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25266   client_name = ph10
25267   client_secret = secret2
25268 .endd
25269 The &%server_%& option is used when Exim is acting as a server, and the
25270 &%client_%& options when it is acting as a client.
25271
25272 Descriptions of the individual authenticators are given in subsequent chapters.
25273 The remainder of this chapter covers the generic options for the
25274 authenticators, followed by general discussion of the way authentication works
25275 in Exim.
25276
25277 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25278 per-mechanism basis.  Please read carefully to determine which variables hold
25279 account labels such as usercodes and which hold passwords or other
25280 authenticating data.
25281
25282 Note that some mechanisms support two different identifiers for accounts: the
25283 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25284 and &'authz'& are commonly encountered.  The American spelling is standard here.
25285 Conceptually, authentication data such as passwords are tied to the identifier
25286 used to authenticate; servers may have rules to permit one user to act as a
25287 second user, so that after login the session is treated as though that second
25288 user had logged in.  That second user is the &'authorization id'&.  A robust
25289 configuration might confirm that the &'authz'& field is empty or matches the
25290 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25291 as verified data, the &'authz'& as an unverified request which the server might
25292 choose to honour.
25293
25294 A &'realm'& is a text string, typically a domain name, presented by a server
25295 to a client to help it select an account and credentials to use.  In some
25296 mechanisms, the client and server provably agree on the realm, but clients
25297 typically can not treat the realm as secure data to be blindly trusted.
25298
25299
25300
25301 .section "Generic options for authenticators" "SECID168"
25302 .cindex "authentication" "generic options"
25303 .cindex "options" "generic; for authenticators"
25304
25305 .option client_condition authenticators string&!! unset
25306 When Exim is authenticating as a client, it skips any authenticator whose
25307 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25308 used, for example, to skip plain text authenticators when the connection is not
25309 encrypted by a setting such as:
25310 .code
25311 client_condition = ${if !eq{$tls_out_cipher}{}}
25312 .endd
25313
25314
25315 .option client_set_id authenticators string&!! unset
25316 When client authentication succeeds, this condition is expanded; the
25317 result is used in the log lines for outbound messages.
25318 Typically it will be the user name used for authentication.
25319
25320
25321 .option driver authenticators string unset
25322 This option must always be set. It specifies which of the available
25323 authenticators is to be used.
25324
25325
25326 .option public_name authenticators string unset
25327 This option specifies the name of the authentication mechanism that the driver
25328 implements, and by which it is known to the outside world. These names should
25329 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25330 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25331 defaults to the driver's instance name.
25332
25333
25334 .option server_advertise_condition authenticators string&!! unset
25335 When a server is about to advertise an authentication mechanism, the condition
25336 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25337 mechanism is not advertised.
25338 If the expansion fails, the mechanism is not advertised. If the failure was not
25339 forced, and was not caused by a lookup defer, the incident is logged.
25340 See section &<<SECTauthexiser>>& below for further discussion.
25341
25342
25343 .option server_condition authenticators string&!! unset
25344 This option must be set for a &%plaintext%& server authenticator, where it
25345 is used directly to control authentication. See section &<<SECTplainserver>>&
25346 for details.
25347
25348 For the &(gsasl)& authenticator, this option is required for various
25349 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25350
25351 For the other authenticators, &%server_condition%& can be used as an additional
25352 authentication or authorization mechanism that is applied after the other
25353 authenticator conditions succeed. If it is set, it is expanded when the
25354 authenticator would otherwise return a success code. If the expansion is forced
25355 to fail, authentication fails. Any other expansion failure causes a temporary
25356 error code to be returned. If the result of a successful expansion is an empty
25357 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25358 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25359 other result, a temporary error code is returned, with the expanded string as
25360 the error text.
25361
25362
25363 .option server_debug_print authenticators string&!! unset
25364 If this option is set and authentication debugging is enabled (see the &%-d%&
25365 command line option), the string is expanded and included in the debugging
25366 output when the authenticator is run as a server. This can help with checking
25367 out the values of variables.
25368 If expansion of the string fails, the error message is written to the debugging
25369 output, and Exim carries on processing.
25370
25371
25372 .option server_set_id authenticators string&!! unset
25373 .vindex "&$authenticated_id$&"
25374 When an Exim server successfully authenticates a client, this string is
25375 expanded using data from the authentication, and preserved for any incoming
25376 messages in the variable &$authenticated_id$&. It is also included in the log
25377 lines for incoming messages. For example, a user/password authenticator
25378 configuration might preserve the user name that was used to authenticate, and
25379 refer to it subsequently during delivery of the message.
25380 If expansion fails, the option is ignored.
25381
25382
25383 .option server_mail_auth_condition authenticators string&!! unset
25384 This option allows a server to discard authenticated sender addresses supplied
25385 as part of MAIL commands in SMTP connections that are authenticated by the
25386 driver on which &%server_mail_auth_condition%& is set. The option is not used
25387 as part of the authentication process; instead its (unexpanded) value is
25388 remembered for later use.
25389 How it is used is described in the following section.
25390
25391
25392
25393
25394
25395 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25396 .cindex "authentication" "sender; authenticated"
25397 .cindex "AUTH" "on MAIL command"
25398 When a client supplied an AUTH= item on a MAIL command, Exim applies
25399 the following checks before accepting it as the authenticated sender of the
25400 message:
25401
25402 .ilist
25403 If the connection is not using extended SMTP (that is, HELO was used rather
25404 than EHLO), the use of AUTH= is a syntax error.
25405 .next
25406 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25407 .next
25408 .vindex "&$authenticated_sender$&"
25409 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25410 running, the value of &$authenticated_sender$& is set to the value obtained
25411 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25412 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25413 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25414 given for the MAIL command.
25415 .next
25416 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25417 is accepted and placed in &$authenticated_sender$& only if the client has
25418 authenticated.
25419 .next
25420 If the AUTH= value was accepted by either of the two previous rules, and
25421 the client has authenticated, and the authenticator has a setting for the
25422 &%server_mail_auth_condition%&, the condition is checked at this point. The
25423 valued that was saved from the authenticator is expanded. If the expansion
25424 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25425 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25426 the value of &$authenticated_sender$& is retained and passed on with the
25427 message.
25428 .endlist
25429
25430
25431 When &$authenticated_sender$& is set for a message, it is passed on to other
25432 hosts to which Exim authenticates as a client. Do not confuse this value with
25433 &$authenticated_id$&, which is a string obtained from the authentication
25434 process, and which is not usually a complete email address.
25435
25436 .vindex "&$sender_address$&"
25437 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25438 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25439 therefore make use of &$authenticated_sender$&. The converse is not true: the
25440 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25441 ACL is run.
25442
25443
25444
25445 .section "Authentication on an Exim server" "SECTauthexiser"
25446 .cindex "authentication" "on an Exim server"
25447 When Exim receives an EHLO command, it advertises the public names of those
25448 authenticators that are configured as servers, subject to the following
25449 conditions:
25450
25451 .ilist
25452 The client host must match &%auth_advertise_hosts%& (default *).
25453 .next
25454 It the &%server_advertise_condition%& option is set, its expansion must not
25455 yield the empty string, &"0"&, &"no"&, or &"false"&.
25456 .endlist
25457
25458 The order in which the authenticators are defined controls the order in which
25459 the mechanisms are advertised.
25460
25461 Some mail clients (for example, some versions of Netscape) require the user to
25462 provide a name and password for authentication whenever AUTH is advertised,
25463 even though authentication may not in fact be needed (for example, Exim may be
25464 set up to allow unconditional relaying from the client by an IP address check).
25465 You can make such clients more friendly by not advertising AUTH to them.
25466 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25467 that runs for RCPT) to relay without authentication, you should set
25468 .code
25469 auth_advertise_hosts = ! 10.9.8.0/24
25470 .endd
25471 so that no authentication mechanisms are advertised to them.
25472
25473 The &%server_advertise_condition%& controls the advertisement of individual
25474 authentication mechanisms. For example, it can be used to restrict the
25475 advertisement of a particular mechanism to encrypted connections, by a setting
25476 such as:
25477 .code
25478 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25479 .endd
25480 .vindex "&$tls_in_cipher$&"
25481 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25482 yields &"yes"&, which allows the advertisement to happen.
25483
25484 When an Exim server receives an AUTH command from a client, it rejects it
25485 immediately if AUTH was not advertised in response to an earlier EHLO
25486 command. This is the case if
25487
25488 .ilist
25489 The client host does not match &%auth_advertise_hosts%&; or
25490 .next
25491 No authenticators are configured with server options; or
25492 .next
25493 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25494 server authenticators.
25495 .endlist
25496
25497
25498 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25499 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25500 AUTH is accepted from any client host.
25501
25502 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25503 server authentication mechanism that was advertised in response to EHLO and
25504 that matches the one named in the AUTH command. If it finds one, it runs
25505 the appropriate authentication protocol, and authentication either succeeds or
25506 fails. If there is no matching advertised mechanism, the AUTH command is
25507 rejected with a 504 error.
25508
25509 .vindex "&$received_protocol$&"
25510 .vindex "&$sender_host_authenticated$&"
25511 When a message is received from an authenticated host, the value of
25512 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25513 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25514 public name) of the authenticator driver that successfully authenticated the
25515 client from which the message was received. This variable is empty if there was
25516 no successful authentication.
25517
25518
25519
25520
25521 .section "Testing server authentication" "SECID169"
25522 .cindex "authentication" "testing a server"
25523 .cindex "AUTH" "testing a server"
25524 .cindex "base64 encoding" "creating authentication test data"
25525 Exim's &%-bh%& option can be useful for testing server authentication
25526 configurations. The data for the AUTH command has to be sent using base64
25527 encoding. A quick way to produce such data for testing is the following Perl
25528 script:
25529 .code
25530 use MIME::Base64;
25531 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25532 .endd
25533 .cindex "binary zero" "in authentication data"
25534 This interprets its argument as a Perl string, and then encodes it. The
25535 interpretation as a Perl string allows binary zeros, which are required for
25536 some kinds of authentication, to be included in the data. For example, a
25537 command line to run this script on such data might be
25538 .code
25539 encode '\0user\0password'
25540 .endd
25541 Note the use of single quotes to prevent the shell interpreting the
25542 backslashes, so that they can be interpreted by Perl to specify characters
25543 whose code value is zero.
25544
25545 &*Warning 1*&: If either of the user or password strings starts with an octal
25546 digit, you must use three zeros instead of one after the leading backslash. If
25547 you do not, the octal digit that starts your string will be incorrectly
25548 interpreted as part of the code for the first character.
25549
25550 &*Warning 2*&: If there are characters in the strings that Perl interprets
25551 specially, you must use a Perl escape to prevent them being misinterpreted. For
25552 example, a command such as
25553 .code
25554 encode '\0user@domain.com\0pas$$word'
25555 .endd
25556 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25557
25558 If you have the &%mimencode%& command installed, another way to do produce
25559 base64-encoded strings is to run the command
25560 .code
25561 echo -e -n `\0user\0password' | mimencode
25562 .endd
25563 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25564 in the argument, and the &%-n%& option specifies no newline at the end of its
25565 output. However, not all versions of &%echo%& recognize these options, so you
25566 should check your version before relying on this suggestion.
25567
25568
25569
25570 .section "Authentication by an Exim client" "SECID170"
25571 .cindex "authentication" "on an Exim client"
25572 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25573 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25574 announces support for authentication, and the host matches an entry in either
25575 of these options, Exim (as a client) tries to authenticate as follows:
25576
25577 .ilist
25578 For each authenticator that is configured as a client, in the order in which
25579 they are defined in the configuration, it searches the authentication
25580 mechanisms announced by the server for one whose name matches the public name
25581 of the authenticator.
25582 .next
25583 .vindex "&$host$&"
25584 .vindex "&$host_address$&"
25585 When it finds one that matches, it runs the authenticator's client code. The
25586 variables &$host$& and &$host_address$& are available for any string expansions
25587 that the client might do. They are set to the server's name and IP address. If
25588 any expansion is forced to fail, the authentication attempt is abandoned, and
25589 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25590 delivery to be deferred.
25591 .next
25592 If the result of the authentication attempt is a temporary error or a timeout,
25593 Exim abandons trying to send the message to the host for the moment. It will
25594 try again later. If there are any backup hosts available, they are tried in the
25595 usual way.
25596 .next
25597 If the response to authentication is a permanent error (5&'xx'& code), Exim
25598 carries on searching the list of authenticators and tries another one if
25599 possible. If all authentication attempts give permanent errors, or if there are
25600 no attempts because no mechanisms match (or option expansions force failure),
25601 what happens depends on whether the host matches &%hosts_require_auth%& or
25602 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25603 delivery is deferred. The error can be detected in the retry rules, and thereby
25604 turned into a permanent error if you wish. In the second case, Exim tries to
25605 deliver the message unauthenticated.
25606 .endlist
25607
25608 .cindex "AUTH" "on MAIL command"
25609 When Exim has authenticated itself to a remote server, it adds the AUTH
25610 parameter to the MAIL commands it sends, if it has an authenticated sender for
25611 the message. If the message came from a remote host, the authenticated sender
25612 is the one that was receiving on an incoming MAIL command, provided that the
25613 incoming connection was authenticated and the &%server_mail_auth%& condition
25614 allowed the authenticated sender to be retained. If a local process calls Exim
25615 to send a message, the sender address that is built from the login name and
25616 &%qualify_domain%& is treated as authenticated. However, if the
25617 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25618 the authenticated sender that was received with the message.
25619 .ecindex IIDauthconf1
25620 .ecindex IIDauthconf2
25621
25622
25623
25624
25625
25626
25627 . ////////////////////////////////////////////////////////////////////////////
25628 . ////////////////////////////////////////////////////////////////////////////
25629
25630 .chapter "The plaintext authenticator" "CHAPplaintext"
25631 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25632 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25633 The &(plaintext)& authenticator can be configured to support the PLAIN and
25634 LOGIN authentication mechanisms, both of which transfer authentication data as
25635 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25636 security risk; you are strongly advised to insist on the use of SMTP encryption
25637 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25638 use unencrypted plain text, you should not use the same passwords for SMTP
25639 connections as you do for login accounts.
25640
25641 .section "Plaintext options" "SECID171"
25642 .cindex "options" "&(plaintext)& authenticator (server)"
25643 When configured as a server, &(plaintext)& uses the following options:
25644
25645 .option server_condition authenticators string&!! unset
25646 This is actually a global authentication option, but it must be set in order to
25647 configure the &(plaintext)& driver as a server. Its use is described below.
25648
25649 .option server_prompts plaintext string&!! unset
25650 The contents of this option, after expansion, must be a colon-separated list of
25651 prompt strings. If expansion fails, a temporary authentication rejection is
25652 given.
25653
25654 .section "Using plaintext in a server" "SECTplainserver"
25655 .cindex "AUTH" "in &(plaintext)& authenticator"
25656 .cindex "binary zero" "in &(plaintext)& authenticator"
25657 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25658         "in &(plaintext)& authenticator"
25659 .vindex "&$auth1$&, &$auth2$&, etc"
25660 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25661
25662 When running as a server, &(plaintext)& performs the authentication test by
25663 expanding a string. The data sent by the client with the AUTH command, or in
25664 response to subsequent prompts, is base64 encoded, and so may contain any byte
25665 values when decoded. If any data is supplied with the command, it is treated as
25666 a list of strings, separated by NULs (binary zeros), the first three of which
25667 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25668 (neither LOGIN nor PLAIN uses more than three strings).
25669
25670 For compatibility with previous releases of Exim, the values are also placed in
25671 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25672 variables for this purpose is now deprecated, as it can lead to confusion in
25673 string expansions that also use them for other things.
25674
25675 If there are more strings in &%server_prompts%& than the number of strings
25676 supplied with the AUTH command, the remaining prompts are used to obtain more
25677 data. Each response from the client may be a list of NUL-separated strings.
25678
25679 .vindex "&$authenticated_id$&"
25680 Once a sufficient number of data strings have been received,
25681 &%server_condition%& is expanded. If the expansion is forced to fail,
25682 authentication fails. Any other expansion failure causes a temporary error code
25683 to be returned. If the result of a successful expansion is an empty string,
25684 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25685 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25686 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25687 For any other result, a temporary error code is returned, with the expanded
25688 string as the error text
25689
25690 &*Warning*&: If you use a lookup in the expansion to find the user's
25691 password, be sure to make the authentication fail if the user is unknown.
25692 There are good and bad examples at the end of the next section.
25693
25694
25695
25696 .section "The PLAIN authentication mechanism" "SECID172"
25697 .cindex "PLAIN authentication mechanism"
25698 .cindex "authentication" "PLAIN mechanism"
25699 .cindex "binary zero" "in &(plaintext)& authenticator"
25700 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25701 sent as one item of data (that is, one combined string containing two NUL
25702 separators). The data is sent either as part of the AUTH command, or
25703 subsequently in response to an empty prompt from the server.
25704
25705 The second and third strings are a user name and a corresponding password.
25706 Using a single fixed user name and password as an example, this could be
25707 configured as follows:
25708 .code
25709 fixed_plain:
25710   driver = plaintext
25711   public_name = PLAIN
25712   server_prompts = :
25713   server_condition = \
25714     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25715   server_set_id = $auth2
25716 .endd
25717 Note that the default result strings from &%if%& (&"true"& or an empty string)
25718 are exactly what we want here, so they need not be specified. Obviously, if the
25719 password contains expansion-significant characters such as dollar, backslash,
25720 or closing brace, they have to be escaped.
25721
25722 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25723 the end of a string list are ignored). If all the data comes as part of the
25724 AUTH command, as is commonly the case, the prompt is not used. This
25725 authenticator is advertised in the response to EHLO as
25726 .code
25727 250-AUTH PLAIN
25728 .endd
25729 and a client host can authenticate itself by sending the command
25730 .code
25731 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25732 .endd
25733 As this contains three strings (more than the number of prompts), no further
25734 data is required from the client. Alternatively, the client may just send
25735 .code
25736 AUTH PLAIN
25737 .endd
25738 to initiate authentication, in which case the server replies with an empty
25739 prompt. The client must respond with the combined data string.
25740
25741 The data string is base64 encoded, as required by the RFC. This example,
25742 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25743 represents a zero byte. This is split up into three strings, the first of which
25744 is empty. The &%server_condition%& option in the authenticator checks that the
25745 second two are &`username`& and &`mysecret`& respectively.
25746
25747 Having just one fixed user name and password, as in this example, is not very
25748 realistic, though for a small organization with only a handful of
25749 authenticating clients it could make sense.
25750
25751 A more sophisticated instance of this authenticator could use the user name in
25752 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25753 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25754 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25755 This is an incorrect example:
25756 .code
25757 server_condition = \
25758   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25759 .endd
25760 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25761 which it then compares to the supplied password (&$auth3$&). Why is this example
25762 incorrect? It works fine for existing users, but consider what happens if a
25763 non-existent user name is given. The lookup fails, but as no success/failure
25764 strings are given for the lookup, it yields an empty string. Thus, to defeat
25765 the authentication, all a client has to do is to supply a non-existent user
25766 name and an empty password. The correct way of writing this test is:
25767 .code
25768 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25769   {${if eq{$value}{$auth3}}} {false}}
25770 .endd
25771 In this case, if the lookup succeeds, the result is checked; if the lookup
25772 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25773 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25774 always fails if its second argument is empty. However, the second way of
25775 writing the test makes the logic clearer.
25776
25777
25778 .section "The LOGIN authentication mechanism" "SECID173"
25779 .cindex "LOGIN authentication mechanism"
25780 .cindex "authentication" "LOGIN mechanism"
25781 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25782 in a number of programs. No data is sent with the AUTH command. Instead, a
25783 user name and password are supplied separately, in response to prompts. The
25784 plaintext authenticator can be configured to support this as in this example:
25785 .code
25786 fixed_login:
25787   driver = plaintext
25788   public_name = LOGIN
25789   server_prompts = User Name : Password
25790   server_condition = \
25791     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25792   server_set_id = $auth1
25793 .endd
25794 Because of the way plaintext operates, this authenticator accepts data supplied
25795 with the AUTH command (in contravention of the specification of LOGIN), but
25796 if the client does not supply it (as is the case for LOGIN clients), the prompt
25797 strings are used to obtain two data items.
25798
25799 Some clients are very particular about the precise text of the prompts. For
25800 example, Outlook Express is reported to recognize only &"Username:"& and
25801 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25802 strings. It uses the &%ldapauth%& expansion condition to check the user
25803 name and password by binding to an LDAP server:
25804 .code
25805 login:
25806   driver = plaintext
25807   public_name = LOGIN
25808   server_prompts = Username:: : Password::
25809   server_condition = ${if and{{ \
25810     !eq{}{$auth1} }{ \
25811     ldapauth{\
25812       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25813       pass=${quote:$auth2} \
25814       ldap://ldap.example.org/} }} }
25815   server_set_id = uid=$auth1,ou=people,o=example.org
25816 .endd
25817 We have to check that the username is not empty before using it, because LDAP
25818 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25819 operator to correctly quote the DN for authentication. However, the basic
25820 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25821 correct one to use for the password, because quoting is needed only to make
25822 the password conform to the Exim syntax. At the LDAP level, the password is an
25823 uninterpreted string.
25824
25825
25826 .section "Support for different kinds of authentication" "SECID174"
25827 A number of string expansion features are provided for the purpose of
25828 interfacing to different ways of user authentication. These include checking
25829 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25830 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25831 &<<SECTexpcond>>&.
25832
25833
25834
25835
25836 .section "Using plaintext in a client" "SECID175"
25837 .cindex "options" "&(plaintext)& authenticator (client)"
25838 The &(plaintext)& authenticator has two client options:
25839
25840 .option client_ignore_invalid_base64 plaintext boolean false
25841 If the client receives a server prompt that is not a valid base64 string,
25842 authentication is abandoned by default. However, if this option is set true,
25843 the error in the challenge is ignored and the client sends the response as
25844 usual.
25845
25846 .option client_send plaintext string&!! unset
25847 The string is a colon-separated list of authentication data strings. Each
25848 string is independently expanded before being sent to the server. The first
25849 string is sent with the AUTH command; any more strings are sent in response
25850 to prompts from the server. Before each string is expanded, the value of the
25851 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25852 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25853 way. Thus, the prompt that is received in response to sending the first string
25854 (with the AUTH command) can be used in the expansion of the second string, and
25855 so on. If an invalid base64 string is received when
25856 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25857 &$auth$&<&'n'&> variable.
25858
25859 &*Note*&: You cannot use expansion to create multiple strings, because
25860 splitting takes priority and happens first.
25861
25862 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25863 the data, further processing is applied to each string before it is sent. If
25864 there are any single circumflex characters in the string, they are converted to
25865 NULs. Should an actual circumflex be required as data, it must be doubled in
25866 the string.
25867
25868 This is an example of a client configuration that implements the PLAIN
25869 authentication mechanism with a fixed user name and password:
25870 .code
25871 fixed_plain:
25872   driver = plaintext
25873   public_name = PLAIN
25874   client_send = ^username^mysecret
25875 .endd
25876 The lack of colons means that the entire text is sent with the AUTH
25877 command, with the circumflex characters converted to NULs. A similar example
25878 that uses the LOGIN mechanism is:
25879 .code
25880 fixed_login:
25881   driver = plaintext
25882   public_name = LOGIN
25883   client_send = : username : mysecret
25884 .endd
25885 The initial colon means that the first string is empty, so no data is sent with
25886 the AUTH command itself. The remaining strings are sent in response to
25887 prompts.
25888 .ecindex IIDplaiauth1
25889 .ecindex IIDplaiauth2
25890
25891
25892
25893
25894 . ////////////////////////////////////////////////////////////////////////////
25895 . ////////////////////////////////////////////////////////////////////////////
25896
25897 .chapter "The cram_md5 authenticator" "CHID9"
25898 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25899 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25900 .cindex "CRAM-MD5 authentication mechanism"
25901 .cindex "authentication" "CRAM-MD5 mechanism"
25902 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25903 sends a challenge string to the client, and the response consists of a user
25904 name and the CRAM-MD5 digest of the challenge string combined with a secret
25905 string (password) which is known to both server and client. Thus, the secret
25906 is not sent over the network as plain text, which makes this authenticator more
25907 secure than &(plaintext)&. However, the downside is that the secret has to be
25908 available in plain text at either end.
25909
25910
25911 .section "Using cram_md5 as a server" "SECID176"
25912 .cindex "options" "&(cram_md5)& authenticator (server)"
25913 This authenticator has one server option, which must be set to configure the
25914 authenticator as a server:
25915
25916 .option server_secret cram_md5 string&!! unset
25917 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25918 When the server receives the client's response, the user name is placed in
25919 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25920 obtain the password for that user. The server then computes the CRAM-MD5 digest
25921 that the client should have sent, and checks that it received the correct
25922 string. If the expansion of &%server_secret%& is forced to fail, authentication
25923 fails. If the expansion fails for some other reason, a temporary error code is
25924 returned to the client.
25925
25926 For compatibility with previous releases of Exim, the user name is also placed
25927 in &$1$&. However, the use of this variables for this purpose is now
25928 deprecated, as it can lead to confusion in string expansions that also use
25929 numeric variables for other things.
25930
25931 For example, the following authenticator checks that the user name given by the
25932 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25933 user name, authentication fails.
25934 .code
25935 fixed_cram:
25936   driver = cram_md5
25937   public_name = CRAM-MD5
25938   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25939   server_set_id = $auth1
25940 .endd
25941 .vindex "&$authenticated_id$&"
25942 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25943 name in &$authenticated_id$&. A more typical configuration might look up the
25944 secret string in a file, using the user name as the key. For example:
25945 .code
25946 lookup_cram:
25947   driver = cram_md5
25948   public_name = CRAM-MD5
25949   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25950                   {$value}fail}
25951   server_set_id = $auth1
25952 .endd
25953 Note that this expansion explicitly forces failure if the lookup fails
25954 because &$auth1$& contains an unknown user name.
25955
25956 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25957 using the relevant libraries, you need to know the realm to specify in the
25958 lookup and then ask for the &"userPassword"& attribute for that user in that
25959 realm, with:
25960 .code
25961 cyrusless_crammd5:
25962   driver = cram_md5
25963   public_name = CRAM-MD5
25964   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25965                   dbmjz{/etc/sasldb2}{$value}fail}
25966   server_set_id = $auth1
25967 .endd
25968
25969 .section "Using cram_md5 as a client" "SECID177"
25970 .cindex "options" "&(cram_md5)& authenticator (client)"
25971 When used as a client, the &(cram_md5)& authenticator has two options:
25972
25973
25974
25975 .option client_name cram_md5 string&!! "the primary host name"
25976 This string is expanded, and the result used as the user name data when
25977 computing the response to the server's challenge.
25978
25979
25980 .option client_secret cram_md5 string&!! unset
25981 This option must be set for the authenticator to work as a client. Its value is
25982 expanded and the result used as the secret string when computing the response.
25983
25984
25985 .vindex "&$host$&"
25986 .vindex "&$host_address$&"
25987 Different user names and secrets can be used for different servers by referring
25988 to &$host$& or &$host_address$& in the options. Forced failure of either
25989 expansion string is treated as an indication that this authenticator is not
25990 prepared to handle this case. Exim moves on to the next configured client
25991 authenticator. Any other expansion failure causes Exim to give up trying to
25992 send the message to the current server.
25993
25994 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25995 strings, is:
25996 .code
25997 fixed_cram:
25998   driver = cram_md5
25999   public_name = CRAM-MD5
26000   client_name = ph10
26001   client_secret = secret
26002 .endd
26003 .ecindex IIDcramauth1
26004 .ecindex IIDcramauth2
26005
26006
26007
26008 . ////////////////////////////////////////////////////////////////////////////
26009 . ////////////////////////////////////////////////////////////////////////////
26010
26011 .chapter "The cyrus_sasl authenticator" "CHID10"
26012 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26013 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26014 .cindex "Cyrus" "SASL library"
26015 .cindex "Kerberos"
26016 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26017 Digital Ltd (&url(http://www.aldigital.co.uk)).
26018
26019 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26020 library implementation of the RFC 2222 (&"Simple Authentication and Security
26021 Layer"&). This library supports a number of authentication mechanisms,
26022 including PLAIN and LOGIN, but also several others that Exim does not support
26023 directly. In particular, there is support for Kerberos authentication.
26024
26025 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26026 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26027 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26028 name of the driver to determine which mechanism to support.
26029
26030 Where access to some kind of secret file is required, for example in GSSAPI
26031 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26032 user, and that the Cyrus SASL library has no way of escalating privileges
26033 by default. You may also find you need to set environment variables,
26034 depending on the driver you are using.
26035
26036 The application name provided by Exim is &"exim"&, so various SASL options may
26037 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26038 Kerberos, note that because of limitations in the GSSAPI interface,
26039 changing the server keytab might need to be communicated down to the Kerberos
26040 layer independently. The mechanism for doing so is dependent upon the Kerberos
26041 implementation.
26042
26043 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26044 may be set to point to an alternative keytab file. Exim will pass this
26045 variable through from its own inherited environment when started as root or the
26046 Exim user. The keytab file needs to be readable by the Exim user.
26047 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26048 environment variable.  In practice, for those releases, the Cyrus authenticator
26049 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26050 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26051
26052
26053 .section "Using cyrus_sasl as a server" "SECID178"
26054 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26055 (on a successful authentication) into &$auth1$&. For compatibility with
26056 previous releases of Exim, the username is also placed in &$1$&. However, the
26057 use of this variable for this purpose is now deprecated, as it can lead to
26058 confusion in string expansions that also use numeric variables for other
26059 things.
26060
26061
26062 .option server_hostname cyrus_sasl string&!! "see below"
26063 This option selects the hostname that is used when communicating with the
26064 library. The default value is &`$primary_hostname`&. It is up to the underlying
26065 SASL plug-in what it does with this data.
26066
26067
26068 .option server_mech cyrus_sasl string "see below"
26069 This option selects the authentication mechanism this driver should use. The
26070 default is the value of the generic &%public_name%& option. This option allows
26071 you to use a different underlying mechanism from the advertised name. For
26072 example:
26073 .code
26074 sasl:
26075   driver = cyrus_sasl
26076   public_name = X-ANYTHING
26077   server_mech = CRAM-MD5
26078   server_set_id = $auth1
26079 .endd
26080
26081 .option server_realm cyrus_sasl string&!! unset
26082 This specifies the SASL realm that the server claims to be in.
26083
26084
26085 .option server_service cyrus_sasl string &`smtp`&
26086 This is the SASL service that the server claims to implement.
26087
26088
26089 For straightforward cases, you do not need to set any of the authenticator's
26090 private options. All you need to do is to specify an appropriate mechanism as
26091 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26092 PLAIN, you could have two authenticators as follows:
26093 .code
26094 sasl_cram_md5:
26095   driver = cyrus_sasl
26096   public_name = CRAM-MD5
26097   server_set_id = $auth1
26098
26099 sasl_plain:
26100   driver = cyrus_sasl
26101   public_name = PLAIN
26102   server_set_id = $auth2
26103 .endd
26104 Cyrus SASL does implement the LOGIN authentication method, even though it is
26105 not a standard method. It is disabled by default in the source distribution,
26106 but it is present in many binary distributions.
26107 .ecindex IIDcyrauth1
26108 .ecindex IIDcyrauth2
26109
26110
26111
26112
26113 . ////////////////////////////////////////////////////////////////////////////
26114 . ////////////////////////////////////////////////////////////////////////////
26115 .chapter "The dovecot authenticator" "CHAPdovecot"
26116 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26117 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26118 This authenticator is an interface to the authentication facility of the
26119 Dovecot POP/IMAP server, which can support a number of authentication methods.
26120 Note that Dovecot must be configured to use auth-client not auth-userdb.
26121 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26122 to use the same mechanisms for SMTP authentication. This is a server
26123 authenticator only. There is only one option:
26124
26125 .option server_socket dovecot string unset
26126
26127 This option must specify the socket that is the interface to Dovecot
26128 authentication. The &%public_name%& option must specify an authentication
26129 mechanism that Dovecot is configured to support. You can have several
26130 authenticators for different mechanisms. For example:
26131 .code
26132 dovecot_plain:
26133   driver = dovecot
26134   public_name = PLAIN
26135   server_socket = /var/run/dovecot/auth-client
26136   server_set_id = $auth1
26137
26138 dovecot_ntlm:
26139   driver = dovecot
26140   public_name = NTLM
26141   server_socket = /var/run/dovecot/auth-client
26142   server_set_id = $auth1
26143 .endd
26144 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26145 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26146 option is passed in the Dovecot authentication command. If, for a TLS
26147 connection, a client certificate has been verified, the &"valid-client-cert"&
26148 option is passed. When authentication succeeds, the identity of the user
26149 who authenticated is placed in &$auth1$&.
26150 .ecindex IIDdcotauth1
26151 .ecindex IIDdcotauth2
26152
26153
26154 . ////////////////////////////////////////////////////////////////////////////
26155 . ////////////////////////////////////////////////////////////////////////////
26156 .chapter "The gsasl authenticator" "CHAPgsasl"
26157 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26158 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26159 .cindex "authentication" "GNU SASL"
26160 .cindex "authentication" "SASL"
26161 .cindex "authentication" "EXTERNAL"
26162 .cindex "authentication" "ANONYMOUS"
26163 .cindex "authentication" "PLAIN"
26164 .cindex "authentication" "LOGIN"
26165 .cindex "authentication" "DIGEST-MD5"
26166 .cindex "authentication" "CRAM-MD5"
26167 .cindex "authentication" "SCRAM-SHA-1"
26168 The &(gsasl)& authenticator provides server integration for the GNU SASL
26169 library and the mechanisms it provides.  This is new as of the 4.80 release
26170 and there are a few areas where the library does not let Exim smoothly
26171 scale to handle future authentication mechanisms, so no guarantee can be
26172 made that any particular new authentication mechanism will be supported
26173 without code changes in Exim.
26174
26175
26176 .option server_channelbinding gsasl boolean false
26177 Some authentication mechanisms are able to use external context at both ends
26178 of the session to bind the authentication to that context, and fail the
26179 authentication process if that context differs.  Specifically, some TLS
26180 ciphersuites can provide identifying information about the cryptographic
26181 context.
26182
26183 This means that certificate identity and verification becomes a non-issue,
26184 as a man-in-the-middle attack will cause the correct client and server to
26185 see different identifiers and authentication will fail.
26186
26187 This is currently only supported when using the GnuTLS library.  This is
26188 only usable by mechanisms which support "channel binding"; at time of
26189 writing, that's the SCRAM family.
26190
26191 This defaults off to ensure smooth upgrade across Exim releases, in case
26192 this option causes some clients to start failing.  Some future release
26193 of Exim may switch the default to be true.
26194
26195
26196 .option server_hostname gsasl string&!! "see below"
26197 This option selects the hostname that is used when communicating with the
26198 library. The default value is &`$primary_hostname`&.
26199 Some mechanisms will use this data.
26200
26201
26202 .option server_mech gsasl string "see below"
26203 This option selects the authentication mechanism this driver should use. The
26204 default is the value of the generic &%public_name%& option. This option allows
26205 you to use a different underlying mechanism from the advertised name. For
26206 example:
26207 .code
26208 sasl:
26209   driver = gsasl
26210   public_name = X-ANYTHING
26211   server_mech = CRAM-MD5
26212   server_set_id = $auth1
26213 .endd
26214
26215
26216 .option server_password gsasl string&!! unset
26217 Various mechanisms need access to the cleartext password on the server, so
26218 that proof-of-possession can be demonstrated on the wire, without sending
26219 the password itself.
26220
26221 The data available for lookup varies per mechanism.
26222 In all cases, &$auth1$& is set to the &'authentication id'&.
26223 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26224 if available, else the empty string.
26225 The &$auth3$& variable will always be the &'realm'& if available,
26226 else the empty string.
26227
26228 A forced failure will cause authentication to defer.
26229
26230 If using this option, it may make sense to set the &%server_condition%&
26231 option to be simply "true".
26232
26233
26234 .option server_realm gsasl string&!! unset
26235 This specifies the SASL realm that the server claims to be in.
26236 Some mechanisms will use this data.
26237
26238
26239 .option server_scram_iter gsasl string&!! unset
26240 This option provides data for the SCRAM family of mechanisms.
26241 &$auth1$& is not available at evaluation time.
26242 (This may change, as we receive feedback on use)
26243
26244
26245 .option server_scram_salt gsasl string&!! unset
26246 This option provides data for the SCRAM family of mechanisms.
26247 &$auth1$& is not available at evaluation time.
26248 (This may change, as we receive feedback on use)
26249
26250
26251 .option server_service gsasl string &`smtp`&
26252 This is the SASL service that the server claims to implement.
26253 Some mechanisms will use this data.
26254
26255
26256 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26257 .vindex "&$auth1$&, &$auth2$&, etc"
26258 These may be set when evaluating specific options, as detailed above.
26259 They will also be set when evaluating &%server_condition%&.
26260
26261 Unless otherwise stated below, the &(gsasl)& integration will use the following
26262 meanings for these variables:
26263
26264 .ilist
26265 .vindex "&$auth1$&"
26266 &$auth1$&: the &'authentication id'&
26267 .next
26268 .vindex "&$auth2$&"
26269 &$auth2$&: the &'authorization id'&
26270 .next
26271 .vindex "&$auth3$&"
26272 &$auth3$&: the &'realm'&
26273 .endlist
26274
26275 On a per-mechanism basis:
26276
26277 .ilist
26278 .cindex "authentication" "EXTERNAL"
26279 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26280 the &%server_condition%& option must be present.
26281 .next
26282 .cindex "authentication" "ANONYMOUS"
26283 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26284 the &%server_condition%& option must be present.
26285 .next
26286 .cindex "authentication" "GSSAPI"
26287 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26288 &$auth2$& will be set to the &'authorization id'&,
26289 the &%server_condition%& option must be present.
26290 .endlist
26291
26292 An &'anonymous token'& is something passed along as an unauthenticated
26293 identifier; this is analogous to FTP anonymous authentication passing an
26294 email address, or software-identifier@, as the "password".
26295
26296
26297 An example showing the password having the realm specified in the callback
26298 and demonstrating a Cyrus SASL to GSASL migration approach is:
26299 .code
26300 gsasl_cyrusless_crammd5:
26301   driver = gsasl
26302   public_name = CRAM-MD5
26303   server_realm = imap.example.org
26304   server_password = ${lookup{$auth1:$auth3:userPassword}\
26305                     dbmjz{/etc/sasldb2}{$value}fail}
26306   server_set_id = ${quote:$auth1}
26307   server_condition = yes
26308 .endd
26309
26310
26311 . ////////////////////////////////////////////////////////////////////////////
26312 . ////////////////////////////////////////////////////////////////////////////
26313
26314 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26315 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26316 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26317 .cindex "authentication" "GSSAPI"
26318 .cindex "authentication" "Kerberos"
26319 The &(heimdal_gssapi)& authenticator provides server integration for the
26320 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26321 reliably.
26322
26323 .option server_hostname heimdal_gssapi string&!! "see below"
26324 This option selects the hostname that is used, with &%server_service%&,
26325 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26326 identifier.  The default value is &`$primary_hostname`&.
26327
26328 .option server_keytab heimdal_gssapi string&!! unset
26329 If set, then Heimdal will not use the system default keytab (typically
26330 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26331 The value should be a pathname, with no &"file:"& prefix.
26332
26333 .option server_service heimdal_gssapi string&!! "smtp"
26334 This option specifies the service identifier used, in conjunction with
26335 &%server_hostname%&, for building the identifier for finding credentials
26336 from the keytab.
26337
26338
26339 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26340 Beware that these variables will typically include a realm, thus will appear
26341 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26342 not verified, so a malicious client can set it to anything.
26343
26344 The &$auth1$& field should be safely trustable as a value from the Key
26345 Distribution Center.  Note that these are not quite email addresses.
26346 Each identifier is for a role, and so the left-hand-side may include a
26347 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26348
26349 .vindex "&$auth1$&, &$auth2$&, etc"
26350 .ilist
26351 .vindex "&$auth1$&"
26352 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26353 .next
26354 .vindex "&$auth2$&"
26355 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26356 authentication.  If that was empty, this will also be set to the
26357 GSS Display Name.
26358 .endlist
26359
26360
26361 . ////////////////////////////////////////////////////////////////////////////
26362 . ////////////////////////////////////////////////////////////////////////////
26363
26364 .chapter "The spa authenticator" "CHAPspa"
26365 .scindex IIDspaauth1 "&(spa)& authenticator"
26366 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26367 .cindex "authentication" "Microsoft Secure Password"
26368 .cindex "authentication" "NTLM"
26369 .cindex "Microsoft Secure Password Authentication"
26370 .cindex "NTLM authentication"
26371 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26372 Password Authentication'& mechanism,
26373 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26374 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26375 taken from the Samba project (&url(http://www.samba.org)). The code for the
26376 server side was subsequently contributed by Tom Kistner. The mechanism works as
26377 follows:
26378
26379 .ilist
26380 After the AUTH command has been accepted, the client sends an SPA
26381 authentication request based on the user name and optional domain.
26382 .next
26383 The server sends back a challenge.
26384 .next
26385 The client builds a challenge response which makes use of the user's password
26386 and sends it to the server, which then accepts or rejects it.
26387 .endlist
26388
26389 Encryption is used to protect the password in transit.
26390
26391
26392
26393 .section "Using spa as a server" "SECID179"
26394 .cindex "options" "&(spa)& authenticator (server)"
26395 The &(spa)& authenticator has just one server option:
26396
26397 .option server_password spa string&!! unset
26398 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26399 This option is expanded, and the result must be the cleartext password for the
26400 authenticating user, whose name is at this point in &$auth1$&. For
26401 compatibility with previous releases of Exim, the user name is also placed in
26402 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26403 it can lead to confusion in string expansions that also use numeric variables
26404 for other things. For example:
26405 .code
26406 spa:
26407   driver = spa
26408   public_name = NTLM
26409   server_password = \
26410     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26411 .endd
26412 If the expansion is forced to fail, authentication fails. Any other expansion
26413 failure causes a temporary error code to be returned.
26414
26415
26416
26417
26418
26419 .section "Using spa as a client" "SECID180"
26420 .cindex "options" "&(spa)& authenticator (client)"
26421 The &(spa)& authenticator has the following client options:
26422
26423
26424
26425 .option client_domain spa string&!! unset
26426 This option specifies an optional domain for the authentication.
26427
26428
26429 .option client_password spa string&!! unset
26430 This option specifies the user's password, and must be set.
26431
26432
26433 .option client_username spa string&!! unset
26434 This option specifies the user name, and must be set. Here is an example of a
26435 configuration of this authenticator for use with the mail servers at
26436 &'msn.com'&:
26437 .code
26438 msn:
26439   driver = spa
26440   public_name = MSN
26441   client_username = msn/msn_username
26442   client_password = msn_plaintext_password
26443   client_domain = DOMAIN_OR_UNSET
26444 .endd
26445 .ecindex IIDspaauth1
26446 .ecindex IIDspaauth2
26447
26448
26449
26450
26451
26452 . ////////////////////////////////////////////////////////////////////////////
26453 . ////////////////////////////////////////////////////////////////////////////
26454
26455 .chapter "The tls authenticator" "CHAPtlsauth"
26456 .scindex IIDtlsauth1 "&(tls)& authenticator"
26457 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26458 .cindex "authentication" "Client Certificate"
26459 .cindex "authentication" "X509"
26460 .cindex "Certificate-based authentication"
26461 The &(tls)& authenticator provides server support for
26462 authentication based on client certificates.
26463
26464 It is not an SMTP authentication mechanism and is not
26465 advertised by the server as part of the SMTP EHLO response.
26466 It is an Exim authenticator in the sense that it affects
26467 the protocol element of the log line, can be tested for
26468 by the &%authenticated%& ACL condition, and can set
26469 the &$authenticated_id$& variable.
26470
26471 The client must present a verifiable certificate,
26472 for which it must have been requested via the
26473 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26474 (see &<<CHAPTLS>>&).
26475
26476 If an authenticator of this type is configured it is
26477 run before any SMTP-level communication is done,
26478 and can authenticate the connection.
26479 If it does, SMTP authentication is not offered.
26480
26481 A maximum of one authenticator of this type may be present.
26482
26483
26484 .cindex "options" "&(tls)& authenticator (server)"
26485 The &(tls)& authenticator has three server options:
26486
26487 .option server_param1 tls string&!! unset
26488 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26489 This option is expanded after the TLS negotiation and
26490 the result is placed in &$auth1$&.
26491 If the expansion is forced to fail, authentication fails. Any other expansion
26492 failure causes a temporary error code to be returned.
26493
26494 .option server_param2 tls string&!! unset
26495 .option server_param3 tls string&!! unset
26496 As above, for &$auth2$& and &$auth3$&.
26497
26498 &%server_param1%& may also be spelled &%server_param%&.
26499
26500
26501 Example:
26502 .code
26503 tls:
26504   driver = tls
26505   server_param1 =     ${certextract {subj_altname,mail,>:} \
26506                                     {$tls_in_peercert}}
26507   server_condition =  ${if forany {$auth1} \
26508                             {!= {0} \
26509                                 {${lookup ldap{ldap:///\
26510                          mailname=${quote_ldap_dn:${lc:$item}},\
26511                          ou=users,LDAP_DC?mailid} {$value}{0} \
26512                        }    }   } }
26513   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26514 .endd
26515 This accepts a client certificate that is verifiable against any
26516 of your configured trust-anchors
26517 which usually means the full set of public CAs)
26518 and which has a SAN with a good account name.
26519 Note that the client cert is on the wire in-clear, including the SAN,
26520 whereas a plaintext SMTP AUTH done inside TLS is not.
26521
26522 . An alternative might use
26523 . .code
26524 .   server_param1 = ${sha256:$tls_in_peercert}
26525 . .endd
26526 . to require one of a set of specific certs that define a given account
26527 . (the verification is still required, but mostly irrelevant).
26528 . This would help for per-device use.
26529
26530 . However, for the future we really need support for checking a
26531 . user cert in LDAP - which probably wants a base-64 DER.
26532
26533 .ecindex IIDtlsauth1
26534 .ecindex IIDtlsauth2
26535
26536
26537 Note that because authentication is traditionally an SMTP operation,
26538 the &%authenticated%& ACL condition cannot be used in
26539 a connect- or helo-ACL.
26540
26541
26542
26543 . ////////////////////////////////////////////////////////////////////////////
26544 . ////////////////////////////////////////////////////////////////////////////
26545
26546 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26547          "Encrypted SMTP connections"
26548 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26549 .scindex IIDencsmtp2 "SMTP" "encryption"
26550 .cindex "TLS" "on SMTP connection"
26551 .cindex "OpenSSL"
26552 .cindex "GnuTLS"
26553 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26554 Sockets Layer), is implemented by making use of the OpenSSL library or the
26555 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26556 cryptographic code in the Exim distribution itself for implementing TLS. In
26557 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26558 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26559 You also need to understand the basic concepts of encryption at a managerial
26560 level, and in particular, the way that public keys, private keys, and
26561 certificates are used.
26562
26563 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26564 connection is established, the client issues a STARTTLS command. If the
26565 server accepts this, the client and the server negotiate an encryption
26566 mechanism. If the negotiation succeeds, the data that subsequently passes
26567 between them is encrypted.
26568
26569 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26570 and if so, what cipher suite is in use, whether the client supplied a
26571 certificate, and whether or not that certificate was verified. This makes it
26572 possible for an Exim server to deny or accept certain commands based on the
26573 encryption state.
26574
26575 &*Warning*&: Certain types of firewall and certain anti-virus products can
26576 disrupt TLS connections. You need to turn off SMTP scanning for these products
26577 in order to get TLS to work.
26578
26579
26580
26581 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26582          "SECID284"
26583 .cindex "ssmtp protocol"
26584 .cindex "smtps protocol"
26585 .cindex "SMTP" "ssmtp protocol"
26586 .cindex "SMTP" "smtps protocol"
26587 Early implementations of encrypted SMTP used a different TCP port from normal
26588 SMTP, and expected an encryption negotiation to start immediately, instead of
26589 waiting for a STARTTLS command from the client using the standard SMTP
26590 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26591 allocated for this purpose.
26592
26593 This approach was abandoned when encrypted SMTP was standardized, but there are
26594 still some legacy clients that use it. Exim supports these clients by means of
26595 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26596 numbers; the most common use is expected to be:
26597 .code
26598 tls_on_connect_ports = 465
26599 .endd
26600 The port numbers specified by this option apply to all SMTP connections, both
26601 via the daemon and via &'inetd'&. You still need to specify all the ports that
26602 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26603 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26604 an extra port &-- rather, it specifies different behaviour on a port that is
26605 defined elsewhere.
26606
26607 There is also a &%-tls-on-connect%& command line option. This overrides
26608 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26609
26610
26611
26612
26613
26614
26615 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26616 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26617 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26618 followed later, when the first versions of GnuTLS were released. To build Exim
26619 to use GnuTLS, you need to set
26620 .code
26621 USE_GNUTLS=yes
26622 .endd
26623 in Local/Makefile, in addition to
26624 .code
26625 SUPPORT_TLS=yes
26626 .endd
26627 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26628 include files and libraries for GnuTLS can be found.
26629
26630 There are some differences in usage when using GnuTLS instead of OpenSSL:
26631
26632 .ilist
26633 The &%tls_verify_certificates%& option
26634 cannot be the path of a directory
26635 for GnuTLS versions before 3.3.6
26636 (for later versions, or OpenSSL, it can be either).
26637 .next
26638 The default value for &%tls_dhparam%& differs for historical reasons.
26639 .next
26640 .vindex "&$tls_in_peerdn$&"
26641 .vindex "&$tls_out_peerdn$&"
26642 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26643 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26644 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26645 .next
26646 OpenSSL identifies cipher suites using hyphens as separators, for example:
26647 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26648 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26649 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26650 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26651 to handle its own older variants) when processing lists of cipher suites in the
26652 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26653 option).
26654 .next
26655 The &%tls_require_ciphers%& options operate differently, as described in the
26656 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26657 .next
26658 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26659 When using OpenSSL, this option is ignored.
26660 (If an API is found to let OpenSSL be configured in this way,
26661 let the Exim Maintainers know and we'll likely use it).
26662 .next
26663 Some other recently added features may only be available in one or the other.
26664 This should be documented with the feature.  If the documentation does not
26665 explicitly state that the feature is infeasible in the other TLS
26666 implementation, then patches are welcome.
26667 .endlist
26668
26669
26670 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26671 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26672 an explicit path; if the latter, then the text about generation still applies,
26673 but not the chosen filename.
26674 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26675 See the documentation of &%tls_dhparam%& for more information.
26676
26677 GnuTLS uses D-H parameters that may take a substantial amount of time
26678 to compute. It is unreasonable to re-compute them for every TLS session.
26679 Therefore, Exim keeps this data in a file in its spool directory, called
26680 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26681 of bits requested.
26682 The file is owned by the Exim user and is readable only by
26683 its owner. Every Exim process that start up GnuTLS reads the D-H
26684 parameters from this file. If the file does not exist, the first Exim process
26685 that needs it computes the data and writes it to a temporary file which is
26686 renamed once it is complete. It does not matter if several Exim processes do
26687 this simultaneously (apart from wasting a few resources). Once a file is in
26688 place, new Exim processes immediately start using it.
26689
26690 For maximum security, the parameters that are stored in this file should be
26691 recalculated periodically, the frequency depending on your paranoia level.
26692 If you are avoiding using the fixed D-H primes published in RFCs, then you
26693 are concerned about some advanced attacks and will wish to do this; if you do
26694 not regenerate then you might as well stick to the standard primes.
26695
26696 Arranging this is easy in principle; just delete the file when you want new
26697 values to be computed. However, there may be a problem. The calculation of new
26698 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26699 If the system is not very active, &_/dev/random_& may delay returning data
26700 until enough randomness (entropy) is available. This may cause Exim to hang for
26701 a substantial amount of time, causing timeouts on incoming connections.
26702
26703 The solution is to generate the parameters externally to Exim. They are stored
26704 in &_gnutls-params-N_& in PEM format, which means that they can be
26705 generated externally using the &(certtool)& command that is part of GnuTLS.
26706
26707 To replace the parameters with new ones, instead of deleting the file
26708 and letting Exim re-create it, you can generate new parameters using
26709 &(certtool)& and, when this has been done, replace Exim's cache file by
26710 renaming. The relevant commands are something like this:
26711 .code
26712 # ls
26713 [ look for file; assume gnutls-params-2236 is the most recent ]
26714 # rm -f new-params
26715 # touch new-params
26716 # chown exim:exim new-params
26717 # chmod 0600 new-params
26718 # certtool --generate-dh-params --bits 2236 >>new-params
26719 # openssl dhparam -noout -text -in new-params | head
26720 [ check the first line, make sure it's not more than 2236;
26721   if it is, then go back to the start ("rm") and repeat
26722   until the size generated is at most the size requested ]
26723 # chmod 0400 new-params
26724 # mv new-params gnutls-params-2236
26725 .endd
26726 If Exim never has to generate the parameters itself, the possibility of
26727 stalling is removed.
26728
26729 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26730 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26731 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26732 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26733 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26734 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26735 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26736 which applies to all D-H usage, client or server.  If the value returned by
26737 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26738 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26739 limit, which is still much higher than Exim historically used.
26740
26741 The filename and bits used will change as the GnuTLS maintainers change the
26742 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26743 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26744 2432 bits, while NSS is limited to 2236 bits.
26745
26746 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26747 increase the chance of the generated prime actually being within acceptable
26748 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26749 procedure above.  There is no sane procedure available to Exim to double-check
26750 the size of the generated prime, so it might still be too large.
26751
26752
26753 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26754 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26755 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26756 There is a function in the OpenSSL library that can be passed a list of cipher
26757 suites before the cipher negotiation takes place. This specifies which ciphers
26758 are acceptable. The list is colon separated and may contain names like
26759 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26760 directly to this function call.
26761 Many systems will install the OpenSSL manual-pages, so you may have
26762 &'ciphers(1)'& available to you.
26763 The following quotation from the OpenSSL
26764 documentation specifies what forms of item are allowed in the cipher string:
26765
26766 .ilist
26767 It can consist of a single cipher suite such as RC4-SHA.
26768 .next
26769 It can represent a list of cipher suites containing a certain algorithm,
26770 or cipher suites of a certain type. For example SHA1 represents all
26771 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26772 SSL v3 algorithms.
26773 .next
26774 Lists of cipher suites can be combined in a single cipher string using
26775 the + character. This is used as a logical and operation. For example
26776 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26777 algorithms.
26778 .endlist
26779
26780 Each cipher string can be optionally preceded by one of the characters &`!`&,
26781 &`-`& or &`+`&.
26782 .ilist
26783 If &`!`& is used, the ciphers are permanently deleted from the list. The
26784 ciphers deleted can never reappear in the list even if they are explicitly
26785 stated.
26786 .next
26787 If &`-`& is used, the ciphers are deleted from the list, but some or all
26788 of the ciphers can be added again by later options.
26789 .next
26790 If &`+`& is used, the ciphers are moved to the end of the list. This
26791 option does not add any new ciphers; it just moves matching existing ones.
26792 .endlist
26793
26794 If none of these characters is present, the string is interpreted as
26795 a list of ciphers to be appended to the current preference list. If the list
26796 includes any ciphers already present they will be ignored: that is, they will
26797 not be moved to the end of the list.
26798 .endlist
26799
26800 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26801 string:
26802 .code
26803 # note single-quotes to get ! past any shell history expansion
26804 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26805 .endd
26806
26807 This example will let the library defaults be permitted on the MX port, where
26808 there's probably no identity verification anyway, but ups the ante on the
26809 submission ports where the administrator might have some influence on the
26810 choice of clients used:
26811 .code
26812 # OpenSSL variant; see man ciphers(1)
26813 tls_require_ciphers = ${if =={$received_port}{25}\
26814                            {DEFAULT}\
26815                            {HIGH:!MD5:!SHA1}}
26816 .endd
26817
26818
26819
26820 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26821          "SECTreqciphgnu"
26822 .cindex "GnuTLS" "specifying parameters for"
26823 .cindex "TLS" "specifying ciphers (GnuTLS)"
26824 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26825 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26826 .cindex "TLS" "specifying protocols (GnuTLS)"
26827 .cindex "TLS" "specifying priority string (GnuTLS)"
26828 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26829 The GnuTLS library allows the caller to provide a "priority string", documented
26830 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26831 ciphersuite specification in OpenSSL.
26832
26833 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26834 and controls both protocols and ciphers.
26835
26836 The &%tls_require_ciphers%& option is available both as an global option,
26837 controlling how Exim behaves as a server, and also as an option of the
26838 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26839 the value is string expanded.  The resulting string is not an Exim list and
26840 the string is given to the GnuTLS library, so that Exim does not need to be
26841 aware of future feature enhancements of GnuTLS.
26842
26843 Documentation of the strings accepted may be found in the GnuTLS manual, under
26844 "Priority strings".  This is online as
26845 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26846 but beware that this relates to GnuTLS 3, which may be newer than the version
26847 installed on your system.  If you are using GnuTLS 3,
26848 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26849 on that site can be used to test a given string.
26850
26851 For example:
26852 .code
26853 # Disable older versions of protocols
26854 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26855 .endd
26856
26857 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26858 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26859 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26860
26861 This example will let the library defaults be permitted on the MX port, where
26862 there's probably no identity verification anyway, and lowers security further
26863 by increasing compatibility; but this ups the ante on the submission ports
26864 where the administrator might have some influence on the choice of clients
26865 used:
26866 .code
26867 # GnuTLS variant
26868 tls_require_ciphers = ${if =={$received_port}{25}\
26869                            {NORMAL:%COMPAT}\
26870                            {SECURE128}}
26871 .endd
26872
26873
26874 .section "Configuring an Exim server to use TLS" "SECID182"
26875 .cindex "TLS" "configuring an Exim server"
26876 When Exim has been built with TLS support, it advertises the availability of
26877 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26878 but not to any others. The default value of this option is unset, which means
26879 that STARTTLS is not advertised at all. This default is chosen because you
26880 need to set some other options in order to make TLS available, and also it is
26881 sensible for systems that want to use TLS only as a client.
26882
26883 If a client issues a STARTTLS command and there is some configuration
26884 problem in the server, the command is rejected with a 454 error. If the client
26885 persists in trying to issue SMTP commands, all except QUIT are rejected
26886 with the error
26887 .code
26888 554 Security failure
26889 .endd
26890 If a STARTTLS command is issued within an existing TLS session, it is
26891 rejected with a 554 error code.
26892
26893 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26894 match some hosts. You can, of course, set it to * to match all hosts.
26895 However, this is not all you need to do. TLS sessions to a server won't work
26896 without some further configuration at the server end.
26897
26898 It is rumoured that all existing clients that support TLS/SSL use RSA
26899 encryption. To make this work you need to set, in the server,
26900 .code
26901 tls_certificate = /some/file/name
26902 tls_privatekey = /some/file/name
26903 .endd
26904 These options are, in fact, expanded strings, so you can make them depend on
26905 the identity of the client that is connected if you wish. The first file
26906 contains the server's X509 certificate, and the second contains the private key
26907 that goes with it. These files need to be
26908 PEM format and readable by the Exim user, and must
26909 always be given as full path names.
26910 The key must not be password-protected.
26911 They can be the same file if both the
26912 certificate and the key are contained within it. If &%tls_privatekey%& is not
26913 set, or if its expansion is forced to fail or results in an empty string, this
26914 is assumed to be the case. The certificate file may also contain intermediate
26915 certificates that need to be sent to the client to enable it to authenticate
26916 the server's certificate.
26917
26918 If you do not understand about certificates and keys, please try to find a
26919 source of this background information, which is not Exim-specific. (There are a
26920 few comments below in section &<<SECTcerandall>>&.)
26921
26922 &*Note*&: These options do not apply when Exim is operating as a client &--
26923 they apply only in the case of a server. If you need to use a certificate in an
26924 Exim client, you must set the options of the same names in an &(smtp)&
26925 transport.
26926
26927 With just these options, an Exim server will be able to use TLS. It does not
26928 require the client to have a certificate (but see below for how to insist on
26929 this). There is one other option that may be needed in other situations. If
26930 .code
26931 tls_dhparam = /some/file/name
26932 .endd
26933 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26934 with the parameters contained in the file.
26935 Set this to &`none`& to disable use of DH entirely, by making no prime
26936 available:
26937 .code
26938 tls_dhparam = none
26939 .endd
26940 This may also be set to a string identifying a standard prime to be used for
26941 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26942 used is &`ike23`&.  There are a few standard primes available, see the
26943 documentation for &%tls_dhparam%& for the complete list.
26944
26945 See the command
26946 .code
26947 openssl dhparam
26948 .endd
26949 for a way of generating file data.
26950
26951 The strings supplied for these three options are expanded every time a client
26952 host connects. It is therefore possible to use different certificates and keys
26953 for different hosts, if you so wish, by making use of the client's IP address
26954 in &$sender_host_address$& to control the expansion. If a string expansion is
26955 forced to fail, Exim behaves as if the option is not set.
26956
26957 .cindex "cipher" "logging"
26958 .cindex "log" "TLS cipher"
26959 .vindex "&$tls_in_cipher$&"
26960 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26961 an incoming TLS connection. It is included in the &'Received:'& header of an
26962 incoming message (by default &-- you can, of course, change this), and it is
26963 also included in the log line that records a message's arrival, keyed by
26964 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26965 condition can be used to test for specific cipher suites in ACLs.
26966
26967 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26968 can check the name of the cipher suite and vary their actions accordingly. The
26969 cipher suite names vary, depending on which TLS library is being used. For
26970 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26971 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26972 documentation for more details.
26973
26974 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26975 (again depending on the &%tls_cipher%& log selector).
26976
26977
26978 .section "Requesting and verifying client certificates" "SECID183"
26979 .cindex "certificate" "verification of client"
26980 .cindex "TLS" "client certificate verification"
26981 If you want an Exim server to request a certificate when negotiating a TLS
26982 session with a client, you must set either &%tls_verify_hosts%& or
26983 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26984 apply to all TLS connections. For any host that matches one of these options,
26985 Exim requests a certificate as part of the setup of the TLS session. The
26986 contents of the certificate are verified by comparing it with a list of
26987 expected certificates.
26988 These may be the system default set (depending on library version),
26989 an explicit file or,
26990 depending on library version, a directory, identified by
26991 &%tls_verify_certificates%&.
26992
26993 A file can contain multiple certificates, concatenated end to end. If a
26994 directory is used
26995 (OpenSSL only),
26996 each certificate must be in a separate file, with a name (or a symbolic link)
26997 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26998 certificate. You can compute the relevant hash by running the command
26999 .code
27000 openssl x509 -hash -noout -in /cert/file
27001 .endd
27002 where &_/cert/file_& contains a single certificate.
27003
27004 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27005 what happens if the client does not supply a certificate, or if the certificate
27006 does not match any of the certificates in the collection named by
27007 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27008 attempt to set up a TLS session is aborted, and the incoming connection is
27009 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27010 session continues. ACLs that run for subsequent SMTP commands can detect the
27011 fact that no certificate was verified, and vary their actions accordingly. For
27012 example, you can insist on a certificate before accepting a message for
27013 relaying, but not when the message is destined for local delivery.
27014
27015 .vindex "&$tls_in_peerdn$&"
27016 When a client supplies a certificate (whether it verifies or not), the value of
27017 the Distinguished Name of the certificate is made available in the variable
27018 &$tls_in_peerdn$& during subsequent processing of the message.
27019
27020 .cindex "log" "distinguished name"
27021 Because it is often a long text string, it is not included in the log line or
27022 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27023 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27024 &%received_header_text%& to change the &'Received:'& header. When no
27025 certificate is supplied, &$tls_in_peerdn$& is empty.
27026
27027
27028 .section "Revoked certificates" "SECID184"
27029 .cindex "TLS" "revoked certificates"
27030 .cindex "revocation list"
27031 .cindex "certificate" "revocation list"
27032 .cindex "OCSP" "stapling"
27033 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27034 certificates are revoked. If you have such a list, you can pass it to an Exim
27035 server using the global option called &%tls_crl%& and to an Exim client using
27036 an identically named option for the &(smtp)& transport. In each case, the value
27037 of the option is expanded and must then be the name of a file that contains a
27038 CRL in PEM format.
27039 The downside is that clients have to periodically re-download a potentially huge
27040 file from every certificate authority they know of.
27041
27042 The way with most moving parts at query time is Online Certificate
27043 Status Protocol (OCSP), where the client verifies the certificate
27044 against an OCSP server run by the CA.  This lets the CA track all
27045 usage of the certs.  It requires running software with access to the
27046 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27047 is based on HTTP and can be proxied accordingly.
27048
27049 The only widespread OCSP server implementation (known to this writer)
27050 comes as part of OpenSSL and aborts on an invalid request, such as
27051 connecting to the port and then disconnecting.  This requires
27052 re-entering the passphrase each time some random client does this.
27053
27054 The third way is OCSP Stapling; in this, the server using a certificate
27055 issued by the CA periodically requests an OCSP proof of validity from
27056 the OCSP server, then serves it up inline as part of the TLS
27057 negotiation.   This approach adds no extra round trips, does not let the
27058 CA track users, scales well with number of certs issued by the CA and is
27059 resilient to temporary OCSP server failures, as long as the server
27060 starts retrying to fetch an OCSP proof some time before its current
27061 proof expires.  The downside is that it requires server support.
27062
27063 Unless Exim is built with the support disabled,
27064 .new
27065 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27066 .wen
27067 support for OCSP stapling is included.
27068
27069 There is a global option called &%tls_ocsp_file%&.
27070 The file specified therein is expected to be in DER format, and contain
27071 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27072 option will be re-expanded for SNI, if the &%tls_certificate%& option
27073 contains &`tls_in_sni`&, as per other TLS options.
27074
27075 Exim does not at this time implement any support for fetching a new OCSP
27076 proof.  The burden is on the administrator to handle this, outside of
27077 Exim.  The file specified should be replaced atomically, so that the
27078 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27079 on each connection, so a new file will be handled transparently on the
27080 next connection.
27081
27082 When built with OpenSSL Exim will check for a valid next update timestamp
27083 in the OCSP proof; if not present, or if the proof has expired, it will be
27084 ignored.
27085
27086 For the client to be able to verify the stapled OCSP the server must
27087 also supply, in its stapled information, any intermediate
27088 certificates for the chain leading to the OCSP proof from the signer
27089 of the server certificate.  There may be zero or one such. These
27090 intermediate certificates should be added to the server OCSP stapling
27091 file named by &%tls_ocsp_file%&.
27092
27093 Note that the proof only covers the terminal server certificate,
27094 not any of the chain from CA to it.
27095
27096 There is no current way to staple a proof for a client certificate.
27097
27098 .code
27099   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27100   OCSP server is supplied.  The server URL may be included in the
27101   server certificate, if the CA is helpful.
27102
27103   One failure mode seen was the OCSP Signer cert expiring before the end
27104   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27105   noted this as invalid overall, but the re-fetch script did not.
27106 .endd
27107
27108
27109
27110
27111 .section "Configuring an Exim client to use TLS" "SECID185"
27112 .cindex "cipher" "logging"
27113 .cindex "log" "TLS cipher"
27114 .cindex "log" "distinguished name"
27115 .cindex "TLS" "configuring an Exim client"
27116 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27117 deliveries as well as to incoming, the latter one causing logging of the
27118 server certificate's DN. The remaining client configuration for TLS is all
27119 within the &(smtp)& transport.
27120
27121 It is not necessary to set any options to have TLS work in the &(smtp)&
27122 transport. If Exim is built with TLS support, and TLS is advertised by a
27123 server, the &(smtp)& transport always tries to start a TLS session. However,
27124 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27125 transport) to a list of server hosts for which TLS should not be used.
27126
27127 If you do not want Exim to attempt to send messages unencrypted when an attempt
27128 to set up an encrypted connection fails in any way, you can set
27129 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27130 those hosts, delivery is always deferred if an encrypted connection cannot be
27131 set up. If there are any other hosts for the address, they are tried in the
27132 usual way.
27133
27134 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27135 the message unencrypted. It always does this if the response to STARTTLS is
27136 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27137 session after a success response code, what happens is controlled by the
27138 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27139 delivery to this host is deferred, and other hosts (if available) are tried. If
27140 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27141 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27142 negotiation fails, Exim closes the current connection (because it is in an
27143 unknown state), opens a new one to the same host, and then tries the delivery
27144 unencrypted.
27145
27146 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27147 transport provide the client with a certificate, which is passed to the server
27148 if it requests it. If the server is Exim, it will request a certificate only if
27149 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27150
27151 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27152 specifies a collection of expected server certificates.
27153 These may be the system default set (depending on library version),
27154 a file or,
27155 depending on library version, a directory,
27156 must name a file or,
27157 for OpenSSL only (not GnuTLS), a directory.
27158 The client verifies the server's certificate
27159 against this collection, taking into account any revoked certificates that are
27160 in the list defined by &%tls_crl%&.
27161 Failure to verify fails the TLS connection unless either of the
27162 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27163
27164 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27165 certificate verification to the listed servers.  Verification either must
27166 or need not succeed respectively.
27167
27168 The &(smtp)& transport has two OCSP-related options:
27169 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27170 is requested and required for the connection to proceed.  The default
27171 value is empty.
27172 &%hosts_request_ocsp%&; a host-list for which (additionally)
27173 a Certificate Status is requested (but not necessarily verified).  The default
27174 value is "*" meaning that requests are made unless configured
27175 otherwise.
27176
27177 The host(s) should also be in &%hosts_require_tls%&, and
27178 &%tls_verify_certificates%& configured for the transport,
27179 for OCSP to be relevant.
27180
27181 If
27182 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27183 list of permitted cipher suites. If either of these checks fails, delivery to
27184 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27185 alternative hosts, if any.
27186
27187  &*Note*&:
27188 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27189 is operating as a client. Exim does not assume that a server certificate (set
27190 by the global options of the same name) should also be used when operating as a
27191 client.
27192
27193 .vindex "&$host$&"
27194 .vindex "&$host_address$&"
27195 All the TLS options in the &(smtp)& transport are expanded before use, with
27196 &$host$& and &$host_address$& containing the name and address of the server to
27197 which the client is connected. Forced failure of an expansion causes Exim to
27198 behave as if the relevant option were unset.
27199
27200 .vindex &$tls_out_bits$&
27201 .vindex &$tls_out_cipher$&
27202 .vindex &$tls_out_peerdn$&
27203 .vindex &$tls_out_sni$&
27204 Before an SMTP connection is established, the
27205 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27206 variables are emptied. (Until the first connection, they contain the values
27207 that were set when the message was received.) If STARTTLS is subsequently
27208 successfully obeyed, these variables are set to the relevant values for the
27209 outgoing connection.
27210
27211
27212
27213 .section "Use of TLS Server Name Indication" "SECTtlssni"
27214 .cindex "TLS" "Server Name Indication"
27215 .vindex "&$tls_in_sni$&"
27216 .oindex "&%tls_in_sni%&"
27217 With TLS1.0 or above, there is an extension mechanism by which extra
27218 information can be included at various points in the protocol.  One of these
27219 extensions, documented in RFC 6066 (and before that RFC 4366) is
27220 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27221 client in the initial handshake, so that the server can examine the servername
27222 within and possibly choose to use different certificates and keys (and more)
27223 for this session.
27224
27225 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27226 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27227 address.
27228
27229 With SMTP to MX, there are the same problems here as in choosing the identity
27230 against which to validate a certificate: you can't rely on insecure DNS to
27231 provide the identity which you then cryptographically verify.  So this will
27232 be of limited use in that environment.
27233
27234 With SMTP to Submission, there is a well-defined hostname which clients are
27235 connecting to and can validate certificates against.  Thus clients &*can*&
27236 choose to include this information in the TLS negotiation.  If this becomes
27237 wide-spread, then hosters can choose to present different certificates to
27238 different clients.  Or even negotiate different cipher suites.
27239
27240 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27241 if not empty, will be sent on a TLS session as part of the handshake.  There's
27242 nothing more to it.  Choosing a sensible value not derived insecurely is the
27243 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27244 for the lifetime of the client connection (including during authentication).
27245
27246 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27247 received from a client.
27248 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27249
27250 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27251 option (prior to expansion) then the following options will be re-expanded
27252 during TLS session handshake, to permit alternative values to be chosen:
27253
27254 .ilist
27255 .vindex "&%tls_certificate%&"
27256 &%tls_certificate%&
27257 .next
27258 .vindex "&%tls_crl%&"
27259 &%tls_crl%&
27260 .next
27261 .vindex "&%tls_privatekey%&"
27262 &%tls_privatekey%&
27263 .next
27264 .vindex "&%tls_verify_certificates%&"
27265 &%tls_verify_certificates%&
27266 .next
27267 .vindex "&%tls_ocsp_file%&"
27268 &%tls_ocsp_file%&
27269 .endlist
27270
27271 Great care should be taken to deal with matters of case, various injection
27272 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27273 can always be referenced; it is important to remember that &$tls_sni$& is
27274 arbitrary unverified data provided prior to authentication.
27275
27276 The Exim developers are proceeding cautiously and so far no other TLS options
27277 are re-expanded.
27278
27279 When Exim is built against OpenSSL, OpenSSL must have been built with support
27280 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27281 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27282 see &`-servername`& in the output, then OpenSSL has support.
27283
27284 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27285 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27286 built, then you have SNI support).
27287
27288
27289
27290 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27291          "SECTmulmessam"
27292 .cindex "multiple SMTP deliveries with TLS"
27293 .cindex "TLS" "multiple message deliveries"
27294 Exim sends multiple messages down the same TCP/IP connection by starting up
27295 an entirely new delivery process for each message, passing the socket from
27296 one process to the next. This implementation does not fit well with the use
27297 of TLS, because there is quite a lot of state information associated with a TLS
27298 connection, not just a socket identification. Passing all the state information
27299 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27300 session before passing the socket to a new process. The new process may then
27301 try to start a new TLS session, and if successful, may try to re-authenticate
27302 if AUTH is in use, before sending the next message.
27303
27304 The RFC is not clear as to whether or not an SMTP session continues in clear
27305 after TLS has been shut down, or whether TLS may be restarted again later, as
27306 just described. However, if the server is Exim, this shutdown and
27307 reinitialization works. It is not known which (if any) other servers operate
27308 successfully if the client closes a TLS session and continues with unencrypted
27309 SMTP, but there are certainly some that do not work. For such servers, Exim
27310 should not pass the socket to another process, because the failure of the
27311 subsequent attempt to use it would cause Exim to record a temporary host error,
27312 and delay other deliveries to that host.
27313
27314 To test for this case, Exim sends an EHLO command to the server after
27315 closing down the TLS session. If this fails in any way, the connection is
27316 closed instead of being passed to a new delivery process, but no retry
27317 information is recorded.
27318
27319 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27320 &(smtp)& transport to match those hosts for which Exim should not pass
27321 connections to new processes if TLS has been used.
27322
27323
27324
27325
27326 .section "Certificates and all that" "SECTcerandall"
27327 .cindex "certificate" "references to discussion"
27328 In order to understand fully how TLS works, you need to know about
27329 certificates, certificate signing, and certificate authorities. This is not the
27330 place to give a tutorial, especially as I do not know very much about it
27331 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27332 to Apache, currently at
27333 .display
27334 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27335 .endd
27336 Other parts of the &'modssl'& documentation are also helpful, and have
27337 links to further files.
27338 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27339 0-201-61598-3), contains both introductory and more in-depth descriptions.
27340 Some sample programs taken from the book are available from
27341 .display
27342 &url(http://www.rtfm.com/openssl-examples/)
27343 .endd
27344
27345
27346 .section "Certificate chains" "SECID186"
27347 The file named by &%tls_certificate%& may contain more than one
27348 certificate. This is useful in the case where the certificate that is being
27349 sent is validated by an intermediate certificate which the other end does
27350 not have. Multiple certificates must be in the correct order in the file.
27351 First the host's certificate itself, then the first intermediate
27352 certificate to validate the issuer of the host certificate, then the next
27353 intermediate certificate to validate the issuer of the first intermediate
27354 certificate, and so on, until finally (optionally) the root certificate.
27355 The root certificate must already be trusted by the recipient for
27356 validation to succeed, of course, but if it's not preinstalled, sending the
27357 root certificate along with the rest makes it available for the user to
27358 install if the receiving end is a client MUA that can interact with a user.
27359
27360 Note that certificates using MD5 are unlikely to work on today's Internet;
27361 even if your libraries allow loading them for use in Exim when acting as a
27362 server, increasingly clients will not accept such certificates.  The error
27363 diagnostics in such a case can be frustratingly vague.
27364
27365
27366
27367 .section "Self-signed certificates" "SECID187"
27368 .cindex "certificate" "self-signed"
27369 You can create a self-signed certificate using the &'req'& command provided
27370 with OpenSSL, like this:
27371 . ==== Do not shorten the duration here without reading and considering
27372 . ==== the text below.  Please leave it at 9999 days.
27373 .code
27374 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27375             -days 9999 -nodes
27376 .endd
27377 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27378 delimited and so can be identified independently. The &%-days%& option
27379 specifies a period for which the certificate is valid. The &%-nodes%& option is
27380 important: if you do not set it, the key is encrypted with a passphrase
27381 that you are prompted for, and any use that is made of the key causes more
27382 prompting for the passphrase. This is not helpful if you are going to use
27383 this certificate and key in an MTA, where prompting is not possible.
27384
27385 . ==== I expect to still be working 26 years from now.  The less technical
27386 . ==== debt I create, in terms of storing up trouble for my later years, the
27387 . ==== happier I will be then.  We really have reached the point where we
27388 . ==== should start, at the very least, provoking thought and making folks
27389 . ==== pause before proceeding, instead of leaving all the fixes until two
27390 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27391 . ==== -pdp, 2012
27392 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27393 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27394 the above command might produce a date in the past.  Think carefully about
27395 the lifetime of the systems you're deploying, and either reduce the duration
27396 of the certificate or reconsider your platform deployment.  (At time of
27397 writing, reducing the duration is the most likely choice, but the inexorable
27398 progression of time takes us steadily towards an era where this will not
27399 be a sensible resolution).
27400
27401 A self-signed certificate made in this way is sufficient for testing, and
27402 may be adequate for all your requirements if you are mainly interested in
27403 encrypting transfers, and not in secure identification.
27404
27405 However, many clients require that the certificate presented by the server be a
27406 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27407 certificate. In this situation, the self-signed certificate described above
27408 must be installed on the client host as a trusted root &'certification
27409 authority'& (CA), and the certificate used by Exim must be a user certificate
27410 signed with that self-signed certificate.
27411
27412 For information on creating self-signed CA certificates and using them to sign
27413 user certificates, see the &'General implementation overview'& chapter of the
27414 Open-source PKI book, available online at
27415 &url(http://ospkibook.sourceforge.net/).
27416 .ecindex IIDencsmtp1
27417 .ecindex IIDencsmtp2
27418
27419
27420
27421 . ////////////////////////////////////////////////////////////////////////////
27422 . ////////////////////////////////////////////////////////////////////////////
27423
27424 .chapter "Access control lists" "CHAPACL"
27425 .scindex IIDacl "&ACL;" "description"
27426 .cindex "control of incoming mail"
27427 .cindex "message" "controlling incoming"
27428 .cindex "policy control" "access control lists"
27429 Access Control Lists (ACLs) are defined in a separate section of the run time
27430 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27431 name, terminated by a colon. Here is a complete ACL section that contains just
27432 one very small ACL:
27433 .code
27434 begin acl
27435 small_acl:
27436   accept   hosts = one.host.only
27437 .endd
27438 You can have as many lists as you like in the ACL section, and the order in
27439 which they appear does not matter. The lists are self-terminating.
27440
27441 The majority of ACLs are used to control Exim's behaviour when it receives
27442 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27443 when a local process submits a message using SMTP by specifying the &%-bs%&
27444 option. The most common use is for controlling which recipients are accepted
27445 in incoming messages. In addition, you can define an ACL that is used to check
27446 local non-SMTP messages. The default configuration file contains an example of
27447 a realistic ACL for checking RCPT commands. This is discussed in chapter
27448 &<<CHAPdefconfil>>&.
27449
27450
27451 .section "Testing ACLs" "SECID188"
27452 The &%-bh%& command line option provides a way of testing your ACL
27453 configuration locally by running a fake SMTP session with which you interact.
27454 The host &'relay-test.mail-abuse.org'& provides a service for checking your
27455 relaying configuration (see section &<<SECTcheralcon>>& for more details).
27456
27457
27458
27459 .section "Specifying when ACLs are used" "SECID189"
27460 .cindex "&ACL;" "options for specifying"
27461 In order to cause an ACL to be used, you have to name it in one of the relevant
27462 options in the main part of the configuration. These options are:
27463 .cindex "AUTH" "ACL for"
27464 .cindex "DATA" "ACLs for"
27465 .cindex "ETRN" "ACL for"
27466 .cindex "EXPN" "ACL for"
27467 .cindex "HELO" "ACL for"
27468 .cindex "EHLO" "ACL for"
27469 .cindex "DKIM" "ACL for"
27470 .cindex "MAIL" "ACL for"
27471 .cindex "QUIT, ACL for"
27472 .cindex "RCPT" "ACL for"
27473 .cindex "STARTTLS, ACL for"
27474 .cindex "VRFY" "ACL for"
27475 .cindex "SMTP" "connection, ACL for"
27476 .cindex "non-SMTP messages" "ACLs for"
27477 .cindex "MIME content scanning" "ACL for"
27478 .cindex "PRDR" "ACL for"
27479
27480 .table2 140pt
27481 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27482 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27483 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27484 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27485 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27486 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27487 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27488 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27489 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27490 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27491 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27492 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27493 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27494 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27495 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27496 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27497 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27498 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27499 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27500 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27501 .endtable
27502
27503 For example, if you set
27504 .code
27505 acl_smtp_rcpt = small_acl
27506 .endd
27507 the little ACL defined above is used whenever Exim receives a RCPT command
27508 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27509 done when RCPT commands arrive. A rejection of RCPT should cause the
27510 sending MTA to give up on the recipient address contained in the RCPT
27511 command, whereas rejection at other times may cause the client MTA to keep on
27512 trying to deliver the message. It is therefore recommended that you do as much
27513 testing as possible at RCPT time.
27514
27515
27516 .section "The non-SMTP ACLs" "SECID190"
27517 .cindex "non-SMTP messages" "ACLs for"
27518 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27519 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27520 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27521 the state of the SMTP connection such as encryption and authentication) are not
27522 relevant and are forbidden in these ACLs. However, the sender and recipients
27523 are known, so the &%senders%& and &%sender_domains%& conditions and the
27524 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27525 &$authenticated_sender$& are also available. You can specify added header lines
27526 in any of these ACLs.
27527
27528 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27529 non-SMTP message, before any of the message has been read. (This is the
27530 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27531 batched SMTP input, it runs after the DATA command has been reached. The
27532 result of this ACL is ignored; it cannot be used to reject a message. If you
27533 really need to, you could set a value in an ACL variable here and reject based
27534 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27535 controls, and in particular, it can be used to set
27536 .code
27537 control = suppress_local_fixups
27538 .endd
27539 This cannot be used in the other non-SMTP ACLs because by the time they are
27540 run, it is too late.
27541
27542 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27543 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27544
27545 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27546 kind of rejection is treated as permanent, because there is no way of sending a
27547 temporary error for these kinds of message.
27548
27549
27550 .section "The SMTP connect ACL" "SECID191"
27551 .cindex "SMTP" "connection, ACL for"
27552 .oindex &%smtp_banner%&
27553 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27554 session, after the test specified by &%host_reject_connection%& (which is now
27555 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27556 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27557 the message override the banner message that is otherwise specified by the
27558 &%smtp_banner%& option.
27559
27560
27561 .section "The EHLO/HELO ACL" "SECID192"
27562 .cindex "EHLO" "ACL for"
27563 .cindex "HELO" "ACL for"
27564 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27565 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27566 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27567 Note that a client may issue more than one EHLO or HELO command in an SMTP
27568 session, and indeed is required to issue a new EHLO or HELO after successfully
27569 setting up encryption following a STARTTLS command.
27570
27571 .new
27572 Note also that a deny neither forces the client to go away nor means that
27573 mail will be refused on the connection.  Consider checking for
27574 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27575 .wen
27576
27577 If the command is accepted by an &%accept%& verb that has a &%message%&
27578 modifier, the message may not contain more than one line (it will be truncated
27579 at the first newline and a panic logged if it does). Such a message cannot
27580 affect the EHLO options that are listed on the second and subsequent lines of
27581 an EHLO response.
27582
27583
27584 .section "The DATA ACLs" "SECID193"
27585 .cindex "DATA" "ACLs for"
27586 Two ACLs are associated with the DATA command, because it is two-stage
27587 command, with two responses being sent to the client.
27588 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27589 is obeyed. This gives you control after all the RCPT commands, but before
27590 the message itself is received. It offers the opportunity to give a negative
27591 response to the DATA command before the data is transmitted. Header lines
27592 added by MAIL or RCPT ACLs are not visible at this time, but any that
27593 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27594
27595 You cannot test the contents of the message, for example, to verify addresses
27596 in the headers, at RCPT time or when the DATA command is received. Such
27597 tests have to appear in the ACL that is run after the message itself has been
27598 received, before the final response to the DATA command is sent. This is
27599 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27600 associated with the DATA command.
27601
27602 For both of these ACLs, it is not possible to reject individual recipients. An
27603 error response rejects the entire message. Unfortunately, it is known that some
27604 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27605 before or after the data) correctly &-- they keep the message on their queues
27606 and try again later, but that is their problem, though it does waste some of
27607 your resources.
27608
27609 The &%acl_smtp_data%& ACL is run after
27610 the &%acl_smtp_data_prdr%&,
27611 the &%acl_smtp_dkim%&
27612 and the &%acl_smtp_mime%& ACLs.
27613
27614 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27615 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27616 enabled (which is the default).
27617
27618 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27619 received, and is executed for each DKIM signature found in a message.  If not
27620 otherwise specified, the default action is to accept.
27621
27622 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27623
27624 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27625
27626
27627 .section "The SMTP MIME ACL" "SECID194"
27628 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27629 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27630
27631 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27632
27633
27634 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27635 .cindex "PRDR" "ACL for"
27636 .oindex "&%prdr_enable%&"
27637 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27638 with PRDR support enabled (which is the default).
27639 It becomes active only when the PRDR feature is negotiated between
27640 client and server for a message, and more than one recipient
27641 has been accepted.
27642
27643 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27644 has been received, and is executed once for each recipient of the message
27645 with &$local_part$& and &$domain$& valid.
27646 The test may accept, defer or deny for individual recipients.
27647 The &%acl_smtp_data%& will still be called after this ACL and
27648 can reject the message overall, even if this ACL has accepted it
27649 for some or all recipients.
27650
27651 PRDR may be used to support per-user content filtering.  Without it
27652 one must defer any recipient after the first that has a different
27653 content-filter configuration.  With PRDR, the RCPT-time check
27654 .new
27655 .cindex "PRDR" "variable for"
27656 for this can be disabled when the variable &$prdr_requested$&
27657 is &"yes"&.
27658 .wen
27659 Any required difference in behaviour of the main DATA-time
27660 ACL should however depend on the PRDR-time ACL having run, as Exim
27661 will avoid doing so in some situations (e.g.  single-recipient mails).
27662
27663 See also the &%prdr_enable%& global option
27664 and the &%hosts_try_prdr%& smtp transport option.
27665
27666 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27667 If the ACL is not defined, processing completes as if
27668 the feature was not requested by the client.
27669
27670 .section "The QUIT ACL" "SECTQUITACL"
27671 .cindex "QUIT, ACL for"
27672 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27673 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27674 does not in fact control any access.
27675 For this reason, it may only accept
27676 or warn as its final result.
27677
27678 This ACL can be used for tasks such as custom logging at the end of an SMTP
27679 session. For example, you can use ACL variables in other ACLs to count
27680 messages, recipients, etc., and log the totals at QUIT time using one or
27681 more &%logwrite%& modifiers on a &%warn%& verb.
27682
27683 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27684 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27685
27686 You do not need to have a final &%accept%&, but if you do, you can use a
27687 &%message%& modifier to specify custom text that is sent as part of the 221
27688 response to QUIT.
27689
27690 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27691 failure (for example, failure to open a log file, or when Exim is bombing out
27692 because it has detected an unrecoverable error), all SMTP commands from the
27693 client are given temporary error responses until QUIT is received or the
27694 connection is closed. In these special cases, the QUIT ACL does not run.
27695
27696
27697 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27698 .vindex &$acl_smtp_notquit$&
27699 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27700 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27701 trouble, such as being unable to write to its log files, this ACL is not run,
27702 because it might try to do things (such as write to log files) that make the
27703 situation even worse.
27704
27705 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27706 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27707 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27708 and &%warn%&.
27709
27710 .vindex &$smtp_notquit_reason$&
27711 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27712 to a string that indicates the reason for the termination of the SMTP
27713 connection. The possible values are:
27714 .table2
27715 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27716 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27717 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27718 .irow &`connection-lost`&          "The SMTP connection has been lost"
27719 .irow &`data-timeout`&             "Timeout while reading message data"
27720 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27721 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27722 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27723 .irow &`synchronization-error`&    "SMTP synchronization error"
27724 .irow &`tls-failed`&               "TLS failed to start"
27725 .endtable
27726 In most cases when an SMTP connection is closed without having received QUIT,
27727 Exim sends an SMTP response message before actually closing the connection.
27728 With the exception of the &`acl-drop`& case, the default message can be
27729 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27730 &%drop%& verb in another ACL, it is the message from the other ACL that is
27731 used.
27732
27733
27734 .section "Finding an ACL to use" "SECID195"
27735 .cindex "&ACL;" "finding which to use"
27736 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27737 you can use different ACLs in different circumstances. For example,
27738 .code
27739 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27740                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27741 .endd
27742 In the default configuration file there are some example settings for
27743 providing an RFC 4409 message submission service on port 587 and a
27744 non-standard &"smtps"& service on port 465. You can use a string
27745 expansion like this to choose an ACL for MUAs on these ports which is
27746 more appropriate for this purpose than the default ACL on port 25.
27747
27748 The expanded string does not have to be the name of an ACL in the
27749 configuration file; there are other possibilities. Having expanded the
27750 string, Exim searches for an ACL as follows:
27751
27752 .ilist
27753 If the string begins with a slash, Exim uses it as a file name, and reads its
27754 contents as an ACL. The lines are processed in the same way as lines in the
27755 Exim configuration file. In particular, continuation lines are supported, blank
27756 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27757 If the file does not exist or cannot be read, an error occurs (typically
27758 causing a temporary failure of whatever caused the ACL to be run). For example:
27759 .code
27760 acl_smtp_data = /etc/acls/\
27761   ${lookup{$sender_host_address}lsearch\
27762   {/etc/acllist}{$value}{default}}
27763 .endd
27764 This looks up an ACL file to use on the basis of the host's IP address, falling
27765 back to a default if the lookup fails. If an ACL is successfully read from a
27766 file, it is retained in memory for the duration of the Exim process, so that it
27767 can be re-used without having to re-read the file.
27768 .next
27769 If the string does not start with a slash, and does not contain any spaces,
27770 Exim searches the ACL section of the configuration for an ACL whose name
27771 matches the string.
27772 .next
27773 If no named ACL is found, or if the string contains spaces, Exim parses
27774 the string as an inline ACL. This can save typing in cases where you just
27775 want to have something like
27776 .code
27777 acl_smtp_vrfy = accept
27778 .endd
27779 in order to allow free use of the VRFY command. Such a string may contain
27780 newlines; it is processed in the same way as an ACL that is read from a file.
27781 .endlist
27782
27783
27784
27785
27786 .section "ACL return codes" "SECID196"
27787 .cindex "&ACL;" "return codes"
27788 Except for the QUIT ACL, which does not affect the SMTP return code (see
27789 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27790 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27791 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27792 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27793 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27794 This also causes a 4&'xx'& return code.
27795
27796 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27797 &"deny"&, because there is no mechanism for passing temporary errors to the
27798 submitters of non-SMTP messages.
27799
27800
27801 ACLs that are relevant to message reception may also return &"discard"&. This
27802 has the effect of &"accept"&, but causes either the entire message or an
27803 individual recipient address to be discarded. In other words, it is a
27804 blackholing facility. Use it with care.
27805
27806 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27807 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27808 RCPT ACL is to discard just the one recipient address. If there are no
27809 recipients left when the message's data is received, the DATA ACL is not
27810 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27811 remaining recipients. The &"discard"& return is not permitted for the
27812 &%acl_smtp_predata%& ACL.
27813
27814
27815 .cindex "&[local_scan()]& function" "when all recipients discarded"
27816 The &[local_scan()]& function is always run, even if there are no remaining
27817 recipients; it may create new recipients.
27818
27819
27820
27821 .section "Unset ACL options" "SECID197"
27822 .cindex "&ACL;" "unset options"
27823 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27824 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27825 not defined at all. For any defined ACL, the default action when control
27826 reaches the end of the ACL statements is &"deny"&.
27827
27828 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27829 these two are ACLs that are used only for their side effects. They cannot be
27830 used to accept or reject anything.
27831
27832 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27833 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27834 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27835 when the ACL is not defined is &"accept"&.
27836
27837 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27838 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27839 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27840 messages over an SMTP connection. For an example, see the ACL in the default
27841 configuration file.
27842
27843
27844
27845
27846 .section "Data for message ACLs" "SECID198"
27847 .cindex "&ACL;" "data for message ACL"
27848 .vindex &$domain$&
27849 .vindex &$local_part$&
27850 .vindex &$sender_address$&
27851 .vindex &$sender_host_address$&
27852 .vindex &$smtp_command$&
27853 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27854 that contain information about the host and the message's sender (for example,
27855 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27856 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27857 &$local_part$& are set from the argument address. The entire SMTP command
27858 is available in &$smtp_command$&.
27859
27860 When an ACL for the AUTH parameter of MAIL is running, the variables that
27861 contain information about the host are set, but &$sender_address$& is not yet
27862 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27863 how it is used.
27864
27865 .vindex "&$message_size$&"
27866 The &$message_size$& variable is set to the value of the SIZE parameter on
27867 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27868 that parameter is not given. The value is updated to the true message size by
27869 the time the final DATA ACL is run (after the message data has been
27870 received).
27871
27872 .vindex "&$rcpt_count$&"
27873 .vindex "&$recipients_count$&"
27874 The &$rcpt_count$& variable increases by one for each RCPT command received.
27875 The &$recipients_count$& variable increases by one each time a RCPT command is
27876 accepted, so while an ACL for RCPT is being processed, it contains the number
27877 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27878 &$rcpt_count$& contains the total number of RCPT commands, and
27879 &$recipients_count$& contains the total number of accepted recipients.
27880
27881
27882
27883
27884
27885 .section "Data for non-message ACLs" "SECTdatfornon"
27886 .cindex "&ACL;" "data for non-message ACL"
27887 .vindex &$smtp_command_argument$&
27888 .vindex &$smtp_command$&
27889 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27890 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27891 and the entire SMTP command is available in &$smtp_command$&.
27892 These variables can be tested using a &%condition%& condition. For example,
27893 here is an ACL for use with AUTH, which insists that either the session is
27894 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27895 does not permit authentication methods that use cleartext passwords on
27896 unencrypted connections.
27897 .code
27898 acl_check_auth:
27899   accept encrypted = *
27900   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27901                      {CRAM-MD5}}
27902   deny   message   = TLS encryption or CRAM-MD5 required
27903 .endd
27904 (Another way of applying this restriction is to arrange for the authenticators
27905 that use cleartext passwords not to be advertised when the connection is not
27906 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27907 option to do this.)
27908
27909
27910
27911 .section "Format of an ACL" "SECID199"
27912 .cindex "&ACL;" "format of"
27913 .cindex "&ACL;" "verbs, definition of"
27914 An individual ACL consists of a number of statements. Each statement starts
27915 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27916 Modifiers can change the way the verb operates, define error and log messages,
27917 set variables, insert delays, and vary the processing of accepted messages.
27918
27919 If all the conditions are met, the verb is obeyed. The same condition may be
27920 used (with different arguments) more than once in the same statement. This
27921 provides a means of specifying an &"and"& conjunction between conditions. For
27922 example:
27923 .code
27924 deny  dnslists = list1.example
27925 dnslists = list2.example
27926 .endd
27927 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27928 the conditions and modifiers when it reaches a condition that fails. What
27929 happens then depends on the verb (and in one case, on a special modifier). Not
27930 all the conditions make sense at every testing point. For example, you cannot
27931 test a sender address in the ACL that is run for a VRFY command.
27932
27933
27934 .section "ACL verbs" "SECID200"
27935 The ACL verbs are as follows:
27936
27937 .ilist
27938 .cindex "&%accept%& ACL verb"
27939 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27940 of the conditions are not met, what happens depends on whether &%endpass%&
27941 appears among the conditions (for syntax see below). If the failing condition
27942 is before &%endpass%&, control is passed to the next ACL statement; if it is
27943 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27944 check a RCPT command:
27945 .code
27946 accept domains = +local_domains
27947 endpass
27948 verify = recipient
27949 .endd
27950 If the recipient domain does not match the &%domains%& condition, control
27951 passes to the next statement. If it does match, the recipient is verified, and
27952 the command is accepted if verification succeeds. However, if verification
27953 fails, the ACL yields &"deny"&, because the failing condition is after
27954 &%endpass%&.
27955
27956 The &%endpass%& feature has turned out to be confusing to many people, so its
27957 use is not recommended nowadays. It is always possible to rewrite an ACL so
27958 that &%endpass%& is not needed, and it is no longer used in the default
27959 configuration.
27960
27961 .cindex "&%message%& ACL modifier" "with &%accept%&"
27962 If a &%message%& modifier appears on an &%accept%& statement, its action
27963 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27964 (when an &%accept%& verb either accepts or passes control to the next
27965 statement), &%message%& can be used to vary the message that is sent when an
27966 SMTP command is accepted. For example, in a RCPT ACL you could have:
27967 .display
27968 &`accept  `&<&'some conditions'&>
27969 &`        message = OK, I will allow you through today`&
27970 .endd
27971 You can specify an SMTP response code, optionally followed by an &"extended
27972 response code"& at the start of the message, but the first digit must be the
27973 same as would be sent by default, which is 2 for an &%accept%& verb.
27974
27975 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27976 an error message that is used when access is denied. This behaviour is retained
27977 for backward compatibility, but current &"best practice"& is to avoid the use
27978 of &%endpass%&.
27979
27980
27981 .next
27982 .cindex "&%defer%& ACL verb"
27983 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27984 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27985 &%defer%& is the same as &%deny%&, because there is no way of sending a
27986 temporary error. For a RCPT command, &%defer%& is much the same as using a
27987 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27988 be used in any ACL, and even for a recipient it might be a simpler approach.
27989
27990
27991 .next
27992 .cindex "&%deny%& ACL verb"
27993 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27994 the conditions are not met, control is passed to the next ACL statement. For
27995 example,
27996 .code
27997 deny dnslists = blackholes.mail-abuse.org
27998 .endd
27999 rejects commands from hosts that are on a DNS black list.
28000
28001
28002 .next
28003 .cindex "&%discard%& ACL verb"
28004 &%discard%&: This verb behaves like &%accept%&, except that it returns
28005 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28006 that are concerned with receiving messages. When all the conditions are true,
28007 the sending entity receives a &"success"& response. However, &%discard%& causes
28008 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28009 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28010 message's recipients are discarded. Recipients that are discarded before DATA
28011 do not appear in the log line when the &%received_recipients%& log selector is set.
28012
28013 If the &%log_message%& modifier is set when &%discard%& operates,
28014 its contents are added to the line that is automatically written to the log.
28015 The &%message%& modifier operates exactly as it does for &%accept%&.
28016
28017
28018 .next
28019 .cindex "&%drop%& ACL verb"
28020 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28021 forcibly closed after the 5&'xx'& error message has been sent. For example:
28022 .code
28023 drop   message   = I don't take more than 20 RCPTs
28024        condition = ${if > {$rcpt_count}{20}}
28025 .endd
28026 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28027 The connection is always dropped after sending a 550 response.
28028
28029 .next
28030 .cindex "&%require%& ACL verb"
28031 &%require%&: If all the conditions are met, control is passed to the next ACL
28032 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28033 example, when checking a RCPT command,
28034 .code
28035 require message = Sender did not verify
28036         verify  = sender
28037 .endd
28038 passes control to subsequent statements only if the message's sender can be
28039 verified. Otherwise, it rejects the command. Note the positioning of the
28040 &%message%& modifier, before the &%verify%& condition. The reason for this is
28041 discussed in section &<<SECTcondmodproc>>&.
28042
28043 .next
28044 .cindex "&%warn%& ACL verb"
28045 &%warn%&: If all the conditions are true, a line specified by the
28046 &%log_message%& modifier is written to Exim's main log. Control always passes
28047 to the next ACL statement. If any condition is false, the log line is not
28048 written. If an identical log line is requested several times in the same
28049 message, only one copy is actually written to the log. If you want to force
28050 duplicates to be written, use the &%logwrite%& modifier instead.
28051
28052 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28053 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28054 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28055 first failing condition. There is more about adding header lines in section
28056 &<<SECTaddheadacl>>&.
28057
28058 If any condition on a &%warn%& statement cannot be completed (that is, there is
28059 some sort of defer), the log line specified by &%log_message%& is not written.
28060 This does not include the case of a forced failure from a lookup, which
28061 is considered to be a successful completion. After a defer, no further
28062 conditions or modifiers in the &%warn%& statement are processed. The incident
28063 is logged, and the ACL continues to be processed, from the next statement
28064 onwards.
28065
28066
28067 .vindex "&$acl_verify_message$&"
28068 When one of the &%warn%& conditions is an address verification that fails, the
28069 text of the verification failure message is in &$acl_verify_message$&. If you
28070 want this logged, you must set it up explicitly. For example:
28071 .code
28072 warn   !verify = sender
28073        log_message = sender verify failed: $acl_verify_message
28074 .endd
28075 .endlist
28076
28077 At the end of each ACL there is an implicit unconditional &%deny%&.
28078
28079 As you can see from the examples above, the conditions and modifiers are
28080 written one to a line, with the first one on the same line as the verb, and
28081 subsequent ones on following lines. If you have a very long condition, you can
28082 continue it onto several physical lines by the usual backslash continuation
28083 mechanism. It is conventional to align the conditions vertically.
28084
28085
28086
28087 .section "ACL variables" "SECTaclvariables"
28088 .cindex "&ACL;" "variables"
28089 There are some special variables that can be set during ACL processing. They
28090 can be used to pass information between different ACLs, different invocations
28091 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28092 transports, and filters that are used to deliver a message. The names of these
28093 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28094 an underscore, but the remainder of the name can be any sequence of
28095 alphanumeric characters and underscores that you choose. There is no limit on
28096 the number of ACL variables. The two sets act as follows:
28097 .ilist
28098 The values of those variables whose names begin with &$acl_c$& persist
28099 throughout an SMTP connection. They are never reset. Thus, a value that is set
28100 while receiving one message is still available when receiving the next message
28101 on the same SMTP connection.
28102 .next
28103 The values of those variables whose names begin with &$acl_m$& persist only
28104 while a message is being received. They are reset afterwards. They are also
28105 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28106 .endlist
28107
28108 When a message is accepted, the current values of all the ACL variables are
28109 preserved with the message and are subsequently made available at delivery
28110 time. The ACL variables are set by a modifier called &%set%&. For example:
28111 .code
28112 accept hosts = whatever
28113        set acl_m4 = some value
28114 accept authenticated = *
28115        set acl_c_auth = yes
28116 .endd
28117 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28118 be set. If you want to set a variable without taking any action, you can use a
28119 &%warn%& verb without any other modifiers or conditions.
28120
28121 .oindex &%strict_acl_vars%&
28122 What happens if a syntactically valid but undefined ACL variable is
28123 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28124 false (the default), an empty string is substituted; if it is true, an
28125 error is generated.
28126
28127 Versions of Exim before 4.64 have a limited set of numbered variables, but
28128 their names are compatible, so there is no problem with upgrading.
28129
28130
28131 .section "Condition and modifier processing" "SECTcondmodproc"
28132 .cindex "&ACL;" "conditions; processing"
28133 .cindex "&ACL;" "modifiers; processing"
28134 An exclamation mark preceding a condition negates its result. For example:
28135 .code
28136 deny   domains = *.dom.example
28137       !verify  = recipient
28138 .endd
28139 causes the ACL to return &"deny"& if the recipient domain ends in
28140 &'dom.example'& and the recipient address cannot be verified. Sometimes
28141 negation can be used on the right-hand side of a condition. For example, these
28142 two statements are equivalent:
28143 .code
28144 deny  hosts = !192.168.3.4
28145 deny !hosts =  192.168.3.4
28146 .endd
28147 However, for many conditions (&%verify%& being a good example), only left-hand
28148 side negation of the whole condition is possible.
28149
28150 The arguments of conditions and modifiers are expanded. A forced failure
28151 of an expansion causes a condition to be ignored, that is, it behaves as if the
28152 condition is true. Consider these two statements:
28153 .code
28154 accept  senders = ${lookup{$host_name}lsearch\
28155                   {/some/file}{$value}fail}
28156 accept  senders = ${lookup{$host_name}lsearch\
28157                   {/some/file}{$value}{}}
28158 .endd
28159 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28160 the returned list is searched, but if the lookup fails the behaviour is
28161 different in the two cases. The &%fail%& in the first statement causes the
28162 condition to be ignored, leaving no further conditions. The &%accept%& verb
28163 therefore succeeds. The second statement, however, generates an empty list when
28164 the lookup fails. No sender can match an empty list, so the condition fails,
28165 and therefore the &%accept%& also fails.
28166
28167 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28168 specify actions that are taken as the conditions for a statement are checked;
28169 others specify text for messages that are used when access is denied or a
28170 warning is generated. The &%control%& modifier affects the way an incoming
28171 message is handled.
28172
28173 The positioning of the modifiers in an ACL statement is important, because the
28174 processing of a verb ceases as soon as its outcome is known. Only those
28175 modifiers that have already been encountered will take effect. For example,
28176 consider this use of the &%message%& modifier:
28177 .code
28178 require message = Can't verify sender
28179         verify  = sender
28180         message = Can't verify recipient
28181         verify  = recipient
28182         message = This message cannot be used
28183 .endd
28184 If sender verification fails, Exim knows that the result of the statement is
28185 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28186 so its text is used as the error message. If sender verification succeeds, but
28187 recipient verification fails, the second message is used. If recipient
28188 verification succeeds, the third message becomes &"current"&, but is never used
28189 because there are no more conditions to cause failure.
28190
28191 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28192 modifier that is used, because all the conditions must be true for rejection to
28193 happen. Specifying more than one &%message%& modifier does not make sense, and
28194 the message can even be specified after all the conditions. For example:
28195 .code
28196 deny   hosts = ...
28197       !senders = *@my.domain.example
28198        message = Invalid sender from client host
28199 .endd
28200 The &"deny"& result does not happen until the end of the statement is reached,
28201 by which time Exim has set up the message.
28202
28203
28204
28205 .section "ACL modifiers" "SECTACLmodi"
28206 .cindex "&ACL;" "modifiers; list of"
28207 The ACL modifiers are as follows:
28208
28209 .vlist
28210 .vitem &*add_header*&&~=&~<&'text'&>
28211 This modifier specifies one or more header lines that are to be added to an
28212 incoming message, assuming, of course, that the message is ultimately
28213 accepted. For details, see section &<<SECTaddheadacl>>&.
28214
28215 .vitem &*continue*&&~=&~<&'text'&>
28216 .cindex "&%continue%& ACL modifier"
28217 .cindex "database" "updating in ACL"
28218 This modifier does nothing of itself, and processing of the ACL always
28219 continues with the next condition or modifier. The value of &%continue%& is in
28220 the side effects of expanding its argument. Typically this could be used to
28221 update a database. It is really just a syntactic tidiness, to avoid having to
28222 write rather ugly lines like this:
28223 .display
28224 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28225 .endd
28226 Instead, all you need is
28227 .display
28228 &`continue = `&<&'some expansion'&>
28229 .endd
28230
28231 .vitem &*control*&&~=&~<&'text'&>
28232 .cindex "&%control%& ACL modifier"
28233 This modifier affects the subsequent processing of the SMTP connection or of an
28234 incoming message that is accepted. The effect of the first type of control
28235 lasts for the duration of the connection, whereas the effect of the second type
28236 lasts only until the current message has been received. The message-specific
28237 controls always apply to the whole message, not to individual recipients,
28238 even if the &%control%& modifier appears in a RCPT ACL.
28239
28240 As there are now quite a few controls that can be applied, they are described
28241 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28242 in several different ways. For example:
28243
28244 . ==== As this is a nested list, any displays it contains must be indented
28245 . ==== as otherwise they are too far to the left. That comment applies only
28246 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28247 . ==== way.
28248
28249 .ilist
28250 It can be at the end of an &%accept%& statement:
28251 .code
28252     accept  ...some conditions
28253             control = queue_only
28254 .endd
28255 In this case, the control is applied when this statement yields &"accept"&, in
28256 other words, when the conditions are all true.
28257
28258 .next
28259 It can be in the middle of an &%accept%& statement:
28260 .code
28261     accept  ...some conditions...
28262             control = queue_only
28263             ...some more conditions...
28264 .endd
28265 If the first set of conditions are true, the control is applied, even if the
28266 statement does not accept because one of the second set of conditions is false.
28267 In this case, some subsequent statement must yield &"accept"& for the control
28268 to be relevant.
28269
28270 .next
28271 It can be used with &%warn%& to apply the control, leaving the
28272 decision about accepting or denying to a subsequent verb. For
28273 example:
28274 .code
28275     warn    ...some conditions...
28276             control = freeze
28277     accept  ...
28278 .endd
28279 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28280 &%logwrite%&, so it does not add anything to the message and does not write a
28281 log entry.
28282
28283 .next
28284 If you want to apply a control unconditionally, you can use it with a
28285 &%require%& verb. For example:
28286 .code
28287     require  control = no_multiline_responses
28288 .endd
28289 .endlist
28290
28291 .vitem &*delay*&&~=&~<&'time'&>
28292 .cindex "&%delay%& ACL modifier"
28293 .oindex "&%-bh%&"
28294 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28295 the time interval before proceeding. However, when testing Exim using the
28296 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28297 output instead). The time is given in the usual Exim notation, and the delay
28298 happens as soon as the modifier is processed. In an SMTP session, pending
28299 output is flushed before the delay is imposed.
28300
28301 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28302 example:
28303 .code
28304 deny    ...some conditions...
28305         delay = 30s
28306 .endd
28307 The delay happens if all the conditions are true, before the statement returns
28308 &"deny"&. Compare this with:
28309 .code
28310 deny    delay = 30s
28311         ...some conditions...
28312 .endd
28313 which waits for 30s before processing the conditions. The &%delay%& modifier
28314 can also be used with &%warn%& and together with &%control%&:
28315 .code
28316 warn    ...some conditions...
28317         delay = 2m
28318         control = freeze
28319 accept  ...
28320 .endd
28321
28322 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28323 responses to several commands are no longer buffered and sent in one packet (as
28324 they would normally be) because all output is flushed before imposing the
28325 delay. This optimization is disabled so that a number of small delays do not
28326 appear to the client as one large aggregated delay that might provoke an
28327 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28328 using a &%control%& modifier to set &%no_delay_flush%&.
28329
28330
28331 .vitem &*endpass*&
28332 .cindex "&%endpass%& ACL modifier"
28333 This modifier, which has no argument, is recognized only in &%accept%& and
28334 &%discard%& statements. It marks the boundary between the conditions whose
28335 failure causes control to pass to the next statement, and the conditions whose
28336 failure causes the ACL to return &"deny"&. This concept has proved to be
28337 confusing to some people, so the use of &%endpass%& is no longer recommended as
28338 &"best practice"&. See the description of &%accept%& above for more details.
28339
28340
28341 .vitem &*log_message*&&~=&~<&'text'&>
28342 .cindex "&%log_message%& ACL modifier"
28343 This modifier sets up a message that is used as part of the log message if the
28344 ACL denies access or a &%warn%& statement's conditions are true. For example:
28345 .code
28346 require log_message = wrong cipher suite $tls_in_cipher
28347         encrypted   = DES-CBC3-SHA
28348 .endd
28349 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28350 example:
28351 .display
28352 &`discard `&<&'some conditions'&>
28353 &`        log_message = Discarded $local_part@$domain because...`&
28354 .endd
28355 When access is denied, &%log_message%& adds to any underlying error message
28356 that may exist because of a condition failure. For example, while verifying a
28357 recipient address, a &':fail:'& redirection might have already set up a
28358 message.
28359
28360 The message may be defined before the conditions to which it applies, because
28361 the string expansion does not happen until Exim decides that access is to be
28362 denied. This means that any variables that are set by the condition are
28363 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28364 variables are set after a DNS black list lookup succeeds. If the expansion of
28365 &%log_message%& fails, or if the result is an empty string, the modifier is
28366 ignored.
28367
28368 .vindex "&$acl_verify_message$&"
28369 If you want to use a &%warn%& statement to log the result of an address
28370 verification, you can use &$acl_verify_message$& to include the verification
28371 error message.
28372
28373 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28374 the start of the logged message. If the same warning log message is requested
28375 more than once while receiving  a single email message, only one copy is
28376 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28377 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28378 is logged for a successful &%warn%& statement.
28379
28380 If &%log_message%& is not present and there is no underlying error message (for
28381 example, from the failure of address verification), but &%message%& is present,
28382 the &%message%& text is used for logging rejections. However, if any text for
28383 logging contains newlines, only the first line is logged. In the absence of
28384 both &%log_message%& and &%message%&, a default built-in message is used for
28385 logging rejections.
28386
28387
28388 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28389 .cindex "&%log_reject_target%& ACL modifier"
28390 .cindex "logging in ACL" "specifying which log"
28391 This modifier makes it possible to specify which logs are used for messages
28392 about ACL rejections. Its argument is a colon-separated list of words that can
28393 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28394 may be empty, in which case a rejection is not logged at all. For example, this
28395 ACL fragment writes no logging information when access is denied:
28396 .display
28397 &`deny `&<&'some conditions'&>
28398 &`     log_reject_target =`&
28399 .endd
28400 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28401 permanent and temporary rejections. Its effect lasts for the rest of the
28402 current ACL.
28403
28404
28405 .vitem &*logwrite*&&~=&~<&'text'&>
28406 .cindex "&%logwrite%& ACL modifier"
28407 .cindex "logging in ACL" "immediate"
28408 This modifier writes a message to a log file as soon as it is encountered when
28409 processing an ACL. (Compare &%log_message%&, which, except in the case of
28410 &%warn%& and &%discard%&, is used only if the ACL statement denies
28411 access.) The &%logwrite%& modifier can be used to log special incidents in
28412 ACLs. For example:
28413 .display
28414 &`accept `&<&'some special conditions'&>
28415 &`       control  = freeze`&
28416 &`       logwrite = froze message because ...`&
28417 .endd
28418 By default, the message is written to the main log. However, it may begin
28419 with a colon, followed by a comma-separated list of log names, and then
28420 another colon, to specify exactly which logs are to be written. For
28421 example:
28422 .code
28423 logwrite = :main,reject: text for main and reject logs
28424 logwrite = :panic: text for panic log only
28425 .endd
28426
28427
28428 .vitem &*message*&&~=&~<&'text'&>
28429 .cindex "&%message%& ACL modifier"
28430 This modifier sets up a text string that is expanded and used as a response
28431 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28432 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28433 there is some complication if &%endpass%& is involved; see the description of
28434 &%accept%& for details.)
28435
28436 The expansion of the message happens at the time Exim decides that the ACL is
28437 to end, not at the time it processes &%message%&. If the expansion fails, or
28438 generates an empty string, the modifier is ignored. Here is an example where
28439 &%message%& must be specified first, because the ACL ends with a rejection if
28440 the &%hosts%& condition fails:
28441 .code
28442 require  message = Host not recognized
28443          hosts = 10.0.0.0/8
28444 .endd
28445 (Once a condition has failed, no further conditions or modifiers are
28446 processed.)
28447
28448 .cindex "SMTP" "error codes"
28449 .oindex "&%smtp_banner%&
28450 For ACLs that are triggered by SMTP commands, the message is returned as part
28451 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28452 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28453 is accepted. In the case of the connect ACL, accepting with a message modifier
28454 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28455 accept message may not contain more than one line (otherwise it will be
28456 truncated at the first newline and a panic logged), and it cannot affect the
28457 EHLO options.
28458
28459 When SMTP is involved, the message may begin with an overriding response code,
28460 consisting of three digits optionally followed by an &"extended response code"&
28461 of the form &'n.n.n'&, each code being followed by a space. For example:
28462 .code
28463 deny  message = 599 1.2.3 Host not welcome
28464       hosts = 192.168.34.0/24
28465 .endd
28466 The first digit of the supplied response code must be the same as would be sent
28467 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28468 access, but for the predata ACL, note that the default success code is 354, not
28469 2&'xx'&.
28470
28471 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28472 the message modifier cannot override the 221 response code.
28473
28474 The text in a &%message%& modifier is literal; any quotes are taken as
28475 literals, but because the string is expanded, backslash escapes are processed
28476 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28477 response.
28478
28479 .vindex "&$acl_verify_message$&"
28480 For ACLs that are called by an &%acl =%& ACL condition, the message is
28481 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28482
28483 If &%message%& is used on a statement that verifies an address, the message
28484 specified overrides any message that is generated by the verification process.
28485 However, the original message is available in the variable
28486 &$acl_verify_message$&, so you can incorporate it into your message if you
28487 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28488 routers to be passed back as part of the SMTP response, you should either not
28489 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28490
28491 For compatibility with previous releases of Exim, a &%message%& modifier that
28492 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28493 modifier, but this usage is now deprecated. However, &%message%& acts only when
28494 all the conditions are true, wherever it appears in an ACL command, whereas
28495 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28496 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28497 effect.
28498
28499
28500 .vitem &*remove_header*&&~=&~<&'text'&>
28501 This modifier specifies one or more header names in a colon-separated list
28502  that are to be removed from an incoming message, assuming, of course, that
28503 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28504
28505
28506 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28507 .cindex "&%set%& ACL modifier"
28508 This modifier puts a value into one of the ACL variables (see section
28509 &<<SECTaclvariables>>&).
28510
28511
28512 .vitem &*udpsend*&&~=&~<&'parameters'&>
28513 This modifier sends a UDP packet, for purposes such as statistics
28514 collection or behaviour monitoring. The parameters are expanded, and
28515 the result of the expansion must be a colon-separated list consisting
28516 of a destination server, port number, and the packet contents. The
28517 server can be specified as a host name or IPv4 or IPv6 address. The
28518 separator can be changed with the usual angle bracket syntax. For
28519 example, you might want to collect information on which hosts connect
28520 when:
28521 .code
28522 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28523              $tod_zulu $sender_host_address
28524 .endd
28525 .endlist
28526
28527
28528
28529
28530 .section "Use of the control modifier" "SECTcontrols"
28531 .cindex "&%control%& ACL modifier"
28532 The &%control%& modifier supports the following settings:
28533
28534 .vlist
28535 .vitem &*control&~=&~allow_auth_unadvertised*&
28536 This modifier allows a client host to use the SMTP AUTH command even when it
28537 has not been advertised in response to EHLO. Furthermore, because there are
28538 apparently some really broken clients that do this, Exim will accept AUTH after
28539 HELO (rather than EHLO) when this control is set. It should be used only if you
28540 really need it, and you should limit its use to those broken clients that do
28541 not work without it. For example:
28542 .code
28543 warn hosts   = 192.168.34.25
28544      control = allow_auth_unadvertised
28545 .endd
28546 Normally, when an Exim server receives an AUTH command, it checks the name of
28547 the authentication mechanism that is given in the command to ensure that it
28548 matches an advertised mechanism. When this control is set, the check that a
28549 mechanism has been advertised is bypassed. Any configured mechanism can be used
28550 by the client. This control is permitted only in the connection and HELO ACLs.
28551
28552
28553 .vitem &*control&~=&~caseful_local_part*& &&&
28554        &*control&~=&~caselower_local_part*&
28555 .cindex "&ACL;" "case of local part in"
28556 .cindex "case of local parts"
28557 .vindex "&$local_part$&"
28558 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28559 (that is, during RCPT processing). By default, the contents of &$local_part$&
28560 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28561 any uppercase letters in the original local part are restored in &$local_part$&
28562 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28563 is encountered.
28564
28565 These controls affect only the current recipient. Moreover, they apply only to
28566 local part handling that takes place directly in the ACL (for example, as a key
28567 in lookups). If a test to verify the recipient is obeyed, the case-related
28568 handling of the local part during the verification is controlled by the router
28569 configuration (see the &%caseful_local_part%& generic router option).
28570
28571 This facility could be used, for example, to add a spam score to local parts
28572 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28573 spam score:
28574 .code
28575 warn  control = caseful_local_part
28576       set acl_m4 = ${eval:\
28577                      $acl_m4 + \
28578                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28579                     }
28580       control = caselower_local_part
28581 .endd
28582 Notice that we put back the lower cased version afterwards, assuming that
28583 is what is wanted for subsequent tests.
28584
28585
28586 .vitem &*control&~=&~cutthrough_delivery*&
28587 .cindex "&ACL;" "cutthrough routing"
28588 .cindex "cutthrough" "requesting"
28589 This option requests delivery be attempted while the item is being received.
28590
28591 The option is usable in the RCPT ACL.
28592 If enabled for a message received via smtp and routed to an smtp transport,
28593 and only one transport, interface, destination host and port combination
28594 is used for all recipients of the message,
28595 then the delivery connection is made while the receiving connection is open
28596 and data is copied from one to the other.
28597
28598 An attempt to set this option for any recipient but the first
28599 for a mail will be quietly ignored.
28600 If a recipient-verify callout connection is subsequently
28601 requested in the same ACL it is held open and used for
28602 any subsequent recipients and the data,
28603 otherwise one is made after the initial RCPT ACL completes.
28604
28605 Note that routers are used in verify mode,
28606 and cannot depend on content of received headers.
28607 Note also that headers cannot be
28608 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28609 Headers may be modified by routers (subject to the above) and transports.
28610
28611 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28612 of outgoing messages is done, because it sends data to the ultimate destination
28613 before the entire message has been received from the source.
28614 It is not supported for messages received with the SMTP PRDR option in use.
28615
28616 Should the ultimate destination system positively accept or reject the mail,
28617 a corresponding indication is given to the source system and nothing is queued.
28618 If there is a temporary error the item is queued for later delivery in the
28619 usual fashion. If the item is successfully delivered in cutthrough mode
28620 the delivery log lines are tagged with ">>" rather than "=>" and appear
28621 before the acceptance "<=" line.
28622
28623 Delivery in this mode avoids the generation of a bounce mail to a
28624 (possibly faked)
28625 sender when the destination system is doing content-scan based rejection.
28626
28627
28628 .vitem &*control&~=&~debug/*&<&'options'&>
28629 .cindex "&ACL;" "enabling debug logging"
28630 .cindex "debugging" "enabling from an ACL"
28631 This control turns on debug logging, almost as though Exim had been invoked
28632 with &`-d`&, with the output going to a new logfile, by default called
28633 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28634 may access any variables already defined.  The logging may be adjusted with
28635 the &'opts'& option, which takes the same values as the &`-d`& command-line
28636 option.  Some examples (which depend on variables that don't exist in all
28637 contexts):
28638 .code
28639       control = debug
28640       control = debug/tag=.$sender_host_address
28641       control = debug/opts=+expand+acl
28642       control = debug/tag=.$message_exim_id/opts=+expand
28643 .endd
28644
28645
28646 .vitem &*control&~=&~dkim_disable_verify*&
28647 .cindex "disable DKIM verify"
28648 .cindex "DKIM" "disable verify"
28649 This control turns off DKIM verification processing entirely.  For details on
28650 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28651
28652
28653 .vitem &*control&~=&~dscp/*&<&'value'&>
28654 .cindex "&ACL;" "setting DSCP value"
28655 .cindex "DSCP" "inbound"
28656 This option causes the DSCP value associated with the socket for the inbound
28657 connection to be adjusted to a given value, given as one of a number of fixed
28658 strings or to numeric value.
28659 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28660 Common values include &`throughput`&, &`mincost`&, and on newer systems
28661 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28662
28663 The outbound packets from Exim will be marked with this value in the header
28664 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28665 that these values will have any effect, not be stripped by networking
28666 equipment, or do much of anything without cooperation with your Network
28667 Engineer and those of all network operators between the source and destination.
28668
28669
28670 .vitem &*control&~=&~enforce_sync*& &&&
28671        &*control&~=&~no_enforce_sync*&
28672 .cindex "SMTP" "synchronization checking"
28673 .cindex "synchronization checking in SMTP"
28674 These controls make it possible to be selective about when SMTP synchronization
28675 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28676 state of the switch (it is true by default). See the description of this option
28677 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28678
28679 The effect of these two controls lasts for the remainder of the SMTP
28680 connection. They can appear in any ACL except the one for the non-SMTP
28681 messages. The most straightforward place to put them is in the ACL defined by
28682 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28683 before the first synchronization check. The expected use is to turn off the
28684 synchronization checks for badly-behaved hosts that you nevertheless need to
28685 work with.
28686
28687
28688 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28689 .cindex "fake defer"
28690 .cindex "defer, fake"
28691 This control works in exactly the same way as &%fakereject%& (described below)
28692 except that it causes an SMTP 450 response after the message data instead of a
28693 550 response. You must take care when using &%fakedefer%& because it causes the
28694 messages to be duplicated when the sender retries. Therefore, you should not
28695 use &%fakedefer%& if the message is to be delivered normally.
28696
28697 .vitem &*control&~=&~fakereject/*&<&'message'&>
28698 .cindex "fake rejection"
28699 .cindex "rejection, fake"
28700 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28701 words, only when an SMTP message is being received. If Exim accepts the
28702 message, instead the final 250 response, a 550 rejection message is sent.
28703 However, Exim proceeds to deliver the message as normal. The control applies
28704 only to the current message, not to any subsequent ones that may be received in
28705 the same SMTP connection.
28706
28707 The text for the 550 response is taken from the &%control%& modifier. If no
28708 message is supplied, the following is used:
28709 .code
28710 550-Your message has been rejected but is being
28711 550-kept for evaluation.
28712 550-If it was a legitimate message, it may still be
28713 550 delivered to the target recipient(s).
28714 .endd
28715 This facility should be used with extreme caution.
28716
28717 .vitem &*control&~=&~freeze*&
28718 .cindex "frozen messages" "forcing in ACL"
28719 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28720 other words, only when a message is being received. If the message is accepted,
28721 it is placed on Exim's queue and frozen. The control applies only to the
28722 current message, not to any subsequent ones that may be received in the same
28723 SMTP connection.
28724
28725 This modifier can optionally be followed by &`/no_tell`&. If the global option
28726 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28727 is told about the freezing), provided all the &*control=freeze*& modifiers that
28728 are obeyed for the current message have the &`/no_tell`& option.
28729
28730 .vitem &*control&~=&~no_delay_flush*&
28731 .cindex "SMTP" "output flushing, disabling for delay"
28732 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28733 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28734 use. This control, as long as it is encountered before the &%delay%& modifier,
28735 disables such output flushing.
28736
28737 .vitem &*control&~=&~no_callout_flush*&
28738 .cindex "SMTP" "output flushing, disabling for callout"
28739 Exim normally flushes SMTP output before performing a callout in an ACL, to
28740 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28741 use. This control, as long as it is encountered before the &%verify%& condition
28742 that causes the callout, disables such output flushing.
28743
28744 .vitem &*control&~=&~no_mbox_unspool*&
28745 This control is available when Exim is compiled with the content scanning
28746 extension. Content scanning may require a copy of the current message, or parts
28747 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28748 or spam scanner. Normally, such copies are deleted when they are no longer
28749 needed. If this control is set, the copies are not deleted. The control applies
28750 only to the current message, not to any subsequent ones that may be received in
28751 the same SMTP connection. It is provided for debugging purposes and is unlikely
28752 to be useful in production.
28753
28754 .vitem &*control&~=&~no_multiline_responses*&
28755 .cindex "multiline responses, suppressing"
28756 This control is permitted for any ACL except the one for non-SMTP messages.
28757 It seems that there are broken clients in use that cannot handle multiline
28758 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28759
28760 If this control is set, multiline SMTP responses from ACL rejections are
28761 suppressed. One way of doing this would have been to put out these responses as
28762 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28763 (&"use multiline responses for more"& it says &-- ha!), and some of the
28764 responses might get close to that. So this facility, which is after all only a
28765 sop to broken clients, is implemented by doing two very easy things:
28766
28767 .ilist
28768 Extra information that is normally output as part of a rejection caused by
28769 sender verification failure is omitted. Only the final line (typically &"sender
28770 verification failed"&) is sent.
28771 .next
28772 If a &%message%& modifier supplies a multiline response, only the first
28773 line is output.
28774 .endlist
28775
28776 The setting of the switch can, of course, be made conditional on the
28777 calling host. Its effect lasts until the end of the SMTP connection.
28778
28779 .vitem &*control&~=&~no_pipelining*&
28780 .cindex "PIPELINING" "suppressing advertising"
28781 This control turns off the advertising of the PIPELINING extension to SMTP in
28782 the current session. To be useful, it must be obeyed before Exim sends its
28783 response to an EHLO command. Therefore, it should normally appear in an ACL
28784 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28785 &%pipelining_advertise_hosts%&.
28786
28787 .vitem &*control&~=&~queue_only*&
28788 .oindex "&%queue_only%&"
28789 .cindex "queueing incoming messages"
28790 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28791 other words, only when a message is being received. If the message is accepted,
28792 it is placed on Exim's queue and left there for delivery by a subsequent queue
28793 runner. No immediate delivery process is started. In other words, it has the
28794 effect as the &%queue_only%& global option. However, the control applies only
28795 to the current message, not to any subsequent ones that may be received in the
28796 same SMTP connection.
28797
28798 .vitem &*control&~=&~submission/*&<&'options'&>
28799 .cindex "message" "submission"
28800 .cindex "submission mode"
28801 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28802 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28803 the current message is a submission from a local MUA. In this case, Exim
28804 operates in &"submission mode"&, and applies certain fixups to the message if
28805 necessary. For example, it adds a &'Date:'& header line if one is not present.
28806 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28807 late (the message has already been created).
28808
28809 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28810 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28811 submission mode; the available options for this control are described there.
28812 The control applies only to the current message, not to any subsequent ones
28813 that may be received in the same SMTP connection.
28814
28815 .vitem &*control&~=&~suppress_local_fixups*&
28816 .cindex "submission fixups, suppressing"
28817 This control applies to locally submitted (non TCP/IP) messages, and is the
28818 complement of &`control = submission`&. It disables the fixups that are
28819 normally applied to locally-submitted messages. Specifically:
28820
28821 .ilist
28822 Any &'Sender:'& header line is left alone (in this respect, it is a
28823 dynamic version of &%local_sender_retain%&).
28824 .next
28825 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28826 .next
28827 There is no check that &'From:'& corresponds to the actual sender.
28828 .endlist ilist
28829
28830 This control may be useful when a remotely-originated message is accepted,
28831 passed to some scanning program, and then re-submitted for delivery. It can be
28832 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28833 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28834 data is read.
28835
28836 &*Note:*& This control applies only to the current message, not to any others
28837 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28838
28839 .new
28840 .vitem &*control&~=&~utf8_downconvert*&
28841 This control enables conversion of UTF-8 in message addresses
28842 to a-label form.
28843 For details see &<<SECTi18nMTA>>&.
28844 .wen
28845 .endlist vlist
28846
28847
28848 .section "Summary of message fixup control" "SECTsummesfix"
28849 All four possibilities for message fixups can be specified:
28850
28851 .ilist
28852 Locally submitted, fixups applied: the default.
28853 .next
28854 Locally submitted, no fixups applied: use
28855 &`control = suppress_local_fixups`&.
28856 .next
28857 Remotely submitted, no fixups applied: the default.
28858 .next
28859 Remotely submitted, fixups applied: use &`control = submission`&.
28860 .endlist
28861
28862
28863
28864 .section "Adding header lines in ACLs" "SECTaddheadacl"
28865 .cindex "header lines" "adding in an ACL"
28866 .cindex "header lines" "position of added lines"
28867 .cindex "&%add_header%& ACL modifier"
28868 The &%add_header%& modifier can be used to add one or more extra header lines
28869 to an incoming message, as in this example:
28870 .code
28871 warn dnslists = sbl.spamhaus.org : \
28872                 dialup.mail-abuse.org
28873      add_header = X-blacklisted-at: $dnslist_domain
28874 .endd
28875 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28876 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28877 receiving a message). The message must ultimately be accepted for
28878 &%add_header%& to have any significant effect. You can use &%add_header%& with
28879 any ACL verb, including &%deny%& (though this is potentially useful only in a
28880 RCPT ACL).
28881
28882 Headers will not be added to the message if the modifier is used in
28883 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28884
28885 Leading and trailing newlines are removed from
28886 the data for the &%add_header%& modifier; if it then
28887 contains one or more newlines that
28888 are not followed by a space or a tab, it is assumed to contain multiple header
28889 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28890 front of any line that is not a valid header line.
28891
28892 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28893 They are added to the message before processing the DATA and MIME ACLs.
28894 However, if an identical header line is requested more than once, only one copy
28895 is actually added to the message. Further header lines may be accumulated
28896 during the DATA and MIME ACLs, after which they are added to the message, again
28897 with duplicates suppressed. Thus, it is possible to add two identical header
28898 lines to an SMTP message, but only if one is added before DATA and one after.
28899 In the case of non-SMTP messages, new headers are accumulated during the
28900 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28901 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28902 are included in the entry that is written to the reject log.
28903
28904 .cindex "header lines" "added; visibility of"
28905 Header lines are not visible in string expansions
28906 of message headers
28907 until they are added to the
28908 message. It follows that header lines defined in the MAIL, RCPT, and predata
28909 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28910 header lines that are added by the DATA or MIME ACLs are not visible in those
28911 ACLs. Because of this restriction, you cannot use header lines as a way of
28912 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28913 this, you can use ACL variables, as described in section
28914 &<<SECTaclvariables>>&.
28915
28916 The list of headers yet to be added is given by the &%$headers_added%& variable.
28917
28918 The &%add_header%& modifier acts immediately as it is encountered during the
28919 processing of an ACL. Notice the difference between these two cases:
28920 .display
28921 &`accept add_header = ADDED: some text`&
28922 &`       `&<&'some condition'&>
28923
28924 &`accept `&<&'some condition'&>
28925 &`       add_header = ADDED: some text`&
28926 .endd
28927 In the first case, the header line is always added, whether or not the
28928 condition is true. In the second case, the header line is added only if the
28929 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28930 ACL statement. All those that are encountered before a condition fails are
28931 honoured.
28932
28933 .cindex "&%warn%& ACL verb"
28934 For compatibility with previous versions of Exim, a &%message%& modifier for a
28935 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28936 effect only if all the conditions are true, even if it appears before some of
28937 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28938 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28939 are present on a &%warn%& verb, both are processed according to their
28940 specifications.
28941
28942 By default, new header lines are added to a message at the end of the existing
28943 header lines. However, you can specify that any particular header line should
28944 be added right at the start (before all the &'Received:'& lines), immediately
28945 after the first block of &'Received:'& lines, or immediately before any line
28946 that is not a &'Received:'& or &'Resent-something:'& header.
28947
28948 This is done by specifying &":at_start:"&, &":after_received:"&, or
28949 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28950 header line, respectively. (Header text cannot start with a colon, as there has
28951 to be a header name first.) For example:
28952 .code
28953 warn add_header = \
28954        :after_received:X-My-Header: something or other...
28955 .endd
28956 If more than one header line is supplied in a single &%add_header%& modifier,
28957 each one is treated independently and can therefore be placed differently. If
28958 you add more than one line at the start, or after the Received: block, they end
28959 up in reverse order.
28960
28961 &*Warning*&: This facility currently applies only to header lines that are
28962 added in an ACL. It does NOT work for header lines that are added in a
28963 system filter or in a router or transport.
28964
28965
28966
28967 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28968 .cindex "header lines" "removing in an ACL"
28969 .cindex "header lines" "position of removed lines"
28970 .cindex "&%remove_header%& ACL modifier"
28971 The &%remove_header%& modifier can be used to remove one or more header lines
28972 from an incoming message, as in this example:
28973 .code
28974 warn   message        = Remove internal headers
28975        remove_header  = x-route-mail1 : x-route-mail2
28976 .endd
28977 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28978 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28979 receiving a message). The message must ultimately be accepted for
28980 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28981 with any ACL verb, including &%deny%&, though this is really not useful for
28982 any verb that doesn't result in a delivered message.
28983
28984 Headers will not be removed to the message if the modifier is used in
28985 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28986
28987 More than one header can be removed at the same time by using a colon separated
28988 list of header names. The header matching is case insensitive. Wildcards are
28989 not permitted, nor is list expansion performed, so you cannot use hostlists to
28990 create a list of headers, however both connection and message variable expansion
28991 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28992 .code
28993 warn   hosts           = +internal_hosts
28994        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28995 warn   message         = Remove internal headers
28996        remove_header   = $acl_c_ihdrs
28997 .endd
28998 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28999 They are removed from the message before processing the DATA and MIME ACLs.
29000 There is no harm in attempting to remove the same header twice nor is removing
29001 a non-existent header. Further header lines to be removed may be accumulated
29002 during the DATA and MIME ACLs, after which they are removed from the message,
29003 if present. In the case of non-SMTP messages, headers to be removed are
29004 accumulated during the non-SMTP ACLs, and are removed from the message after
29005 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29006 ACL, there really is no effect because there is no logging of what headers
29007 would have been removed.
29008
29009 .cindex "header lines" "removed; visibility of"
29010 Header lines are not visible in string expansions until the DATA phase when it
29011 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29012 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29013 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29014 this restriction, you cannot use header lines as a way of controlling data
29015 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29016 you should instead use ACL variables, as described in section
29017 &<<SECTaclvariables>>&.
29018
29019 The &%remove_header%& modifier acts immediately as it is encountered during the
29020 processing of an ACL. Notice the difference between these two cases:
29021 .display
29022 &`accept remove_header = X-Internal`&
29023 &`       `&<&'some condition'&>
29024
29025 &`accept `&<&'some condition'&>
29026 &`       remove_header = X-Internal`&
29027 .endd
29028 In the first case, the header line is always removed, whether or not the
29029 condition is true. In the second case, the header line is removed only if the
29030 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29031 same ACL statement. All those that are encountered before a condition fails
29032 are honoured.
29033
29034 &*Warning*&: This facility currently applies only to header lines that are
29035 present during ACL processing. It does NOT remove header lines that are added
29036 in a system filter or in a router or transport.
29037
29038
29039
29040
29041 .section "ACL conditions" "SECTaclconditions"
29042 .cindex "&ACL;" "conditions; list of"
29043 Some of the conditions listed in this section are available only when Exim is
29044 compiled with the content-scanning extension. They are included here briefly
29045 for completeness. More detailed descriptions can be found in the discussion on
29046 content scanning in chapter &<<CHAPexiscan>>&.
29047
29048 Not all conditions are relevant in all circumstances. For example, testing
29049 senders and recipients does not make sense in an ACL that is being run as the
29050 result of the arrival of an ETRN command, and checks on message headers can be
29051 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29052 can use the same condition (with different parameters) more than once in the
29053 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29054 The conditions are as follows:
29055
29056
29057 .vlist
29058 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29059 .cindex "&ACL;" "nested"
29060 .cindex "&ACL;" "indirect"
29061 .cindex "&ACL;" "arguments"
29062 .cindex "&%acl%& ACL condition"
29063 The possible values of the argument are the same as for the
29064 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29065 &"accept"& the condition is true; if it returns &"deny"& the condition is
29066 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29067 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29068 condition false. This means that further processing of the &%warn%& verb
29069 ceases, but processing of the ACL continues.
29070
29071 If the argument is a named ACL, up to nine space-separated optional values
29072 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29073 and $acl_narg is set to the count of values.
29074 Previous values of these variables are restored after the call returns.
29075 The name and values are expanded separately.
29076 Note that spaces in complex expansions which are used as arguments
29077 will act as argument separators.
29078
29079 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29080 the connection is dropped. If it returns &"discard"&, the verb must be
29081 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29082 conditions are tested.
29083
29084 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29085 loops. This condition allows you to use different ACLs in different
29086 circumstances. For example, different ACLs can be used to handle RCPT commands
29087 for different local users or different local domains.
29088
29089 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29090 .cindex "&%authenticated%& ACL condition"
29091 .cindex "authentication" "ACL checking"
29092 .cindex "&ACL;" "testing for authentication"
29093 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29094 the name of the authenticator is tested against the list. To test for
29095 authentication by any authenticator, you can set
29096 .code
29097 authenticated = *
29098 .endd
29099
29100 .vitem &*condition&~=&~*&<&'string'&>
29101 .cindex "&%condition%& ACL condition"
29102 .cindex "customizing" "ACL condition"
29103 .cindex "&ACL;" "customized test"
29104 .cindex "&ACL;" "testing, customized"
29105 This feature allows you to make up custom conditions. If the result of
29106 expanding the string is an empty string, the number zero, or one of the strings
29107 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29108 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29109 any other value, some error is assumed to have occurred, and the ACL returns
29110 &"defer"&. However, if the expansion is forced to fail, the condition is
29111 ignored. The effect is to treat it as true, whether it is positive or
29112 negative.
29113
29114 .vitem &*decode&~=&~*&<&'location'&>
29115 .cindex "&%decode%& ACL condition"
29116 This condition is available only when Exim is compiled with the
29117 content-scanning extension, and it is allowed only in the ACL defined by
29118 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29119 If all goes well, the condition is true. It is false only if there are
29120 problems such as a syntax error or a memory shortage. For more details, see
29121 chapter &<<CHAPexiscan>>&.
29122
29123 .vitem &*demime&~=&~*&<&'extension&~list'&>
29124 .cindex "&%demime%& ACL condition"
29125 This condition is available only when Exim is compiled with the
29126 content-scanning extension. Its use is described in section
29127 &<<SECTdemimecond>>&.
29128
29129 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29130 .cindex "&%dnslists%& ACL condition"
29131 .cindex "DNS list" "in ACL"
29132 .cindex "black list (DNS)"
29133 .cindex "&ACL;" "testing a DNS list"
29134 This condition checks for entries in DNS black lists. These are also known as
29135 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29136 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29137 different variants of this condition to describe briefly here. See sections
29138 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29139
29140 .vitem &*domains&~=&~*&<&'domain&~list'&>
29141 .cindex "&%domains%& ACL condition"
29142 .cindex "domain" "ACL checking"
29143 .cindex "&ACL;" "testing a recipient domain"
29144 .vindex "&$domain_data$&"
29145 This condition is relevant only after a RCPT command. It checks that the domain
29146 of the recipient address is in the domain list. If percent-hack processing is
29147 enabled, it is done before this test is done. If the check succeeds with a
29148 lookup, the result of the lookup is placed in &$domain_data$& until the next
29149 &%domains%& test.
29150
29151 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29152 use &%domains%& in a DATA ACL.
29153
29154
29155 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29156 .cindex "&%encrypted%& ACL condition"
29157 .cindex "encryption" "checking in an ACL"
29158 .cindex "&ACL;" "testing for encryption"
29159 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29160 name of the cipher suite in use is tested against the list. To test for
29161 encryption without testing for any specific cipher suite(s), set
29162 .code
29163 encrypted = *
29164 .endd
29165
29166
29167 .vitem &*hosts&~=&~*&<&'host&~list'&>
29168 .cindex "&%hosts%& ACL condition"
29169 .cindex "host" "ACL checking"
29170 .cindex "&ACL;" "testing the client host"
29171 This condition tests that the calling host matches the host list. If you have
29172 name lookups or wildcarded host names and IP addresses in the same host list,
29173 you should normally put the IP addresses first. For example, you could have:
29174 .code
29175 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29176 .endd
29177 The lookup in this example uses the host name for its key. This is implied by
29178 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29179 and it wouldn't matter which way round you had these two items.)
29180
29181 The reason for the problem with host names lies in the left-to-right way that
29182 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29183 but when it reaches an item that requires a host name, it fails if it cannot
29184 find a host name to compare with the pattern. If the above list is given in the
29185 opposite order, the &%accept%& statement fails for a host whose name cannot be
29186 found, even if its IP address is 10.9.8.7.
29187
29188 If you really do want to do the name check first, and still recognize the IP
29189 address even if the name lookup fails, you can rewrite the ACL like this:
29190 .code
29191 accept hosts = dbm;/etc/friendly/hosts
29192 accept hosts = 10.9.8.7
29193 .endd
29194 The default action on failing to find the host name is to assume that the host
29195 is not in the list, so the first &%accept%& statement fails. The second
29196 statement can then check the IP address.
29197
29198 .vindex "&$host_data$&"
29199 If a &%hosts%& condition is satisfied by means of a lookup, the result
29200 of the lookup is made available in the &$host_data$& variable. This
29201 allows you, for example, to set up a statement like this:
29202 .code
29203 deny  hosts = net-lsearch;/some/file
29204 message = $host_data
29205 .endd
29206 which gives a custom error message for each denied host.
29207
29208 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29209 .cindex "&%local_parts%& ACL condition"
29210 .cindex "local part" "ACL checking"
29211 .cindex "&ACL;" "testing a local part"
29212 .vindex "&$local_part_data$&"
29213 This condition is relevant only after a RCPT command. It checks that the local
29214 part of the recipient address is in the list. If percent-hack processing is
29215 enabled, it is done before this test. If the check succeeds with a lookup, the
29216 result of the lookup is placed in &$local_part_data$&, which remains set until
29217 the next &%local_parts%& test.
29218
29219 .vitem &*malware&~=&~*&<&'option'&>
29220 .cindex "&%malware%& ACL condition"
29221 .cindex "&ACL;" "virus scanning"
29222 .cindex "&ACL;" "scanning for viruses"
29223 This condition is available only when Exim is compiled with the
29224 content-scanning extension. It causes the incoming message to be scanned for
29225 viruses. For details, see chapter &<<CHAPexiscan>>&.
29226
29227 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29228 .cindex "&%mime_regex%& ACL condition"
29229 .cindex "&ACL;" "testing by regex matching"
29230 This condition is available only when Exim is compiled with the
29231 content-scanning extension, and it is allowed only in the ACL defined by
29232 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29233 with any of the regular expressions. For details, see chapter
29234 &<<CHAPexiscan>>&.
29235
29236 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29237 .cindex "rate limiting"
29238 This condition can be used to limit the rate at which a user or host submits
29239 messages. Details are given in section &<<SECTratelimiting>>&.
29240
29241 .vitem &*recipients&~=&~*&<&'address&~list'&>
29242 .cindex "&%recipients%& ACL condition"
29243 .cindex "recipient" "ACL checking"
29244 .cindex "&ACL;" "testing a recipient"
29245 This condition is relevant only after a RCPT command. It checks the entire
29246 recipient address against a list of recipients.
29247
29248 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29249 .cindex "&%regex%& ACL condition"
29250 .cindex "&ACL;" "testing by regex matching"
29251 This condition is available only when Exim is compiled with the
29252 content-scanning extension, and is available only in the DATA, MIME, and
29253 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29254 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29255
29256 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29257 .cindex "&%sender_domains%& ACL condition"
29258 .cindex "sender" "ACL checking"
29259 .cindex "&ACL;" "testing a sender domain"
29260 .vindex "&$domain$&"
29261 .vindex "&$sender_address_domain$&"
29262 This condition tests the domain of the sender of the message against the given
29263 domain list. &*Note*&: The domain of the sender address is in
29264 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29265 of this condition. This is an exception to the general rule for testing domain
29266 lists. It is done this way so that, if this condition is used in an ACL for a
29267 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29268 influence the sender checking.
29269
29270 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29271 relaying, because sender addresses are easily, and commonly, forged.
29272
29273 .vitem &*senders&~=&~*&<&'address&~list'&>
29274 .cindex "&%senders%& ACL condition"
29275 .cindex "sender" "ACL checking"
29276 .cindex "&ACL;" "testing a sender"
29277 This condition tests the sender of the message against the given list. To test
29278 for a bounce message, which has an empty sender, set
29279 .code
29280 senders = :
29281 .endd
29282 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29283 relaying, because sender addresses are easily, and commonly, forged.
29284
29285 .vitem &*spam&~=&~*&<&'username'&>
29286 .cindex "&%spam%& ACL condition"
29287 .cindex "&ACL;" "scanning for spam"
29288 This condition is available only when Exim is compiled with the
29289 content-scanning extension. It causes the incoming message to be scanned by
29290 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29291
29292 .vitem &*verify&~=&~certificate*&
29293 .cindex "&%verify%& ACL condition"
29294 .cindex "TLS" "client certificate verification"
29295 .cindex "certificate" "verification of client"
29296 .cindex "&ACL;" "certificate verification"
29297 .cindex "&ACL;" "testing a TLS certificate"
29298 This condition is true in an SMTP session if the session is encrypted, and a
29299 certificate was received from the client, and the certificate was verified. The
29300 server requests a certificate only if the client matches &%tls_verify_hosts%&
29301 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29302
29303 .vitem &*verify&~=&~csa*&
29304 .cindex "CSA verification"
29305 This condition checks whether the sending host (the client) is authorized to
29306 send email. Details of how this works are given in section
29307 &<<SECTverifyCSA>>&.
29308
29309 .vitem &*verify&~=&~header_names_ascii*&
29310 .cindex "&%verify%& ACL condition"
29311 .cindex "&ACL;" "verifying header names only ASCII"
29312 .cindex "header lines" "verifying header names only ASCII"
29313 .cindex "verifying" "header names only ASCII"
29314 This condition is relevant only in an ACL that is run after a message has been
29315 received, that is, in an ACL specified by &%acl_smtp_data%& or
29316 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29317 there are no non-ASCII characters, also excluding control characters.  The
29318 allowable characters are decimal ASCII values 33 through 126.
29319
29320 Exim itself will handle headers with non-ASCII characters, but it can cause
29321 problems for downstream applications, so this option will allow their
29322 detection and rejection in the DATA ACL's.
29323
29324 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29325 .cindex "&%verify%& ACL condition"
29326 .cindex "&ACL;" "verifying sender in the header"
29327 .cindex "header lines" "verifying the sender in"
29328 .cindex "sender" "verifying in header"
29329 .cindex "verifying" "sender in header"
29330 This condition is relevant only in an ACL that is run after a message has been
29331 received, that is, in an ACL specified by &%acl_smtp_data%& or
29332 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29333 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29334 is loosely thought of as a &"sender"& address (hence the name of the test).
29335 However, an address that appears in one of these headers need not be an address
29336 that accepts bounce messages; only sender addresses in envelopes are required
29337 to accept bounces. Therefore, if you use the callout option on this check, you
29338 might want to arrange for a non-empty address in the MAIL command.
29339
29340 Details of address verification and the options are given later, starting at
29341 section &<<SECTaddressverification>>& (callouts are described in section
29342 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29343 condition to restrict it to bounce messages only:
29344 .code
29345 deny    senders = :
29346         message = A valid sender header is required for bounces
29347        !verify  = header_sender
29348 .endd
29349
29350 .vitem &*verify&~=&~header_syntax*&
29351 .cindex "&%verify%& ACL condition"
29352 .cindex "&ACL;" "verifying header syntax"
29353 .cindex "header lines" "verifying syntax"
29354 .cindex "verifying" "header syntax"
29355 This condition is relevant only in an ACL that is run after a message has been
29356 received, that is, in an ACL specified by &%acl_smtp_data%& or
29357 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29358 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29359 and &'Bcc:'&), returning true if there are no problems.
29360 Unqualified addresses (local parts without domains) are
29361 permitted only in locally generated messages and from hosts that match
29362 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29363 appropriate.
29364
29365 Note that this condition is a syntax check only. However, a common spamming
29366 ploy used to be to send syntactically invalid headers such as
29367 .code
29368 To: @
29369 .endd
29370 and this condition can be used to reject such messages, though they are not as
29371 common as they used to be.
29372
29373 .vitem &*verify&~=&~helo*&
29374 .cindex "&%verify%& ACL condition"
29375 .cindex "&ACL;" "verifying HELO/EHLO"
29376 .cindex "HELO" "verifying"
29377 .cindex "EHLO" "verifying"
29378 .cindex "verifying" "EHLO"
29379 .cindex "verifying" "HELO"
29380 This condition is true if a HELO or EHLO command has been received from the
29381 client host, and its contents have been verified. If there has been no previous
29382 attempt to verify the HELO/EHLO contents, it is carried out when this
29383 condition is encountered. See the description of the &%helo_verify_hosts%& and
29384 &%helo_try_verify_hosts%& options for details of how to request verification
29385 independently of this condition.
29386
29387 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29388 option), this condition is always true.
29389
29390
29391 .vitem &*verify&~=&~not_blind*&
29392 .cindex "verifying" "not blind"
29393 .cindex "bcc recipients, verifying none"
29394 This condition checks that there are no blind (bcc) recipients in the message.
29395 Every envelope recipient must appear either in a &'To:'& header line or in a
29396 &'Cc:'& header line for this condition to be true. Local parts are checked
29397 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29398 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29399 used only in a DATA or non-SMTP ACL.
29400
29401 There are, of course, many legitimate messages that make use of blind (bcc)
29402 recipients. This check should not be used on its own for blocking messages.
29403
29404
29405 .vitem &*verify&~=&~recipient/*&<&'options'&>
29406 .cindex "&%verify%& ACL condition"
29407 .cindex "&ACL;" "verifying recipient"
29408 .cindex "recipient" "verifying"
29409 .cindex "verifying" "recipient"
29410 .vindex "&$address_data$&"
29411 This condition is relevant only after a RCPT command. It verifies the current
29412 recipient. Details of address verification are given later, starting at section
29413 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29414 of &$address_data$& is the last value that was set while routing the address.
29415 This applies even if the verification fails. When an address that is being
29416 verified is redirected to a single address, verification continues with the new
29417 address, and in that case, the subsequent value of &$address_data$& is the
29418 value for the child address.
29419
29420 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29421 .cindex "&%verify%& ACL condition"
29422 .cindex "&ACL;" "verifying host reverse lookup"
29423 .cindex "host" "verifying reverse lookup"
29424 This condition ensures that a verified host name has been looked up from the IP
29425 address of the client host. (This may have happened already if the host name
29426 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29427 Verification ensures that the host name obtained from a reverse DNS lookup, or
29428 one of its aliases, does, when it is itself looked up in the DNS, yield the
29429 original IP address.
29430
29431 There is one possible option, &`defer_ok`&.  If this is present and a
29432 DNS operation returns a temporary error, the verify condition succeeds.
29433
29434 If this condition is used for a locally generated message (that is, when there
29435 is no client host involved), it always succeeds.
29436
29437 .vitem &*verify&~=&~sender/*&<&'options'&>
29438 .cindex "&%verify%& ACL condition"
29439 .cindex "&ACL;" "verifying sender"
29440 .cindex "sender" "verifying"
29441 .cindex "verifying" "sender"
29442 This condition is relevant only after a MAIL or RCPT command, or after a
29443 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29444 the message's sender is empty (that is, this is a bounce message), the
29445 condition is true. Otherwise, the sender address is verified.
29446
29447 .vindex "&$address_data$&"
29448 .vindex "&$sender_address_data$&"
29449 If there is data in the &$address_data$& variable at the end of routing, its
29450 value is placed in &$sender_address_data$& at the end of verification. This
29451 value can be used in subsequent conditions and modifiers in the same ACL
29452 statement. It does not persist after the end of the current statement. If you
29453 want to preserve the value for longer, you can save it in an ACL variable.
29454
29455 Details of verification are given later, starting at section
29456 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29457 to avoid doing it more than once per message.
29458
29459 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29460 .cindex "&%verify%& ACL condition"
29461 This is a variation of the previous option, in which a modified address is
29462 verified as a sender.
29463 .endlist
29464
29465
29466
29467 .section "Using DNS lists" "SECTmorednslists"
29468 .cindex "DNS list" "in ACL"
29469 .cindex "black list (DNS)"
29470 .cindex "&ACL;" "testing a DNS list"
29471 In its simplest form, the &%dnslists%& condition tests whether the calling host
29472 is on at least one of a number of DNS lists by looking up the inverted IP
29473 address in one or more DNS domains. (Note that DNS list domains are not mail
29474 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29475 special options instead.) For example, if the calling host's IP
29476 address is 192.168.62.43, and the ACL statement is
29477 .code
29478 deny dnslists = blackholes.mail-abuse.org : \
29479                 dialups.mail-abuse.org
29480 .endd
29481 the following records are looked up:
29482 .code
29483 43.62.168.192.blackholes.mail-abuse.org
29484 43.62.168.192.dialups.mail-abuse.org
29485 .endd
29486 As soon as Exim finds an existing DNS record, processing of the list stops.
29487 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29488 to test that a host is on more than one list (an &"and"& conjunction), you can
29489 use two separate conditions:
29490 .code
29491 deny dnslists = blackholes.mail-abuse.org
29492      dnslists = dialups.mail-abuse.org
29493 .endd
29494 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29495 behaves as if the host does not match the list item, that is, as if the DNS
29496 record does not exist. If there are further items in the DNS list, they are
29497 processed.
29498
29499 This is usually the required action when &%dnslists%& is used with &%deny%&
29500 (which is the most common usage), because it prevents a DNS failure from
29501 blocking mail. However, you can change this behaviour by putting one of the
29502 following special items in the list:
29503 .display
29504 &`+include_unknown `&   behave as if the item is on the list
29505 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29506 &`+defer_unknown   `&   give a temporary error
29507 .endd
29508 .cindex "&`+include_unknown`&"
29509 .cindex "&`+exclude_unknown`&"
29510 .cindex "&`+defer_unknown`&"
29511 Each of these applies to any subsequent items on the list. For example:
29512 .code
29513 deny dnslists = +defer_unknown : foo.bar.example
29514 .endd
29515 Testing the list of domains stops as soon as a match is found. If you want to
29516 warn for one list and block for another, you can use two different statements:
29517 .code
29518 deny  dnslists = blackholes.mail-abuse.org
29519 warn  message  = X-Warn: sending host is on dialups list
29520       dnslists = dialups.mail-abuse.org
29521 .endd
29522 .cindex cacheing "of dns lookup"
29523 .cindex DNS TTL
29524 DNS list lookups are cached by Exim for the duration of the SMTP session
29525 .new
29526 (but limited by the DNS return TTL value),
29527 .wen
29528 so a lookup based on the IP address is done at most once for any incoming
29529 connection (assuming long-enough TTL).
29530 Exim does not share information between multiple incoming
29531 connections (but your local name server cache should be active).
29532
29533
29534
29535 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29536 .cindex "DNS list" "keyed by explicit IP address"
29537 By default, the IP address that is used in a DNS list lookup is the IP address
29538 of the calling host. However, you can specify another IP address by listing it
29539 after the domain name, introduced by a slash. For example:
29540 .code
29541 deny dnslists = black.list.tld/192.168.1.2
29542 .endd
29543 This feature is not very helpful with explicit IP addresses; it is intended for
29544 use with IP addresses that are looked up, for example, the IP addresses of the
29545 MX hosts or nameservers of an email sender address. For an example, see section
29546 &<<SECTmulkeyfor>>& below.
29547
29548
29549
29550
29551 .section "DNS lists keyed on domain names" "SECID202"
29552 .cindex "DNS list" "keyed by domain name"
29553 There are some lists that are keyed on domain names rather than inverted IP
29554 addresses (see for example the &'domain based zones'& link at
29555 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29556 with these lists. You can change the name that is looked up in a DNS list by
29557 listing it after the domain name, introduced by a slash. For example,
29558 .code
29559 deny  message  = Sender's domain is listed at $dnslist_domain
29560       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29561 .endd
29562 This particular example is useful only in ACLs that are obeyed after the
29563 RCPT or DATA commands, when a sender address is available. If (for
29564 example) the message's sender is &'user@tld.example'& the name that is looked
29565 up by this example is
29566 .code
29567 tld.example.dsn.rfc-ignorant.org
29568 .endd
29569 A single &%dnslists%& condition can contain entries for both names and IP
29570 addresses. For example:
29571 .code
29572 deny dnslists = sbl.spamhaus.org : \
29573                 dsn.rfc-ignorant.org/$sender_address_domain
29574 .endd
29575 The first item checks the sending host's IP address; the second checks a domain
29576 name. The whole condition is true if either of the DNS lookups succeeds.
29577
29578
29579
29580
29581 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29582 .cindex "DNS list" "multiple keys for"
29583 The syntax described above for looking up explicitly-defined values (either
29584 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29585 name for the DNS list, what follows the slash can in fact be a list of items.
29586 As with all lists in Exim, the default separator is a colon. However, because
29587 this is a sublist within the list of DNS blacklist domains, it is necessary
29588 either to double the separators like this:
29589 .code
29590 dnslists = black.list.tld/name.1::name.2
29591 .endd
29592 or to change the separator character, like this:
29593 .code
29594 dnslists = black.list.tld/<;name.1;name.2
29595 .endd
29596 If an item in the list is an IP address, it is inverted before the DNS
29597 blacklist domain is appended. If it is not an IP address, no inversion
29598 occurs. Consider this condition:
29599 .code
29600 dnslists = black.list.tld/<;192.168.1.2;a.domain
29601 .endd
29602 The DNS lookups that occur are:
29603 .code
29604 2.1.168.192.black.list.tld
29605 a.domain.black.list.tld
29606 .endd
29607 Once a DNS record has been found (that matches a specific IP return
29608 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29609 are done. If there is a temporary DNS error, the rest of the sublist of domains
29610 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29611 only if no other DNS lookup in this sublist succeeds. In other words, a
29612 successful lookup for any of the items in the sublist overrides a temporary
29613 error for a previous item.
29614
29615 The ability to supply a list of items after the slash is in some sense just a
29616 syntactic convenience. These two examples have the same effect:
29617 .code
29618 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29619 dnslists = black.list.tld/a.domain::b.domain
29620 .endd
29621 However, when the data for the list is obtained from a lookup, the second form
29622 is usually much more convenient. Consider this example:
29623 .code
29624 deny message  = The mail servers for the domain \
29625                 $sender_address_domain \
29626                 are listed at $dnslist_domain ($dnslist_value); \
29627                 see $dnslist_text.
29628      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29629                                    ${lookup dnsdb {>|mxh=\
29630                                    $sender_address_domain} }} }
29631 .endd
29632 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29633 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29634 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29635 of expanding the condition might be something like this:
29636 .code
29637 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29638 .endd
29639 Thus, this example checks whether or not the IP addresses of the sender
29640 domain's mail servers are on the Spamhaus black list.
29641
29642 The key that was used for a successful DNS list lookup is put into the variable
29643 &$dnslist_matched$& (see section &<<SECID204>>&).
29644
29645
29646
29647
29648 .section "Data returned by DNS lists" "SECID203"
29649 .cindex "DNS list" "data returned from"
29650 DNS lists are constructed using address records in the DNS. The original RBL
29651 just used the address 127.0.0.1 on the right hand side of each record, but the
29652 RBL+ list and some other lists use a number of values with different meanings.
29653 The values used on the RBL+ list are:
29654 .display
29655 127.1.0.1  RBL
29656 127.1.0.2  DUL
29657 127.1.0.3  DUL and RBL
29658 127.1.0.4  RSS
29659 127.1.0.5  RSS and RBL
29660 127.1.0.6  RSS and DUL
29661 127.1.0.7  RSS and DUL and RBL
29662 .endd
29663 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29664 different values. Some DNS lists may return more than one address record;
29665 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29666
29667
29668 .section "Variables set from DNS lists" "SECID204"
29669 .cindex "expansion" "variables, set from DNS list"
29670 .cindex "DNS list" "variables set from"
29671 .vindex "&$dnslist_domain$&"
29672 .vindex "&$dnslist_matched$&"
29673 .vindex "&$dnslist_text$&"
29674 .vindex "&$dnslist_value$&"
29675 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29676 the name of the overall domain that matched (for example,
29677 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29678 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29679 the DNS record. When the key is an IP address, it is not reversed in
29680 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29681 cases, for example:
29682 .code
29683 deny dnslists = spamhaus.example
29684 .endd
29685 the key is also available in another variable (in this case,
29686 &$sender_host_address$&). In more complicated cases, however, this is not true.
29687 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29688 might generate a dnslists lookup like this:
29689 .code
29690 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29691 .endd
29692 If this condition succeeds, the value in &$dnslist_matched$& might be
29693 &`192.168.6.7`& (for example).
29694
29695 If more than one address record is returned by the DNS lookup, all the IP
29696 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29697 The variable &$dnslist_text$& contains the contents of any associated TXT
29698 record. For lists such as RBL+ the TXT record for a merged entry is often not
29699 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29700 information.
29701
29702 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29703 &-- although these appear before the condition in the ACL, they are not
29704 expanded until after it has failed. For example:
29705 .code
29706 deny    hosts = !+local_networks
29707         message = $sender_host_address is listed \
29708                   at $dnslist_domain
29709         dnslists = rbl-plus.mail-abuse.example
29710 .endd
29711
29712
29713
29714 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29715 .cindex "DNS list" "matching specific returned data"
29716 You can add an equals sign and an IP address after a &%dnslists%& domain name
29717 in order to restrict its action to DNS records with a matching right hand side.
29718 For example,
29719 .code
29720 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29721 .endd
29722 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29723 any address record is considered to be a match. For the moment, we assume
29724 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29725 describes how multiple records are handled.
29726
29727 More than one IP address may be given for checking, using a comma as a
29728 separator. These are alternatives &-- if any one of them matches, the
29729 &%dnslists%& condition is true. For example:
29730 .code
29731 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29732 .endd
29733 If you want to specify a constraining address list and also specify names or IP
29734 addresses to be looked up, the constraining address list must be specified
29735 first. For example:
29736 .code
29737 deny dnslists = dsn.rfc-ignorant.org\
29738                 =127.0.0.2/$sender_address_domain
29739 .endd
29740
29741 If the character &`&&`& is used instead of &`=`&, the comparison for each
29742 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29743 In other words, the listed addresses are used as bit masks. The comparison is
29744 true if all the bits in the mask are present in the address that is being
29745 tested. For example:
29746 .code
29747 dnslists = a.b.c&0.0.0.3
29748 .endd
29749 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29750 want to test whether one bit or another bit is present (as opposed to both
29751 being present), you must use multiple values. For example:
29752 .code
29753 dnslists = a.b.c&0.0.0.1,0.0.0.2
29754 .endd
29755 matches if the final component of the address is an odd number or two times
29756 an odd number.
29757
29758
29759
29760 .section "Negated DNS matching conditions" "SECID205"
29761 You can supply a negative list of IP addresses as part of a &%dnslists%&
29762 condition. Whereas
29763 .code
29764 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29765 .endd
29766 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29767 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29768 .code
29769 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29770 .endd
29771 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29772 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29773 words, the result of the test is inverted if an exclamation mark appears before
29774 the &`=`& (or the &`&&`&) sign.
29775
29776 &*Note*&: This kind of negation is not the same as negation in a domain,
29777 host, or address list (which is why the syntax is different).
29778
29779 If you are using just one list, the negation syntax does not gain you much. The
29780 previous example is precisely equivalent to
29781 .code
29782 deny  dnslists = a.b.c
29783      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29784 .endd
29785 However, if you are using multiple lists, the negation syntax is clearer.
29786 Consider this example:
29787 .code
29788 deny  dnslists = sbl.spamhaus.org : \
29789                  list.dsbl.org : \
29790                  dnsbl.njabl.org!=127.0.0.3 : \
29791                  relays.ordb.org
29792 .endd
29793 Using only positive lists, this would have to be:
29794 .code
29795 deny  dnslists = sbl.spamhaus.org : \
29796                  list.dsbl.org
29797 deny  dnslists = dnsbl.njabl.org
29798      !dnslists = dnsbl.njabl.org=127.0.0.3
29799 deny  dnslists = relays.ordb.org
29800 .endd
29801 which is less clear, and harder to maintain.
29802
29803
29804
29805
29806 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29807 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29808 thereby providing more than one IP address. When an item in a &%dnslists%& list
29809 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29810 the match to specific results from the DNS lookup, there are two ways in which
29811 the checking can be handled. For example, consider the condition:
29812 .code
29813 dnslists = a.b.c=127.0.0.1
29814 .endd
29815 What happens if the DNS lookup for the incoming IP address yields both
29816 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29817 condition true because at least one given value was found, or is it false
29818 because at least one of the found values was not listed? And how does this
29819 affect negated conditions? Both possibilities are provided for with the help of
29820 additional separators &`==`& and &`=&&`&.
29821
29822 .ilist
29823 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29824 IP addresses matches one of the listed addresses. For the example above, the
29825 condition is true because 127.0.0.1 matches.
29826 .next
29827 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29828 looked up IP addresses matches one of the listed addresses. If the condition is
29829 changed to:
29830 .code
29831 dnslists = a.b.c==127.0.0.1
29832 .endd
29833 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29834 false because 127.0.0.2 is not listed. You would need to have:
29835 .code
29836 dnslists = a.b.c==127.0.0.1,127.0.0.2
29837 .endd
29838 for the condition to be true.
29839 .endlist
29840
29841 When &`!`& is used to negate IP address matching, it inverts the result, giving
29842 the precise opposite of the behaviour above. Thus:
29843 .ilist
29844 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29845 addresses matches one of the listed addresses. Consider:
29846 .code
29847 dnslists = a.b.c!&0.0.0.1
29848 .endd
29849 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29850 false because 127.0.0.1 matches.
29851 .next
29852 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29853 looked up IP address that does not match. Consider:
29854 .code
29855 dnslists = a.b.c!=&0.0.0.1
29856 .endd
29857 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29858 true, because 127.0.0.2 does not match. You would need to have:
29859 .code
29860 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29861 .endd
29862 for the condition to be false.
29863 .endlist
29864 When the DNS lookup yields only a single IP address, there is no difference
29865 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29866
29867
29868
29869
29870 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29871 .cindex "DNS list" "information from merged"
29872 When the facility for restricting the matching IP values in a DNS list is used,
29873 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29874 the true reason for rejection. This happens when lists are merged and the IP
29875 address in the A record is used to distinguish them; unfortunately there is
29876 only one TXT record. One way round this is not to use merged lists, but that
29877 can be inefficient because it requires multiple DNS lookups where one would do
29878 in the vast majority of cases when the host of interest is not on any of the
29879 lists.
29880
29881 A less inefficient way of solving this problem is available. If
29882 two domain names, comma-separated, are given, the second is used first to
29883 do an initial check, making use of any IP value restrictions that are set.
29884 If there is a match, the first domain is used, without any IP value
29885 restrictions, to get the TXT record. As a byproduct of this, there is also
29886 a check that the IP being tested is indeed on the first list. The first
29887 domain is the one that is put in &$dnslist_domain$&. For example:
29888 .code
29889 reject message  = \
29890          rejected because $sender_host_address is blacklisted \
29891          at $dnslist_domain\n$dnslist_text
29892        dnslists = \
29893          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29894          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29895 .endd
29896 For the first blacklist item, this starts by doing a lookup in
29897 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29898 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29899 value, and as long as something is found, it looks for the corresponding TXT
29900 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29901 The second blacklist item is processed similarly.
29902
29903 If you are interested in more than one merged list, the same list must be
29904 given several times, but because the results of the DNS lookups are cached,
29905 the DNS calls themselves are not repeated. For example:
29906 .code
29907 reject dnslists = \
29908          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29909          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29910          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29911          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29912 .endd
29913 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29914 values matches (or if no record is found), this is the only lookup that is
29915 done. Only if there is a match is one of the more specific lists consulted.
29916
29917
29918
29919 .section "DNS lists and IPv6" "SECTmorednslistslast"
29920 .cindex "IPv6" "DNS black lists"
29921 .cindex "DNS list" "IPv6 usage"
29922 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29923 nibble by nibble. For example, if the calling host's IP address is
29924 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29925 .code
29926 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29927   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29928 .endd
29929 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29930 lists contain wildcard records, intended for IPv4, that interact badly with
29931 IPv6. For example, the DNS entry
29932 .code
29933 *.3.some.list.example.    A    127.0.0.1
29934 .endd
29935 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29936 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29937
29938 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29939 &%condition%& condition, as in this example:
29940 .code
29941 deny   condition = ${if isip4{$sender_host_address}}
29942        dnslists  = some.list.example
29943 .endd
29944
29945 If an explicit key is being used for a DNS lookup and it may be an IPv6
29946 address you should specify alternate list separators for both the outer
29947 (DNS list name) list and inner (lookup keys) list:
29948 .code
29949        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29950 .endd
29951
29952 .section "Rate limiting incoming messages" "SECTratelimiting"
29953 .cindex "rate limiting" "client sending"
29954 .cindex "limiting client sending rates"
29955 .oindex "&%smtp_ratelimit_*%&"
29956 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29957 which clients can send email. This is more powerful than the
29958 &%smtp_ratelimit_*%& options, because those options control the rate of
29959 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29960 works across all connections (concurrent and sequential) from the same client
29961 host. The syntax of the &%ratelimit%& condition is:
29962 .display
29963 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29964 .endd
29965 If the average client sending rate is less than &'m'& messages per time
29966 period &'p'& then the condition is false; otherwise it is true.
29967
29968 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29969 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29970 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29971 of &'p'&.
29972
29973 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29974 time interval, for example, &`8h`& for eight hours. A larger time constant
29975 means that it takes Exim longer to forget a client's past behaviour. The
29976 parameter &'m'& is the maximum number of messages that a client is permitted to
29977 send in each time interval. It also specifies the number of messages permitted
29978 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29979 constant, you can allow a client to send more messages in a burst without
29980 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29981 both small, messages must be sent at an even rate.
29982
29983 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29984 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29985 when deploying the &%ratelimit%& ACL condition. The script prints usage
29986 instructions when it is run with no arguments.
29987
29988 The key is used to look up the data for calculating the client's average
29989 sending rate. This data is stored in Exim's spool directory, alongside the
29990 retry and other hints databases. The default key is &$sender_host_address$&,
29991 which means Exim computes the sending rate of each client host IP address.
29992 By changing the key you can change how Exim identifies clients for the purpose
29993 of ratelimiting. For example, to limit the sending rate of each authenticated
29994 user, independent of the computer they are sending from, set the key to
29995 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29996 example, &$authenticated_id$& is only meaningful if the client has
29997 authenticated (which you can check with the &%authenticated%& ACL condition).
29998
29999 The lookup key does not have to identify clients: If you want to limit the
30000 rate at which a recipient receives messages, you can use the key
30001 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30002 ACL.
30003
30004 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30005 specifies what Exim measures the rate of, for example messages or recipients
30006 or bytes. You can adjust the measurement using the &%unique=%& and/or
30007 &%count=%& options. You can also control when Exim updates the recorded rate
30008 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30009 separated by a slash, like the other parameters. They may appear in any order.
30010
30011 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30012 any options that alter the meaning of the stored data. The limit &'m'& is not
30013 stored, so you can alter the configured maximum rate and Exim will still
30014 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30015 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30016 behaviour. The lookup key is not affected by changes to the update mode and
30017 the &%count=%& option.
30018
30019
30020 .section "Ratelimit options for what is being measured" "ratoptmea"
30021 .cindex "rate limiting" "per_* options"
30022 The &%per_conn%& option limits the client's connection rate. It is not
30023 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30024 &%acl_not_smtp_start%& ACLs.
30025
30026 The &%per_mail%& option limits the client's rate of sending messages. This is
30027 the default if none of the &%per_*%& options is specified. It can be used in
30028 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30029 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30030
30031 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30032 the same ACLs as the &%per_mail%& option, though it is best to use this option
30033 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30034 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30035 in its MAIL command, which may be inaccurate or completely missing. You can
30036 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30037 in kilobytes, megabytes, or gigabytes, respectively.
30038
30039 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30040 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30041 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30042 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30043 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30044 in either case the rate limiting engine will see a message with many
30045 recipients as a large high-speed burst.
30046
30047 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30048 number of different recipients that the client has sent messages to in the
30049 last time period. That is, if the client repeatedly sends messages to the same
30050 recipient, its measured rate is not increased. This option can only be used in
30051 &%acl_smtp_rcpt%&.
30052
30053 The &%per_cmd%& option causes Exim to recompute the rate every time the
30054 condition is processed. This can be used to limit the rate of any SMTP
30055 command. If it is used in multiple ACLs it can limit the aggregate rate of
30056 multiple different commands.
30057
30058 The &%count=%& option can be used to alter how much Exim adds to the client's
30059 measured rate. For example, the &%per_byte%& option is equivalent to
30060 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30061 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30062 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30063
30064 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30065
30066
30067 .section "Ratelimit update modes" "ratoptupd"
30068 .cindex "rate limiting" "reading data without updating"
30069 You can specify one of three options with the &%ratelimit%& condition to
30070 control when its database is updated. This section describes the &%readonly%&
30071 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30072
30073 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30074 previously-computed rate to check against the limit.
30075
30076 For example, you can test the client's sending rate and deny it access (when
30077 it is too fast) in the connect ACL. If the client passes this check then it
30078 can go on to send a message, in which case its recorded rate will be updated
30079 in the MAIL ACL. Subsequent connections from the same client will check this
30080 new rate.
30081 .code
30082 acl_check_connect:
30083  deny ratelimit = 100 / 5m / readonly
30084     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30085                   (max $sender_rate_limit)
30086 # ...
30087 acl_check_mail:
30088  warn ratelimit = 100 / 5m / strict
30089     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30090                   (max $sender_rate_limit)
30091 .endd
30092
30093 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30094 processing a message then it may increase the client's measured rate more than
30095 it should. For example, this will happen if you check the &%per_rcpt%& option
30096 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30097 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30098 multiple update problems by using the &%readonly%& option on later ratelimit
30099 checks.
30100
30101 The &%per_*%& options described above do not make sense in some ACLs. If you
30102 use a &%per_*%& option in an ACL where it is not normally permitted then the
30103 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30104 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30105 next section) so you must specify the &%readonly%& option explicitly.
30106
30107
30108 .section "Ratelimit options for handling fast clients" "ratoptfast"
30109 .cindex "rate limiting" "strict and leaky modes"
30110 If a client's average rate is greater than the maximum, the rate limiting
30111 engine can react in two possible ways, depending on the presence of the
30112 &%strict%& or &%leaky%& update modes. This is independent of the other
30113 counter-measures (such as rejecting the message) that may be specified by the
30114 rest of the ACL.
30115
30116 The &%leaky%& (default) option means that the client's recorded rate is not
30117 updated if it is above the limit. The effect of this is that Exim measures the
30118 client's average rate of successfully sent email, which cannot be greater than
30119 the maximum allowed. If the client is over the limit it may suffer some
30120 counter-measures (as specified in the ACL), but it will still be able to send
30121 email at the configured maximum rate, whatever the rate of its attempts. This
30122 is generally the better choice if you have clients that retry automatically.
30123 For example, it does not prevent a sender with an over-aggressive retry rate
30124 from getting any email through.
30125
30126 The &%strict%& option means that the client's recorded rate is always
30127 updated. The effect of this is that Exim measures the client's average rate
30128 of attempts to send email, which can be much higher than the maximum it is
30129 actually allowed. If the client is over the limit it may be subjected to
30130 counter-measures by the ACL. It must slow down and allow sufficient time to
30131 pass that its computed rate falls below the maximum before it can send email
30132 again. The time (the number of smoothing periods) it must wait and not
30133 attempt to send mail can be calculated with this formula:
30134 .code
30135         ln(peakrate/maxrate)
30136 .endd
30137
30138
30139 .section "Limiting the rate of different events" "ratoptuniq"
30140 .cindex "rate limiting" "counting unique events"
30141 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30142 rate of different events. For example, the &%per_addr%& option uses this
30143 mechanism to count the number of different recipients that the client has
30144 sent messages to in the last time period; it is equivalent to
30145 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30146 measure the rate that a client uses different sender addresses with the
30147 options &`per_mail/unique=$sender_address`&.
30148
30149 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30150 has seen for that key. The whole set is thrown away when it is older than the
30151 rate smoothing period &'p'&, so each different event is counted at most once
30152 per period. In the &%leaky%& update mode, an event that causes the client to
30153 go over the limit is not added to the set, in the same way that the client's
30154 recorded rate is not updated in the same situation.
30155
30156 When you combine the &%unique=%& and &%readonly%& options, the specific
30157 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30158 rate.
30159
30160 The &%unique=%& mechanism needs more space in the ratelimit database than the
30161 other &%ratelimit%& options in order to store the event set. The number of
30162 unique values is potentially as large as the rate limit, so the extra space
30163 required increases with larger limits.
30164
30165 The uniqueification is not perfect: there is a small probability that Exim
30166 will think a new event has happened before. If the sender's rate is less than
30167 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30168 the measured rate can go above the limit, in which case Exim may under-count
30169 events by a significant margin. Fortunately, if the rate is high enough (2.7
30170 times the limit) that the false positive rate goes above 9%, then Exim will
30171 throw away the over-full event set before the measured rate falls below the
30172 limit. Therefore the only harm should be that exceptionally high sending rates
30173 are logged incorrectly; any countermeasures you configure will be as effective
30174 as intended.
30175
30176
30177 .section "Using rate limiting" "useratlim"
30178 Exim's other ACL facilities are used to define what counter-measures are taken
30179 when the rate limit is exceeded. This might be anything from logging a warning
30180 (for example, while measuring existing sending rates in order to define
30181 policy), through time delays to slow down fast senders, up to rejecting the
30182 message. For example:
30183 .code
30184 # Log all senders' rates
30185 warn ratelimit = 0 / 1h / strict
30186      log_message = Sender rate $sender_rate / $sender_rate_period
30187
30188 # Slow down fast senders; note the need to truncate $sender_rate
30189 # at the decimal point.
30190 warn ratelimit = 100 / 1h / per_rcpt / strict
30191      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30192                    $sender_rate_limit }s
30193
30194 # Keep authenticated users under control
30195 deny authenticated = *
30196      ratelimit = 100 / 1d / strict / $authenticated_id
30197
30198 # System-wide rate limit
30199 defer message = Sorry, too busy. Try again later.
30200      ratelimit = 10 / 1s / $primary_hostname
30201
30202 # Restrict incoming rate from each host, with a default
30203 # set using a macro and special cases looked up in a table.
30204 defer message = Sender rate exceeds $sender_rate_limit \
30205                messages per $sender_rate_period
30206      ratelimit = ${lookup {$sender_host_address} \
30207                    cdb {DB/ratelimits.cdb} \
30208                    {$value} {RATELIMIT} }
30209 .endd
30210 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30211 especially with the &%per_rcpt%& option, you may suffer from a performance
30212 bottleneck caused by locking on the ratelimit hints database. Apart from
30213 making your ACLs less complicated, you can reduce the problem by using a
30214 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30215 this means that Exim will lose its hints data after a reboot (including retry
30216 hints, the callout cache, and ratelimit data).
30217
30218
30219
30220 .section "Address verification" "SECTaddressverification"
30221 .cindex "verifying address" "options for"
30222 .cindex "policy control" "address verification"
30223 Several of the &%verify%& conditions described in section
30224 &<<SECTaclconditions>>& cause addresses to be verified. Section
30225 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30226 The verification conditions can be followed by options that modify the
30227 verification process. The options are separated from the keyword and from each
30228 other by slashes, and some of them contain parameters. For example:
30229 .code
30230 verify = sender/callout
30231 verify = recipient/defer_ok/callout=10s,defer_ok
30232 .endd
30233 The first stage of address verification, which always happens, is to run the
30234 address through the routers, in &"verify mode"&. Routers can detect the
30235 difference between verification and routing for delivery, and their actions can
30236 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30237 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30238 The available options are as follows:
30239
30240 .ilist
30241 If the &%callout%& option is specified, successful routing to one or more
30242 remote hosts is followed by a &"callout"& to those hosts as an additional
30243 check. Callouts and their sub-options are discussed in the next section.
30244 .next
30245 If there is a defer error while doing verification routing, the ACL
30246 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30247 options, the condition is forced to be true instead. Note that this is a main
30248 verification option as well as a suboption for callouts.
30249 .next
30250 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30251 discusses the reporting of sender address verification failures.
30252 .next
30253 The &%success_on_redirect%& option causes verification always to succeed
30254 immediately after a successful redirection. By default, if a redirection
30255 generates just one address, that address is also verified. See further
30256 discussion in section &<<SECTredirwhilveri>>&.
30257 .endlist
30258
30259 .cindex "verifying address" "differentiating failures"
30260 .vindex "&$recipient_verify_failure$&"
30261 .vindex "&$sender_verify_failure$&"
30262 .vindex "&$acl_verify_message$&"
30263 After an address verification failure, &$acl_verify_message$& contains the
30264 error message that is associated with the failure. It can be preserved by
30265 coding like this:
30266 .code
30267 warn  !verify = sender
30268        set acl_m0 = $acl_verify_message
30269 .endd
30270 If you are writing your own custom rejection message or log message when
30271 denying access, you can use this variable to include information about the
30272 verification failure.
30273
30274 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30275 appropriate) contains one of the following words:
30276
30277 .ilist
30278 &%qualify%&: The address was unqualified (no domain), and the message
30279 was neither local nor came from an exempted host.
30280 .next
30281 &%route%&: Routing failed.
30282 .next
30283 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30284 occurred at or before the MAIL command (that is, on initial
30285 connection, HELO, or MAIL).
30286 .next
30287 &%recipient%&: The RCPT command in a callout was rejected.
30288 .next
30289 &%postmaster%&: The postmaster check in a callout was rejected.
30290 .endlist
30291
30292 The main use of these variables is expected to be to distinguish between
30293 rejections of MAIL and rejections of RCPT in callouts.
30294
30295
30296
30297
30298 .section "Callout verification" "SECTcallver"
30299 .cindex "verifying address" "by callout"
30300 .cindex "callout" "verification"
30301 .cindex "SMTP" "callout verification"
30302 For non-local addresses, routing verifies the domain, but is unable to do any
30303 checking of the local part. There are situations where some means of verifying
30304 the local part is desirable. One way this can be done is to make an SMTP
30305 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30306 a subsequent host for a recipient address, to see if the host accepts the
30307 address. We use the term &'callout'& to cover both cases. Note that for a
30308 sender address, the callback is not to the client host that is trying to
30309 deliver the message, but to one of the hosts that accepts incoming mail for the
30310 sender's domain.
30311
30312 Exim does not do callouts by default. If you want them to happen, you must
30313 request them by setting appropriate options on the &%verify%& condition, as
30314 described below. This facility should be used with care, because it can add a
30315 lot of resource usage to the cost of verifying an address. However, Exim does
30316 cache the results of callouts, which helps to reduce the cost. Details of
30317 caching are in section &<<SECTcallvercache>>&.
30318
30319 Recipient callouts are usually used only between hosts that are controlled by
30320 the same administration. For example, a corporate gateway host could use
30321 callouts to check for valid recipients on an internal mailserver. A successful
30322 callout does not guarantee that a real delivery to the address would succeed;
30323 on the other hand, a failing callout does guarantee that a delivery would fail.
30324
30325 If the &%callout%& option is present on a condition that verifies an address, a
30326 second stage of verification occurs if the address is successfully routed to
30327 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30328 &(manualroute)& router, where the router specifies the hosts. However, if a
30329 router that does not set up hosts routes to an &(smtp)& transport with a
30330 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30331 &%hosts_override%& set, its hosts are always used, whether or not the router
30332 supplies a host list.
30333 Callouts are only supported on &(smtp)& transports.
30334
30335 The port that is used is taken from the transport, if it is specified and is a
30336 remote transport. (For routers that do verification only, no transport need be
30337 specified.) Otherwise, the default SMTP port is used. If a remote transport
30338 specifies an outgoing interface, this is used; otherwise the interface is not
30339 specified. Likewise, the text that is used for the HELO command is taken from
30340 the transport's &%helo_data%& option; if there is no transport, the value of
30341 &$smtp_active_hostname$& is used.
30342
30343 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30344 test whether a bounce message could be delivered to the sender address. The
30345 following SMTP commands are sent:
30346 .display
30347 &`HELO `&<&'local host name'&>
30348 &`MAIL FROM:<>`&
30349 &`RCPT TO:`&<&'the address to be tested'&>
30350 &`QUIT`&
30351 .endd
30352 LHLO is used instead of HELO if the transport's &%protocol%& option is
30353 set to &"lmtp"&.
30354
30355 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30356 settings.
30357
30358 A recipient callout check is similar. By default, it also uses an empty address
30359 for the sender. This default is chosen because most hosts do not make use of
30360 the sender address when verifying a recipient. Using the same address means
30361 that a single cache entry can be used for each recipient. Some sites, however,
30362 do make use of the sender address when verifying. These are catered for by the
30363 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30364
30365 If the response to the RCPT command is a 2&'xx'& code, the verification
30366 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30367 Exim tries the next host, if any. If there is a problem with all the remote
30368 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30369 &%callout%& option is given, in which case the condition is forced to succeed.
30370
30371 .cindex "SMTP" "output flushing, disabling for callout"
30372 A callout may take a little time. For this reason, Exim normally flushes SMTP
30373 output before performing a callout in an ACL, to avoid unexpected timeouts in
30374 clients when the SMTP PIPELINING extension is in use. The flushing can be
30375 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30376
30377
30378
30379
30380 .section "Additional parameters for callouts" "CALLaddparcall"
30381 .cindex "callout" "additional parameters for"
30382 The &%callout%& option can be followed by an equals sign and a number of
30383 optional parameters, separated by commas. For example:
30384 .code
30385 verify = recipient/callout=10s,defer_ok
30386 .endd
30387 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30388 separate verify options, is retained for backwards compatibility, but is now
30389 deprecated. The additional parameters for &%callout%& are as follows:
30390
30391
30392 .vlist
30393 .vitem <&'a&~time&~interval'&>
30394 .cindex "callout" "timeout, specifying"
30395 This specifies the timeout that applies for the callout attempt to each host.
30396 For example:
30397 .code
30398 verify = sender/callout=5s
30399 .endd
30400 The default is 30 seconds. The timeout is used for each response from the
30401 remote host. It is also used for the initial connection, unless overridden by
30402 the &%connect%& parameter.
30403
30404
30405 .vitem &*connect&~=&~*&<&'time&~interval'&>
30406 .cindex "callout" "connection timeout, specifying"
30407 This parameter makes it possible to set a different (usually smaller) timeout
30408 for making the SMTP connection. For example:
30409 .code
30410 verify = sender/callout=5s,connect=1s
30411 .endd
30412 If not specified, this timeout defaults to the general timeout value.
30413
30414 .vitem &*defer_ok*&
30415 .cindex "callout" "defer, action on"
30416 When this parameter is present, failure to contact any host, or any other kind
30417 of temporary error, is treated as success by the ACL. However, the cache is not
30418 updated in this circumstance.
30419
30420 .vitem &*fullpostmaster*&
30421 .cindex "callout" "full postmaster check"
30422 This operates like the &%postmaster%& option (see below), but if the check for
30423 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30424 accordance with the specification in RFC 2821. The RFC states that the
30425 unqualified address &'postmaster'& should be accepted.
30426
30427
30428 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30429 .cindex "callout" "sender when verifying header"
30430 When verifying addresses in header lines using the &%header_sender%&
30431 verification option, Exim behaves by default as if the addresses are envelope
30432 sender addresses from a message. Callout verification therefore tests to see
30433 whether a bounce message could be delivered, by using an empty address in the
30434 MAIL command. However, it is arguable that these addresses might never be used
30435 as envelope senders, and could therefore justifiably reject bounce messages
30436 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30437 address to use in the MAIL command. For example:
30438 .code
30439 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30440 .endd
30441 This parameter is available only for the &%header_sender%& verification option.
30442
30443
30444 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30445 .cindex "callout" "overall timeout, specifying"
30446 This parameter sets an overall timeout for performing a callout verification.
30447 For example:
30448 .code
30449 verify = sender/callout=5s,maxwait=30s
30450 .endd
30451 This timeout defaults to four times the callout timeout for individual SMTP
30452 commands. The overall timeout applies when there is more than one host that can
30453 be tried. The timeout is checked before trying the next host. This prevents
30454 very long delays if there are a large number of hosts and all are timing out
30455 (for example, when network connections are timing out).
30456
30457
30458 .vitem &*no_cache*&
30459 .cindex "callout" "cache, suppressing"
30460 .cindex "caching callout, suppressing"
30461 When this parameter is given, the callout cache is neither read nor updated.
30462
30463 .vitem &*postmaster*&
30464 .cindex "callout" "postmaster; checking"
30465 When this parameter is set, a successful callout check is followed by a similar
30466 check for the local part &'postmaster'& at the same domain. If this address is
30467 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30468 the postmaster check is recorded in a cache record; if it is a failure, this is
30469 used to fail subsequent callouts for the domain without a connection being
30470 made, until the cache record expires.
30471
30472 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30473 The postmaster check uses an empty sender in the MAIL command by default.
30474 You can use this parameter to do a postmaster check using a different address.
30475 For example:
30476 .code
30477 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30478 .endd
30479 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30480 one overrides. The &%postmaster%& parameter is equivalent to this example:
30481 .code
30482 require  verify = sender/callout=postmaster_mailfrom=
30483 .endd
30484 &*Warning*&: The caching arrangements for postmaster checking do not take
30485 account of the sender address. It is assumed that either the empty address or
30486 a fixed non-empty address will be used. All that Exim remembers is that the
30487 postmaster check for the domain succeeded or failed.
30488
30489
30490 .vitem &*random*&
30491 .cindex "callout" "&""random""& check"
30492 When this parameter is set, before doing the normal callout check, Exim does a
30493 check for a &"random"& local part at the same domain. The local part is not
30494 really random &-- it is defined by the expansion of the option
30495 &%callout_random_local_part%&, which defaults to
30496 .code
30497 $primary_hostname-$tod_epoch-testing
30498 .endd
30499 The idea here is to try to determine whether the remote host accepts all local
30500 parts without checking. If it does, there is no point in doing callouts for
30501 specific local parts. If the &"random"& check succeeds, the result is saved in
30502 a cache record, and used to force the current and subsequent callout checks to
30503 succeed without a connection being made, until the cache record expires.
30504
30505 .vitem &*use_postmaster*&
30506 .cindex "callout" "sender for recipient check"
30507 This parameter applies to recipient callouts only. For example:
30508 .code
30509 deny  !verify = recipient/callout=use_postmaster
30510 .endd
30511 .vindex "&$qualify_domain$&"
30512 It causes a non-empty postmaster address to be used in the MAIL command when
30513 performing the callout for the recipient, and also for a &"random"& check if
30514 that is configured. The local part of the address is &`postmaster`& and the
30515 domain is the contents of &$qualify_domain$&.
30516
30517 .vitem &*use_sender*&
30518 This option applies to recipient callouts only. For example:
30519 .code
30520 require  verify = recipient/callout=use_sender
30521 .endd
30522 It causes the message's actual sender address to be used in the MAIL
30523 command when performing the callout, instead of an empty address. There is no
30524 need to use this option unless you know that the called hosts make use of the
30525 sender when checking recipients. If used indiscriminately, it reduces the
30526 usefulness of callout caching.
30527 .endlist
30528
30529 If you use any of the parameters that set a non-empty sender for the MAIL
30530 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30531 &%use_sender%&), you should think about possible loops. Recipient checking is
30532 usually done between two hosts that are under the same management, and the host
30533 that receives the callouts is not normally configured to do callouts itself.
30534 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30535 these circumstances.
30536
30537 However, if you use a non-empty sender address for a callout to an arbitrary
30538 host, there is the likelihood that the remote host will itself initiate a
30539 callout check back to your host. As it is checking what appears to be a message
30540 sender, it is likely to use an empty address in MAIL, thus avoiding a
30541 callout loop. However, to be on the safe side it would be best to set up your
30542 own ACLs so that they do not do sender verification checks when the recipient
30543 is the address you use for header sender or postmaster callout checking.
30544
30545 Another issue to think about when using non-empty senders for callouts is
30546 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30547 by the sender/recipient combination; thus, for any given recipient, many more
30548 actual callouts are performed than when an empty sender or postmaster is used.
30549
30550
30551
30552
30553 .section "Callout caching" "SECTcallvercache"
30554 .cindex "hints database" "callout cache"
30555 .cindex "callout" "cache, description of"
30556 .cindex "caching" "callout"
30557 Exim caches the results of callouts in order to reduce the amount of resources
30558 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30559 option. A hints database called &"callout"& is used for the cache. Two
30560 different record types are used: one records the result of a callout check for
30561 a specific address, and the other records information that applies to the
30562 entire domain (for example, that it accepts the local part &'postmaster'&).
30563
30564 When an original callout fails, a detailed SMTP error message is given about
30565 the failure. However, for subsequent failures use the cache data, this message
30566 is not available.
30567
30568 The expiry times for negative and positive address cache records are
30569 independent, and can be set by the global options &%callout_negative_expire%&
30570 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30571
30572 If a host gives a negative response to an SMTP connection, or rejects any
30573 commands up to and including
30574 .code
30575 MAIL FROM:<>
30576 .endd
30577 (but not including the MAIL command with a non-empty address),
30578 any callout attempt is bound to fail. Exim remembers such failures in a
30579 domain cache record, which it uses to fail callouts for the domain without
30580 making new connections, until the domain record times out. There are two
30581 separate expiry times for domain cache records:
30582 &%callout_domain_negative_expire%& (default 3h) and
30583 &%callout_domain_positive_expire%& (default 7d).
30584
30585 Domain records expire when the negative expiry time is reached if callouts
30586 cannot be made for the domain, or if the postmaster check failed.
30587 Otherwise, they expire when the positive expiry time is reached. This
30588 ensures that, for example, a host that stops accepting &"random"& local parts
30589 will eventually be noticed.
30590
30591 The callout caching mechanism is based on the domain of the address that is
30592 being tested. If the domain routes to several hosts, it is assumed that their
30593 behaviour will be the same.
30594
30595
30596
30597 .section "Sender address verification reporting" "SECTsenaddver"
30598 .cindex "verifying" "suppressing error details"
30599 See section &<<SECTaddressverification>>& for a general discussion of
30600 verification. When sender verification fails in an ACL, the details of the
30601 failure are given as additional output lines before the 550 response to the
30602 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30603 you might see:
30604 .code
30605 MAIL FROM:<xyz@abc.example>
30606 250 OK
30607 RCPT TO:<pqr@def.example>
30608 550-Verification failed for <xyz@abc.example>
30609 550-Called:   192.168.34.43
30610 550-Sent:     RCPT TO:<xyz@abc.example>
30611 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30612 550 Sender verification failed
30613 .endd
30614 If more than one RCPT command fails in the same way, the details are given
30615 only for the first of them. However, some administrators do not want to send
30616 out this much information. You can suppress the details by adding
30617 &`/no_details`& to the ACL statement that requests sender verification. For
30618 example:
30619 .code
30620 verify = sender/no_details
30621 .endd
30622
30623 .section "Redirection while verifying" "SECTredirwhilveri"
30624 .cindex "verifying" "redirection while"
30625 .cindex "address redirection" "while verifying"
30626 A dilemma arises when a local address is redirected by aliasing or forwarding
30627 during verification: should the generated addresses themselves be verified,
30628 or should the successful expansion of the original address be enough to verify
30629 it? By default, Exim takes the following pragmatic approach:
30630
30631 .ilist
30632 When an incoming address is redirected to just one child address, verification
30633 continues with the child address, and if that fails to verify, the original
30634 verification also fails.
30635 .next
30636 When an incoming address is redirected to more than one child address,
30637 verification does not continue. A success result is returned.
30638 .endlist
30639
30640 This seems the most reasonable behaviour for the common use of aliasing as a
30641 way of redirecting different local parts to the same mailbox. It means, for
30642 example, that a pair of alias entries of the form
30643 .code
30644 A.Wol:   aw123
30645 aw123:   :fail: Gone away, no forwarding address
30646 .endd
30647 work as expected, with both local parts causing verification failure. When a
30648 redirection generates more than one address, the behaviour is more like a
30649 mailing list, where the existence of the alias itself is sufficient for
30650 verification to succeed.
30651
30652 It is possible, however, to change the default behaviour so that all successful
30653 redirections count as successful verifications, however many new addresses are
30654 generated. This is specified by the &%success_on_redirect%& verification
30655 option. For example:
30656 .code
30657 require verify = recipient/success_on_redirect/callout=10s
30658 .endd
30659 In this example, verification succeeds if a router generates a new address, and
30660 the callout does not occur, because no address was routed to a remote host.
30661
30662 When verification is being tested via the &%-bv%& option, the treatment of
30663 redirections is as just described, unless the &%-v%& or any debugging option is
30664 also specified. In that case, full verification is done for every generated
30665 address and a report is output for each of them.
30666
30667
30668
30669 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30670 .cindex "CSA" "verifying"
30671 Client SMTP Authorization is a system that allows a site to advertise
30672 which machines are and are not permitted to send email. This is done by placing
30673 special SRV records in the DNS; these are looked up using the client's HELO
30674 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30675 Authorization checks in Exim are performed by the ACL condition:
30676 .code
30677 verify = csa
30678 .endd
30679 This fails if the client is not authorized. If there is a DNS problem, or if no
30680 valid CSA SRV record is found, or if the client is authorized, the condition
30681 succeeds. These three cases can be distinguished using the expansion variable
30682 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30683 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30684 be likely to cause problems for legitimate email.
30685
30686 The error messages produced by the CSA code include slightly more
30687 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30688 looking up the CSA SRV record, or problems looking up the CSA target
30689 address record. There are four reasons for &$csa_status$& being &"fail"&:
30690
30691 .ilist
30692 The client's host name is explicitly not authorized.
30693 .next
30694 The client's IP address does not match any of the CSA target IP addresses.
30695 .next
30696 The client's host name is authorized but it has no valid target IP addresses
30697 (for example, the target's addresses are IPv6 and the client is using IPv4).
30698 .next
30699 The client's host name has no CSA SRV record but a parent domain has asserted
30700 that all subdomains must be explicitly authorized.
30701 .endlist
30702
30703 The &%csa%& verification condition can take an argument which is the domain to
30704 use for the DNS query. The default is:
30705 .code
30706 verify = csa/$sender_helo_name
30707 .endd
30708 This implementation includes an extension to CSA. If the query domain
30709 is an address literal such as [192.0.2.95], or if it is a bare IP
30710 address, Exim searches for CSA SRV records in the reverse DNS as if
30711 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30712 meaningful to say:
30713 .code
30714 verify = csa/$sender_host_address
30715 .endd
30716 In fact, this is the check that Exim performs if the client does not say HELO.
30717 This extension can be turned off by setting the main configuration option
30718 &%dns_csa_use_reverse%& to be false.
30719
30720 If a CSA SRV record is not found for the domain itself, a search
30721 is performed through its parent domains for a record which might be
30722 making assertions about subdomains. The maximum depth of this search is limited
30723 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30724 default. Exim does not look for CSA SRV records in a top level domain, so the
30725 default settings handle HELO domains as long as seven
30726 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30727 of legitimate HELO domains.
30728
30729 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30730 direct SRV lookups, this is not sufficient because of the extra parent domain
30731 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30732 addresses into lookups in the reverse DNS space. The result of a successful
30733 lookup such as:
30734 .code
30735 ${lookup dnsdb {csa=$sender_helo_name}}
30736 .endd
30737 has two space-separated fields: an authorization code and a target host name.
30738 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30739 authorization required but absent, or &"?"& for unknown.
30740
30741
30742
30743
30744 .section "Bounce address tag validation" "SECTverifyPRVS"
30745 .cindex "BATV, verifying"
30746 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30747 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30748 Genuine incoming bounce messages should therefore always be addressed to
30749 recipients that have a valid tag. This scheme is a way of detecting unwanted
30750 bounce messages caused by sender address forgeries (often called &"collateral
30751 spam"&), because the recipients of such messages do not include valid tags.
30752
30753 There are two expansion items to help with the implementation of the BATV
30754 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30755 the original envelope sender address by using a simple key to add a hash of the
30756 address and some time-based randomizing information. The &%prvs%& expansion
30757 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30758 The syntax of these expansion items is described in section
30759 &<<SECTexpansionitems>>&.
30760
30761 As an example, suppose the secret per-address keys are stored in an MySQL
30762 database. A query to look up the key for an address could be defined as a macro
30763 like this:
30764 .code
30765 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30766                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30767                 }{$value}}
30768 .endd
30769 Suppose also that the senders who make use of BATV are defined by an address
30770 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30771 use this:
30772 .code
30773 # Bounces: drop unsigned addresses for BATV senders
30774 deny message = This address does not send an unsigned reverse path
30775      senders = :
30776      recipients = +batv_senders
30777
30778 # Bounces: In case of prvs-signed address, check signature.
30779 deny message = Invalid reverse path signature.
30780      senders = :
30781      condition  = ${prvscheck {$local_part@$domain}\
30782                   {PRVSCHECK_SQL}{1}}
30783      !condition = $prvscheck_result
30784 .endd
30785 The first statement rejects recipients for bounce messages that are addressed
30786 to plain BATV sender addresses, because it is known that BATV senders do not
30787 send out messages with plain sender addresses. The second statement rejects
30788 recipients that are prvs-signed, but with invalid signatures (either because
30789 the key is wrong, or the signature has timed out).
30790
30791 A non-prvs-signed address is not rejected by the second statement, because the
30792 &%prvscheck%& expansion yields an empty string if its first argument is not a
30793 prvs-signed address, thus causing the &%condition%& condition to be false. If
30794 the first argument is a syntactically valid prvs-signed address, the yield is
30795 the third string (in this case &"1"&), whether or not the cryptographic and
30796 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30797 of the checks (empty for failure, &"1"& for success).
30798
30799 There is one more issue you must consider when implementing prvs-signing:
30800 you have to ensure that the routers accept prvs-signed addresses and
30801 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30802 router to remove the signature with a configuration along these lines:
30803 .code
30804 batv_redirect:
30805   driver = redirect
30806   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30807 .endd
30808 This works because, if the third argument of &%prvscheck%& is empty, the result
30809 of the expansion of a prvs-signed address is the decoded value of the original
30810 address. This router should probably be the first of your routers that handles
30811 local addresses.
30812
30813 To create BATV-signed addresses in the first place, a transport of this form
30814 can be used:
30815 .code
30816 external_smtp_batv:
30817   driver = smtp
30818   return_path = ${prvs {$return_path} \
30819                        {${lookup mysql{SELECT \
30820                        secret FROM batv_prvs WHERE \
30821                        sender='${quote_mysql:$sender_address}'} \
30822                        {$value}fail}}}
30823 .endd
30824 If no key can be found for the existing return path, no signing takes place.
30825
30826
30827
30828 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30829 .cindex "&ACL;" "relay control"
30830 .cindex "relaying" "control by ACL"
30831 .cindex "policy control" "relay control"
30832 An MTA is said to &'relay'& a message if it receives it from some host and
30833 delivers it directly to another host as a result of a remote address contained
30834 within it. Redirecting a local address via an alias or forward file and then
30835 passing the message on to another host is not relaying,
30836 .cindex "&""percent hack""&"
30837 but a redirection as a result of the &"percent hack"& is.
30838
30839 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30840 A host which is acting as a gateway or an MX backup is concerned with incoming
30841 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30842 a host which is acting as a smart host for a number of clients is concerned
30843 with outgoing relaying from those clients to the Internet at large. Often the
30844 same host is fulfilling both functions,
30845 . ///
30846 . as illustrated in the diagram below,
30847 . ///
30848 but in principle these two kinds of relaying are entirely independent. What is
30849 not wanted is the transmission of mail from arbitrary remote hosts through your
30850 system to arbitrary domains.
30851
30852
30853 You can implement relay control by means of suitable statements in the ACL that
30854 runs for each RCPT command. For convenience, it is often easiest to use
30855 Exim's named list facility to define the domains and hosts involved. For
30856 example, suppose you want to do the following:
30857
30858 .ilist
30859 Deliver a number of domains to mailboxes on the local host (or process them
30860 locally in some other way). Let's say these are &'my.dom1.example'& and
30861 &'my.dom2.example'&.
30862 .next
30863 Relay mail for a number of other domains for which you are the secondary MX.
30864 These might be &'friend1.example'& and &'friend2.example'&.
30865 .next
30866 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30867 Suppose your LAN is 192.168.45.0/24.
30868 .endlist
30869
30870
30871 In the main part of the configuration, you put the following definitions:
30872 .code
30873 domainlist local_domains    = my.dom1.example : my.dom2.example
30874 domainlist relay_to_domains = friend1.example : friend2.example
30875 hostlist   relay_from_hosts = 192.168.45.0/24
30876 .endd
30877 Now you can use these definitions in the ACL that is run for every RCPT
30878 command:
30879 .code
30880 acl_check_rcpt:
30881   accept domains = +local_domains : +relay_to_domains
30882   accept hosts   = +relay_from_hosts
30883 .endd
30884 The first statement accepts any RCPT command that contains an address in
30885 the local or relay domains. For any other domain, control passes to the second
30886 statement, which accepts the command only if it comes from one of the relay
30887 hosts. In practice, you will probably want to make your ACL more sophisticated
30888 than this, for example, by including sender and recipient verification. The
30889 default configuration includes a more comprehensive example, which is described
30890 in chapter &<<CHAPdefconfil>>&.
30891
30892
30893
30894 .section "Checking a relay configuration" "SECTcheralcon"
30895 .cindex "relaying" "checking control of"
30896 You can check the relay characteristics of your configuration in the same way
30897 that you can test any ACL behaviour for an incoming SMTP connection, by using
30898 the &%-bh%& option to run a fake SMTP session with which you interact.
30899
30900 For specifically testing for unwanted relaying, the host
30901 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30902 host from the host on which Exim is running, using the normal telnet port, you
30903 will see a normal telnet connection message and then quite a long delay. Be
30904 patient. The remote host is making an SMTP connection back to your host, and
30905 trying a number of common probes to test for open relay vulnerability. The
30906 results of the tests will eventually appear on your terminal.
30907 .ecindex IIDacl
30908
30909
30910
30911 . ////////////////////////////////////////////////////////////////////////////
30912 . ////////////////////////////////////////////////////////////////////////////
30913
30914 .chapter "Content scanning at ACL time" "CHAPexiscan"
30915 .scindex IIDcosca "content scanning" "at ACL time"
30916 The extension of Exim to include content scanning at ACL time, formerly known
30917 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30918 was integrated into the main source for Exim release 4.50, and Tom continues to
30919 maintain it. Most of the wording of this chapter is taken from Tom's
30920 specification.
30921
30922 It is also possible to scan the content of messages at other times. The
30923 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30924 scanning after all the ACLs have run. A transport filter can be used to scan
30925 messages at delivery time (see the &%transport_filter%& option, described in
30926 chapter &<<CHAPtransportgeneric>>&).
30927
30928 If you want to include the ACL-time content-scanning features when you compile
30929 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30930 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30931
30932 .ilist
30933 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30934 for all MIME parts for SMTP and non-SMTP messages, respectively.
30935 .next
30936 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30937 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30938 run at the end of message reception (the &%acl_smtp_data%& ACL).
30939 .next
30940 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30941 of messages, or parts of messages, for debugging purposes.
30942 .next
30943 Additional expansion variables that are set in the new ACL and by the new
30944 conditions.
30945 .next
30946 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30947 .endlist
30948
30949 There is another content-scanning configuration option for &_Local/Makefile_&,
30950 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30951 condition is compiled, in addition to all the other content-scanning features.
30952
30953 Content-scanning is continually evolving, and new features are still being
30954 added. While such features are still unstable and liable to incompatible
30955 changes, they are made available in Exim by setting options whose names begin
30956 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30957 this manual. You can find out about them by reading the file called
30958 &_doc/experimental.txt_&.
30959
30960 All the content-scanning facilities work on a MBOX copy of the message that is
30961 temporarily created in a file called:
30962 .display
30963 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30964 .endd
30965 The &_.eml_& extension is a friendly hint to virus scanners that they can
30966 expect an MBOX-like structure inside that file. The file is created when the
30967 first content scanning facility is called. Subsequent calls to content
30968 scanning conditions open the same file again. The directory is recursively
30969 removed when the &%acl_smtp_data%& ACL has finished running, unless
30970 .code
30971 control = no_mbox_unspool
30972 .endd
30973 has been encountered. When the MIME ACL decodes files, they are put into the
30974 same directory by default.
30975
30976
30977
30978 .section "Scanning for viruses" "SECTscanvirus"
30979 .cindex "virus scanning"
30980 .cindex "content scanning" "for viruses"
30981 .cindex "content scanning" "the &%malware%& condition"
30982 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30983 It supports a &"generic"& interface to scanners called via the shell, and
30984 specialized interfaces for &"daemon"& type virus scanners, which are resident
30985 in memory and thus are much faster.
30986
30987 A timeout of 2 minutes is applied to a scanner call (by default);
30988 if it expires then a defer action is taken.
30989
30990 .oindex "&%av_scanner%&"
30991 You can set the &%av_scanner%& option in the main part of the configuration
30992 to specify which scanner to use, together with any additional options that
30993 are needed. The basic syntax is as follows:
30994 .display
30995 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30996 .endd
30997 If you do not set &%av_scanner%&, it defaults to
30998 .code
30999 av_scanner = sophie:/var/run/sophie
31000 .endd
31001 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31002 before use.
31003 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31004 The following scanner types are supported in this release:
31005
31006 .vlist
31007 .vitem &%avast%&
31008 .cindex "virus scanners" "avast"
31009 This is the scanner daemon of Avast. It has been tested with Avast Core
31010 Security (currently at version 1.1.7).
31011 You can get a trial version at &url(http://www.avast.com) or for Linux
31012 at &url(http://www.avast.com/linux-server-antivirus).
31013 This scanner type takes one option,
31014 which can be either a full path to a UNIX socket,
31015 or host and port specifiers separated by white space.
31016 The host may be a name or an IP address; the port is either a
31017 single number or a pair of numbers with a dash between.
31018 Any further options are given, on separate lines,
31019 to the daemon as options before the main scan command.
31020 For example:
31021 .code
31022 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31023 av_scanner = avast:192.168.2.22 5036
31024 .endd
31025 If you omit the argument, the default path
31026 &_/var/run/avast/scan.sock_&
31027 is used.
31028 If you use a remote host,
31029 you need to make Exim's spool directory available to it,
31030 as the scanner is passed a file path, not file contents.
31031 For information about available commands and their options you may use
31032 .code
31033 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31034     FLAGS
31035     SENSITIVITY
31036     PACK
31037 .endd
31038
31039
31040 .vitem &%aveserver%&
31041 .cindex "virus scanners" "Kaspersky"
31042 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31043 at &url(http://www.kaspersky.com). This scanner type takes one option,
31044 which is the path to the daemon's UNIX socket. The default is shown in this
31045 example:
31046 .code
31047 av_scanner = aveserver:/var/run/aveserver
31048 .endd
31049
31050
31051 .vitem &%clamd%&
31052 .cindex "virus scanners" "clamd"
31053 This daemon-type scanner is GPL and free. You can get it at
31054 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31055 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31056 in the MIME ACL. This is no longer believed to be necessary.
31057
31058 The options are a list of server specifiers, which may be
31059 a UNIX socket specification,
31060 a TCP socket specification,
31061 or a (global) option.
31062
31063 A socket specification consists of a space-separated list.
31064 For a Unix socket the first element is a full path for the socket,
31065 for a TCP socket the first element is the IP address
31066 and the second a port number,
31067 Any further elements are per-server (non-global) options.
31068 These per-server options are supported:
31069 .code
31070 retry=<timespec>        Retry on connect fail
31071 .endd
31072
31073 The &`retry`& option specifies a time after which a single retry for
31074 a failed connect is made.  The default is to not retry.
31075
31076 If a Unix socket file is specified, only one server is supported.
31077
31078 Examples:
31079 .code
31080 av_scanner = clamd:/opt/clamd/socket
31081 av_scanner = clamd:192.0.2.3 1234
31082 av_scanner = clamd:192.0.2.3 1234:local
31083 av_scanner = clamd:192.0.2.3 1234 retry=10s
31084 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31085 .endd
31086 If the value of av_scanner points to a UNIX socket file or contains the
31087 &`local`&
31088 option, then the ClamAV interface will pass a filename containing the data
31089 to be scanned, which will should normally result in less I/O happening and be
31090 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31091 Exim does not assume that there is a common filesystem with the remote host.
31092 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31093 you be running a version of ClamAV prior to 0.95.
31094
31095 The final example shows that multiple TCP targets can be specified.  Exim will
31096 randomly use one for each incoming email (i.e. it load balances them).  Note
31097 that only TCP targets may be used if specifying a list of scanners; a UNIX
31098 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31099 unavailable, Exim will try the remaining one(s) until it finds one that works.
31100 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31101 not keep track of scanner state between multiple messages, and the scanner
31102 selection is random, so the message will get logged in the mainlog for each
31103 email that the down scanner gets chosen first (message wrapped to be readable):
31104 .code
31105 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31106    clamd: connection to localhost, port 3310 failed
31107    (Connection refused)
31108 .endd
31109
31110 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31111 contributing the code for this scanner.
31112
31113 .vitem &%cmdline%&
31114 .cindex "virus scanners" "command line interface"
31115 This is the keyword for the generic command line scanner interface. It can be
31116 used to attach virus scanners that are invoked from the shell. This scanner
31117 type takes 3 mandatory options:
31118
31119 .olist
31120 The full path and name of the scanner binary, with all command line options,
31121 and a placeholder (&`%s`&) for the directory to scan.
31122
31123 .next
31124 A regular expression to match against the STDOUT and STDERR output of the
31125 virus scanner. If the expression matches, a virus was found. You must make
31126 absolutely sure that this expression matches on &"virus found"&. This is called
31127 the &"trigger"& expression.
31128
31129 .next
31130 Another regular expression, containing exactly one pair of parentheses, to
31131 match the name of the virus found in the scanners output. This is called the
31132 &"name"& expression.
31133 .endlist olist
31134
31135 For example, Sophos Sweep reports a virus on a line like this:
31136 .code
31137 Virus 'W32/Magistr-B' found in file ./those.bat
31138 .endd
31139 For the trigger expression, we can match the phrase &"found in file"&. For the
31140 name expression, we want to extract the W32/Magistr-B string, so we can match
31141 for the single quotes left and right of it. Altogether, this makes the
31142 configuration setting:
31143 .code
31144 av_scanner = cmdline:\
31145              /path/to/sweep -ss -all -rec -archive %s:\
31146              found in file:'(.+)'
31147 .endd
31148 .vitem &%drweb%&
31149 .cindex "virus scanners" "DrWeb"
31150 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31151 takes one option,
31152 either a full path to a UNIX socket,
31153 or host and port specifiers separated by white space.
31154 The host may be a name or an IP address; the port is either a
31155 single number or a pair of numbers with a dash between.
31156 For example:
31157 .code
31158 av_scanner = drweb:/var/run/drwebd.sock
31159 av_scanner = drweb:192.168.2.20 31337
31160 .endd
31161 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31162 is used. Thanks to Alex Miller for contributing the code for this scanner.
31163
31164 .vitem &%f-protd%&
31165 .cindex "virus scanners" "f-protd"
31166 The f-protd scanner is accessed via HTTP over TCP.
31167 One argument is taken, being a space-separated hostname and port number
31168 (or port-range).
31169 For example:
31170 .code
31171 av_scanner = f-protd:localhost 10200-10204
31172 .endd
31173 If you omit the argument, the default values show above are used.
31174
31175 .vitem &%fsecure%&
31176 .cindex "virus scanners" "F-Secure"
31177 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31178 argument which is the path to a UNIX socket. For example:
31179 .code
31180 av_scanner = fsecure:/path/to/.fsav
31181 .endd
31182 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31183 Thelmen for contributing the code for this scanner.
31184
31185 .vitem &%kavdaemon%&
31186 .cindex "virus scanners" "Kaspersky"
31187 This is the scanner daemon of Kaspersky Version 4. This version of the
31188 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31189 scanner type takes one option, which is the path to the daemon's UNIX socket.
31190 For example:
31191 .code
31192 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31193 .endd
31194 The default path is &_/var/run/AvpCtl_&.
31195
31196 .vitem &%mksd%&
31197 .cindex "virus scanners" "mksd"
31198 This is a daemon type scanner that is aimed mainly at Polish users, though some
31199 parts of documentation are now available in English. You can get it at
31200 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31201 the maximum number of processes used simultaneously to scan the attachments,
31202 provided that the demime facility is employed and also provided that mksd has
31203 been run with at least the same number of child processes. For example:
31204 .code
31205 av_scanner = mksd:2
31206 .endd
31207 You can safely omit this option (the default value is 1).
31208
31209 .vitem &%sock%&
31210 .cindex "virus scanners" "simple socket-connected"
31211 This is a general-purpose way of talking to simple scanner daemons
31212 running on the local machine.
31213 There are four options:
31214 an address (which may be an IP address and port, or the path of a Unix socket),
31215 a commandline to send (may include a single %s which will be replaced with
31216 the path to the mail file to be scanned),
31217 an RE to trigger on from the returned data,
31218 an RE to extract malware_name from the returned data.
31219 For example:
31220 .code
31221 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31222 .endd
31223 Default for the socket specifier is &_/tmp/malware.sock_&.
31224 Default for the commandline is &_%s\n_&.
31225 Both regular-expressions are required.
31226
31227 .vitem &%sophie%&
31228 .cindex "virus scanners" "Sophos and Sophie"
31229 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31230 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31231 for this scanner type is the path to the UNIX socket that Sophie uses for
31232 client communication. For example:
31233 .code
31234 av_scanner = sophie:/tmp/sophie
31235 .endd
31236 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31237 the option.
31238 .endlist
31239
31240 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31241 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31242 ACL.
31243
31244 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31245 makes it possible to use different scanners. See further below for an example.
31246 The &%malware%& condition caches its results, so when you use it multiple times
31247 for the same message, the actual scanning process is only carried out once.
31248 However, using expandable items in &%av_scanner%& disables this caching, in
31249 which case each use of the &%malware%& condition causes a new scan of the
31250 message.
31251
31252 The &%malware%& condition takes a right-hand argument that is expanded before
31253 use and taken as a list, slash-separated by default.
31254 The first element can then be one of
31255
31256 .ilist
31257 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31258 The condition succeeds if a virus was found, and fail otherwise. This is the
31259 recommended usage.
31260 .next
31261 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31262 the condition fails immediately.
31263 .next
31264 A regular expression, in which case the message is scanned for viruses. The
31265 condition succeeds if a virus is found and its name matches the regular
31266 expression. This allows you to take special actions on certain types of virus.
31267 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31268 unless the separator is changed (in the usual way).
31269 .endlist
31270
31271 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31272 messages even if there is a problem with the virus scanner.
31273 Otherwise, such a problem causes the ACL to defer.
31274
31275 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31276 specify a non-default timeout.  The default is two minutes.
31277 For example:
31278 .code
31279 malware = * / defer_ok / tmo=10s
31280 .endd
31281 A timeout causes the ACL to defer.
31282
31283 .vindex "&$callout_address$&"
31284 When a connection is made to the scanner the expansion variable &$callout_address$&
31285 is set to record the actual address used.
31286
31287 .vindex "&$malware_name$&"
31288 When a virus is found, the condition sets up an expansion variable called
31289 &$malware_name$& that contains the name of the virus. You can use it in a
31290 &%message%& modifier that specifies the error returned to the sender, and/or in
31291 logging data.
31292
31293 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
31294 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
31295 &%malware%& condition.
31296
31297 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31298 imposed by your anti-virus scanner.
31299
31300 Here is a very simple scanning example:
31301 .code
31302 deny message = This message contains malware ($malware_name)
31303      demime = *
31304      malware = *
31305 .endd
31306 The next example accepts messages when there is a problem with the scanner:
31307 .code
31308 deny message = This message contains malware ($malware_name)
31309      demime = *
31310      malware = */defer_ok
31311 .endd
31312 The next example shows how to use an ACL variable to scan with both sophie and
31313 aveserver. It assumes you have set:
31314 .code
31315 av_scanner = $acl_m0
31316 .endd
31317 in the main Exim configuration.
31318 .code
31319 deny message = This message contains malware ($malware_name)
31320      set acl_m0 = sophie
31321      malware = *
31322
31323 deny message = This message contains malware ($malware_name)
31324      set acl_m0 = aveserver
31325      malware = *
31326 .endd
31327
31328
31329 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31330 .cindex "content scanning" "for spam"
31331 .cindex "spam scanning"
31332 .cindex "SpamAssassin"
31333 .cindex "Rspamd"
31334 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31335 score and a report for the message.
31336 Support is also provided for Rspamd.
31337
31338 For more information about installation and configuration of SpamAssassin or
31339 Rspamd refer to their respective websites at
31340 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31341
31342 SpamAssassin can be installed with CPAN by running:
31343 .code
31344 perl -MCPAN -e 'install Mail::SpamAssassin'
31345 .endd
31346 SpamAssassin has its own set of configuration files. Please review its
31347 documentation to see how you can tweak it. The default installation should work
31348 nicely, however.
31349
31350 .oindex "&%spamd_address%&"
31351 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31352 intend to use an instance running on the local host you do not need to set
31353 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31354 you must set the &%spamd_address%& option in the global part of the Exim
31355 configuration as follows (example):
31356 .code
31357 spamd_address = 192.168.99.45 387
31358 .endd
31359
31360 To use Rspamd (which by default listens on all local addresses
31361 on TCP port 11333)
31362 you should add &%variant=rspamd%& after the address/port pair, for example:
31363 .code
31364 spamd_address = 127.0.0.1 11333 variant=rspamd
31365 .endd
31366
31367 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31368 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31369 file name instead of an address/port pair:
31370 .code
31371 spamd_address = /var/run/spamd_socket
31372 .endd
31373 You can have multiple &%spamd%& servers to improve scalability. These can
31374 reside on other hardware reachable over the network. To specify multiple
31375 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31376 option, separated with colons (the separator can be changed in the usual way):
31377 .code
31378 spamd_address = 192.168.2.10 783 : \
31379                 192.168.2.11 783 : \
31380                 192.168.2.12 783
31381 .endd
31382 Up to 32 &%spamd%& servers are supported.
31383 When a server fails to respond to the connection attempt, all other
31384 servers are tried until one succeeds. If no server responds, the &%spam%&
31385 condition defers.
31386
31387 Unix and TCP socket specifications may be mixed in any order.
31388 Each element of the list is a list itself, space-separated by default
31389 and changeable in the usual way.
31390
31391 For TCP socket specifications a host name or IP (v4 or v6, but
31392 subject to list-separator quoting rules) address can be used,
31393 and the port can be one or a dash-separated pair.
31394 In the latter case, the range is tried in strict order.
31395
31396 Elements after the first for Unix sockets, or second for TCP socket,
31397 are options.
31398 The supported options are:
31399 .code
31400 pri=<priority>      Selection priority
31401 weight=<value>      Selection bias
31402 time=<start>-<end>  Use only between these times of day
31403 retry=<timespec>    Retry on connect fail
31404 tmo=<timespec>      Connection time limit
31405 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31406 .endd
31407
31408 The &`pri`& option specifies a priority for the server within the list,
31409 higher values being tried first.
31410 The default priority is 1.
31411
31412 The &`weight`& option specifies a selection bias.
31413 Within a priority set
31414 servers are queried in a random fashion, weighted by this value.
31415 The default value for selection bias is 1.
31416
31417 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31418 in the local time zone; each element being one or more digits.
31419 Either the seconds or both minutes and seconds, plus the leading &`.`&
31420 characters, may be omitted and will be taken as zero.
31421
31422 Timeout specifications for the &`retry`& and &`tmo`& options
31423 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31424
31425 The &`tmo`& option specifies an overall timeout for communication.
31426 The default value is two minutes.
31427
31428 The &`retry`& option specifies a time after which a single retry for
31429 a failed connect is made.
31430 The default is to not retry.
31431
31432 The &%spamd_address%& variable is expanded before use if it starts with
31433 a dollar sign. In this case, the expansion may return a string that is
31434 used as the list so that multiple spamd servers can be the result of an
31435 expansion.
31436
31437 .vindex "&$callout_address$&"
31438 When a connection is made to the server the expansion variable &$callout_address$&
31439 is set to record the actual address used.
31440
31441 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31442 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31443 .code
31444 deny message = This message was classified as SPAM
31445      spam = joe
31446 .endd
31447 The right-hand side of the &%spam%& condition specifies a name. This is
31448 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31449 to scan using a specific profile, but rather use the SpamAssassin system-wide
31450 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31451 Rspamd does not use this setting. However, you must put something on the
31452 right-hand side.
31453
31454 The name allows you to use per-domain or per-user antispam profiles in
31455 principle, but this is not straightforward in practice, because a message may
31456 have multiple recipients, not necessarily all in the same domain. Because the
31457 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31458 read the contents of the message, the variables &$local_part$& and &$domain$&
31459 are not set.
31460 Careful enforcement of single-recipient messages
31461 (e.g. by responding with defer in the recipient ACL for all recipients
31462 after the first),
31463 or the use of PRDR,
31464 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31465 are needed to use this feature.
31466
31467 The right-hand side of the &%spam%& condition is expanded before being used, so
31468 you can put lookups or conditions there. When the right-hand side evaluates to
31469 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31470
31471
31472 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31473 large ones may cause significant performance degradation. As most spam messages
31474 are quite small, it is recommended that you do not scan the big ones. For
31475 example:
31476 .code
31477 deny message = This message was classified as SPAM
31478      condition = ${if < {$message_size}{10K}}
31479      spam = nobody
31480 .endd
31481
31482 The &%spam%& condition returns true if the threshold specified in the user's
31483 SpamAssassin profile has been matched or exceeded. If you want to use the
31484 &%spam%& condition for its side effects (see the variables below), you can make
31485 it always return &"true"& by appending &`:true`& to the username.
31486
31487 .cindex "spam scanning" "returned variables"
31488 When the &%spam%& condition is run, it sets up a number of expansion
31489 variables.
31490 Except for &$spam_report$&,
31491 these variables are saved with the received message so are
31492 available for use at delivery time.
31493
31494 .vlist
31495 .vitem &$spam_score$&
31496 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31497 for inclusion in log or reject messages.
31498
31499 .vitem &$spam_score_int$&
31500 The spam score of the message, multiplied by ten, as an integer value. For
31501 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31502 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31503 The integer value is useful for numeric comparisons in conditions.
31504
31505 .vitem &$spam_bar$&
31506 A string consisting of a number of &"+"& or &"-"& characters, representing the
31507 integer part of the spam score value. A spam score of 4.4 would have a
31508 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31509 headers, since MUAs can match on such strings. The maximum length of the
31510 spam bar is 50 characters.
31511
31512 .vitem &$spam_report$&
31513 A multiline text table, containing the full SpamAssassin report for the
31514 message. Useful for inclusion in headers or reject messages.
31515 This variable is only usable in a DATA-time ACL.
31516
31517 .vitem &$spam_action$&
31518 For SpamAssassin either 'reject' or 'no action' depending on the
31519 spam score versus threshold.
31520 For Rspamd, the recommended action.
31521
31522 .endlist
31523
31524 The &%spam%& condition caches its results unless expansion in
31525 spamd_address was used. If you call it again with the same user name, it
31526 does not scan again, but rather returns the same values as before.
31527
31528 The &%spam%& condition returns DEFER if there is any error while running
31529 the message through SpamAssassin or if the expansion of spamd_address
31530 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31531 statement block), append &`/defer_ok`& to the right-hand side of the
31532 spam condition, like this:
31533 .code
31534 deny message = This message was classified as SPAM
31535      spam    = joe/defer_ok
31536 .endd
31537 This causes messages to be accepted even if there is a problem with &%spamd%&.
31538
31539 Here is a longer, commented example of the use of the &%spam%&
31540 condition:
31541 .code
31542 # put headers in all messages (no matter if spam or not)
31543 warn  spam = nobody:true
31544       add_header = X-Spam-Score: $spam_score ($spam_bar)
31545       add_header = X-Spam-Report: $spam_report
31546
31547 # add second subject line with *SPAM* marker when message
31548 # is over threshold
31549 warn  spam = nobody
31550       add_header = Subject: *SPAM* $h_Subject:
31551
31552 # reject spam at high scores (> 12)
31553 deny  message = This message scored $spam_score spam points.
31554       spam = nobody:true
31555       condition = ${if >{$spam_score_int}{120}{1}{0}}
31556 .endd
31557
31558
31559
31560 .section "Scanning MIME parts" "SECTscanmimepart"
31561 .cindex "content scanning" "MIME parts"
31562 .cindex "MIME content scanning"
31563 .oindex "&%acl_smtp_mime%&"
31564 .oindex "&%acl_not_smtp_mime%&"
31565 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31566 each MIME part of an SMTP message, including multipart types, in the sequence
31567 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31568 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31569 options may both refer to the same ACL if you want the same processing in both
31570 cases.
31571
31572 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31573 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31574 the case of a non-SMTP message. However, a MIME ACL is called only if the
31575 message contains a &'Content-Type:'& header line. When a call to a MIME
31576 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31577 result code is sent to the client. In the case of an SMTP message, the
31578 &%acl_smtp_data%& ACL is not called when this happens.
31579
31580 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31581 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31582 condition to match against the raw MIME part. You can also use the
31583 &%mime_regex%& condition to match against the decoded MIME part (see section
31584 &<<SECTscanregex>>&).
31585
31586 At the start of a MIME ACL, a number of variables are set from the header
31587 information for the relevant MIME part. These are described below. The contents
31588 of the MIME part are not by default decoded into a disk file except for MIME
31589 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31590 part into a disk file, you can use the &%decode%& condition. The general
31591 syntax is:
31592 .display
31593 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31594 .endd
31595 The right hand side is expanded before use. After expansion,
31596 the value can be:
31597
31598 .olist
31599 &"0"& or &"false"&, in which case no decoding is done.
31600 .next
31601 The string &"default"&. In that case, the file is put in the temporary
31602 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31603 a sequential file name consisting of the message id and a sequence number. The
31604 full path and name is available in &$mime_decoded_filename$& after decoding.
31605 .next
31606 A full path name starting with a slash. If the full name is an existing
31607 directory, it is used as a replacement for the default directory. The filename
31608 is then sequentially assigned. If the path does not exist, it is used as
31609 the full path and file name.
31610 .next
31611 If the string does not start with a slash, it is used as the
31612 filename, and the default path is then used.
31613 .endlist
31614 The &%decode%& condition normally succeeds. It is only false for syntax
31615 errors or unusual circumstances such as memory shortages. You can easily decode
31616 a file with its original, proposed filename using
31617 .code
31618 decode = $mime_filename
31619 .endd
31620 However, you should keep in mind that &$mime_filename$& might contain
31621 anything. If you place files outside of the default path, they are not
31622 automatically unlinked.
31623
31624 For RFC822 attachments (these are messages attached to messages, with a
31625 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31626 as for the primary message, only that the &$mime_is_rfc822$& expansion
31627 variable is set (see below). Attached messages are always decoded to disk
31628 before being checked, and the files are unlinked once the check is done.
31629
31630 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31631 used to match regular expressions against raw and decoded MIME parts,
31632 respectively. They are described in section &<<SECTscanregex>>&.
31633
31634 .cindex "MIME content scanning" "returned variables"
31635 The following list describes all expansion variables that are
31636 available in the MIME ACL:
31637
31638 .vlist
31639 .vitem &$mime_boundary$&
31640 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31641 have a boundary string, which is stored in this variable. If the current part
31642 has no boundary parameter in the &'Content-Type:'& header, this variable
31643 contains the empty string.
31644
31645 .vitem &$mime_charset$&
31646 This variable contains the character set identifier, if one was found in the
31647 &'Content-Type:'& header. Examples for charset identifiers are:
31648 .code
31649 us-ascii
31650 gb2312 (Chinese)
31651 iso-8859-1
31652 .endd
31653 Please note that this value is not normalized, so you should do matches
31654 case-insensitively.
31655
31656 .vitem &$mime_content_description$&
31657 This variable contains the normalized content of the &'Content-Description:'&
31658 header. It can contain a human-readable description of the parts content. Some
31659 implementations repeat the filename for attachments here, but they are usually
31660 only used for display purposes.
31661
31662 .vitem &$mime_content_disposition$&
31663 This variable contains the normalized content of the &'Content-Disposition:'&
31664 header. You can expect strings like &"attachment"& or &"inline"& here.
31665
31666 .vitem &$mime_content_id$&
31667 This variable contains the normalized content of the &'Content-ID:'& header.
31668 This is a unique ID that can be used to reference a part from another part.
31669
31670 .vitem &$mime_content_size$&
31671 This variable is set only after the &%decode%& modifier (see above) has been
31672 successfully run. It contains the size of the decoded part in kilobytes. The
31673 size is always rounded up to full kilobytes, so only a completely empty part
31674 has a &$mime_content_size$& of zero.
31675
31676 .vitem &$mime_content_transfer_encoding$&
31677 This variable contains the normalized content of the
31678 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31679 type. Typical values are &"base64"& and &"quoted-printable"&.
31680
31681 .vitem &$mime_content_type$&
31682 If the MIME part has a &'Content-Type:'& header, this variable contains its
31683 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31684 are some examples of popular MIME types, as they may appear in this variable:
31685 .code
31686 text/plain
31687 text/html
31688 application/octet-stream
31689 image/jpeg
31690 audio/midi
31691 .endd
31692 If the MIME part has no &'Content-Type:'& header, this variable contains the
31693 empty string.
31694
31695 .vitem &$mime_decoded_filename$&
31696 This variable is set only after the &%decode%& modifier (see above) has been
31697 successfully run. It contains the full path and file name of the file
31698 containing the decoded data.
31699 .endlist
31700
31701 .cindex "RFC 2047"
31702 .vlist
31703 .vitem &$mime_filename$&
31704 This is perhaps the most important of the MIME variables. It contains a
31705 proposed filename for an attachment, if one was found in either the
31706 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31707 RFC2047
31708 or RFC2231
31709 decoded, but no additional sanity checks are done.
31710  If no filename was
31711 found, this variable contains the empty string.
31712
31713 .vitem &$mime_is_coverletter$&
31714 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31715 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31716 content in the cover letter, while not restricting attachments at all.
31717
31718 The variable contains 1 (true) for a MIME part believed to be part of the
31719 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31720 follows:
31721
31722 .olist
31723 The outermost MIME part of a message is always a cover letter.
31724
31725 .next
31726 If a multipart/alternative or multipart/related MIME part is a cover letter,
31727 so are all MIME subparts within that multipart.
31728
31729 .next
31730 If any other multipart is a cover letter, the first subpart is a cover letter,
31731 and the rest are attachments.
31732
31733 .next
31734 All parts contained within an attachment multipart are attachments.
31735 .endlist olist
31736
31737 As an example, the following will ban &"HTML mail"& (including that sent with
31738 alternative plain text), while allowing HTML files to be attached. HTML
31739 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31740 .code
31741 deny message = HTML mail is not accepted here
31742 !condition = $mime_is_rfc822
31743 condition = $mime_is_coverletter
31744 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31745 .endd
31746 .vitem &$mime_is_multipart$&
31747 This variable has the value 1 (true) when the current part has the main type
31748 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31749 Since multipart entities only serve as containers for other parts, you may not
31750 want to carry out specific actions on them.
31751
31752 .vitem &$mime_is_rfc822$&
31753 This variable has the value 1 (true) if the current part is not a part of the
31754 checked message itself, but part of an attached message. Attached message
31755 decoding is fully recursive.
31756
31757 .vitem &$mime_part_count$&
31758 This variable is a counter that is raised for each processed MIME part. It
31759 starts at zero for the very first part (which is usually a multipart). The
31760 counter is per-message, so it is reset when processing RFC822 attachments (see
31761 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31762 complete, so you can use it in the DATA ACL to determine the number of MIME
31763 parts of a message. For non-MIME messages, this variable contains the value -1.
31764 .endlist
31765
31766
31767
31768 .section "Scanning with regular expressions" "SECTscanregex"
31769 .cindex "content scanning" "with regular expressions"
31770 .cindex "regular expressions" "content scanning with"
31771 You can specify your own custom regular expression matches on the full body of
31772 the message, or on individual MIME parts.
31773
31774 The &%regex%& condition takes one or more regular expressions as arguments and
31775 matches them against the full message (when called in the DATA ACL) or a raw
31776 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31777 linewise, with a maximum line length of 32K characters. That means you cannot
31778 have multiline matches with the &%regex%& condition.
31779
31780 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31781 to 32K of decoded content (the whole content at once, not linewise). If the
31782 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31783 is decoded automatically when &%mime_regex%& is executed (using default path
31784 and filename values). If the decoded data is larger than  32K, only the first
31785 32K characters are checked.
31786
31787 The regular expressions are passed as a colon-separated list. To include a
31788 literal colon, you must double it. Since the whole right-hand side string is
31789 expanded before being used, you must also escape dollar signs and backslashes
31790 with more backslashes, or use the &`\N`& facility to disable expansion.
31791 Here is a simple example that contains two regular expressions:
31792 .code
31793 deny message = contains blacklisted regex ($regex_match_string)
31794      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31795 .endd
31796 The conditions returns true if any one of the regular expressions matches. The
31797 &$regex_match_string$& expansion variable is then set up and contains the
31798 matching regular expression.
31799 The expansion variables &$regex1$& &$regex2$& etc
31800 are set to any substrings captured by the regular expression.
31801
31802 &*Warning*&: With large messages, these conditions can be fairly
31803 CPU-intensive.
31804
31805
31806
31807
31808 .section "The demime condition" "SECTdemimecond"
31809 .cindex "content scanning" "MIME checking"
31810 .cindex "MIME content scanning"
31811 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31812 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31813 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31814 ACL functionality, but provides no additional facilities. Please note that this
31815 condition is deprecated and kept only for backward compatibility. You must set
31816 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31817 use the &%demime%& condition.
31818
31819 The &%demime%& condition unpacks MIME containers in the message. It detects
31820 errors in MIME containers and can match file extensions found in the message
31821 against a list. Using this facility produces files containing the unpacked MIME
31822 parts of the message in the temporary scan directory. If you do antivirus
31823 scanning, it is recommended that you use the &%demime%& condition before the
31824 antivirus (&%malware%&) condition.
31825
31826 On the right-hand side of the &%demime%& condition you can pass a
31827 colon-separated list of file extensions that it should match against. For
31828 example:
31829 .code
31830 deny message = Found blacklisted file attachment
31831      demime  = vbs:com:bat:pif:prf:lnk
31832 .endd
31833 If one of the file extensions is found, the condition is true, otherwise it is
31834 false. If there is a temporary error while demimeing (for example, &"disk
31835 full"&), the condition defers, and the message is temporarily rejected (unless
31836 the condition is on a &%warn%& verb).
31837
31838 The right-hand side is expanded before being treated as a list, so you can have
31839 conditions and lookups there. If it expands to an empty string, &"false"&, or
31840 zero (&"0"&), no demimeing is done and the condition is false.
31841
31842 The &%demime%& condition set the following variables:
31843
31844 .vlist
31845 .vitem &$demime_errorlevel$&
31846 .vindex "&$demime_errorlevel$&"
31847 When an error is detected in a MIME container, this variable contains the
31848 severity of the error, as an integer number. The higher the value, the more
31849 severe the error (the current maximum value is 3). If this variable is unset or
31850 zero, no error occurred.
31851
31852 .vitem &$demime_reason$&
31853 .vindex "&$demime_reason$&"
31854 When &$demime_errorlevel$& is greater than zero, this variable contains a
31855 human-readable text string describing the MIME error that occurred.
31856 .endlist
31857
31858 .vlist
31859 .vitem &$found_extension$&
31860 .vindex "&$found_extension$&"
31861 When the &%demime%& condition is true, this variable contains the file
31862 extension it found.
31863 .endlist
31864
31865 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31866 the &%demime%& condition, and are not changed on subsequent calls.
31867
31868 If you do not want to check for file extensions, but rather use the &%demime%&
31869 condition for unpacking or error checking purposes, pass &"*"& as the
31870 right-hand side value. Here is a more elaborate example of how to use this
31871 facility:
31872 .code
31873 # Reject messages with serious MIME container errors
31874 deny  message = Found MIME error ($demime_reason).
31875       demime = *
31876       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31877
31878 # Reject known virus spreading file extensions.
31879 # Accepting these is pretty much braindead.
31880 deny  message = contains $found_extension file (blacklisted).
31881       demime  = com:vbs:bat:pif:scr
31882
31883 # Freeze .exe and .doc files. Postmaster can
31884 # examine them and eventually thaw them.
31885 deny  log_message = Another $found_extension file.
31886       demime = exe:doc
31887       control = freeze
31888 .endd
31889 .ecindex IIDcosca
31890
31891
31892
31893
31894 . ////////////////////////////////////////////////////////////////////////////
31895 . ////////////////////////////////////////////////////////////////////////////
31896
31897 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31898          "Local scan function"
31899 .scindex IIDlosca "&[local_scan()]& function" "description of"
31900 .cindex "customizing" "input scan using C function"
31901 .cindex "policy control" "by local scan function"
31902 In these days of email worms, viruses, and ever-increasing spam, some sites
31903 want to apply a lot of checking to messages before accepting them.
31904
31905 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31906 passing messages to external virus and spam scanning software. You can also do
31907 a certain amount in Exim itself through string expansions and the &%condition%&
31908 condition in the ACL that runs after the SMTP DATA command or the ACL for
31909 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31910
31911 To allow for further customization to a site's own requirements, there is the
31912 possibility of linking Exim with a private message scanning function, written
31913 in C. If you want to run code that is written in something other than C, you
31914 can of course use a little C stub to call it.
31915
31916 The local scan function is run once for every incoming message, at the point
31917 when Exim is just about to accept the message.
31918 It can therefore be used to control non-SMTP messages from local processes as
31919 well as messages arriving via SMTP.
31920
31921 Exim applies a timeout to calls of the local scan function, and there is an
31922 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31923 Zero means &"no timeout"&.
31924 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31925 before calling the local scan function, so that the most common types of crash
31926 are caught. If the timeout is exceeded or one of those signals is caught, the
31927 incoming message is rejected with a temporary error if it is an SMTP message.
31928 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31929 code. The incident is logged on the main and reject logs.
31930
31931
31932
31933 .section "Building Exim to use a local scan function" "SECID207"
31934 .cindex "&[local_scan()]& function" "building Exim to use"
31935 To make use of the local scan function feature, you must tell Exim where your
31936 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31937 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31938 directory, so you might set
31939 .code
31940 LOCAL_SCAN_SOURCE=Local/local_scan.c
31941 .endd
31942 for example. The function must be called &[local_scan()]&. It is called by
31943 Exim after it has received a message, when the success return code is about to
31944 be sent. This is after all the ACLs have been run. The return code from your
31945 function controls whether the message is actually accepted or not. There is a
31946 commented template function (that just accepts the message) in the file
31947 _src/local_scan.c_.
31948
31949 If you want to make use of Exim's run time configuration file to set options
31950 for your &[local_scan()]& function, you must also set
31951 .code
31952 LOCAL_SCAN_HAS_OPTIONS=yes
31953 .endd
31954 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31955
31956
31957
31958
31959 .section "API for local_scan()" "SECTapiforloc"
31960 .cindex "&[local_scan()]& function" "API description"
31961 You must include this line near the start of your code:
31962 .code
31963 #include "local_scan.h"
31964 .endd
31965 This header file defines a number of variables and other values, and the
31966 prototype for the function itself. Exim is coded to use unsigned char values
31967 almost exclusively, and one of the things this header defines is a shorthand
31968 for &`unsigned char`& called &`uschar`&.
31969 It also contains the following macro definitions, to simplify casting character
31970 strings and pointers to character strings:
31971 .code
31972 #define CS   (char *)
31973 #define CCS  (const char *)
31974 #define CSS  (char **)
31975 #define US   (unsigned char *)
31976 #define CUS  (const unsigned char *)
31977 #define USS  (unsigned char **)
31978 .endd
31979 The function prototype for &[local_scan()]& is:
31980 .code
31981 extern int local_scan(int fd, uschar **return_text);
31982 .endd
31983 The arguments are as follows:
31984
31985 .ilist
31986 &%fd%& is a file descriptor for the file that contains the body of the message
31987 (the -D file). The file is open for reading and writing, but updating it is not
31988 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31989
31990 The descriptor is positioned at character 19 of the file, which is the first
31991 character of the body itself, because the first 19 characters are the message
31992 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31993 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31994 case this changes in some future version.
31995 .next
31996 &%return_text%& is an address which you can use to return a pointer to a text
31997 string at the end of the function. The value it points to on entry is NULL.
31998 .endlist
31999
32000 The function must return an &%int%& value which is one of the following macros:
32001
32002 .vlist
32003 .vitem &`LOCAL_SCAN_ACCEPT`&
32004 .vindex "&$local_scan_data$&"
32005 The message is accepted. If you pass back a string of text, it is saved with
32006 the message, and made available in the variable &$local_scan_data$&. No
32007 newlines are permitted (if there are any, they are turned into spaces) and the
32008 maximum length of text is 1000 characters.
32009
32010 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32011 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32012 queued without immediate delivery, and is frozen.
32013
32014 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32015 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32016 queued without immediate delivery.
32017
32018 .vitem &`LOCAL_SCAN_REJECT`&
32019 The message is rejected; the returned text is used as an error message which is
32020 passed back to the sender and which is also logged. Newlines are permitted &--
32021 they cause a multiline response for SMTP rejections, but are converted to
32022 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32023 used.
32024
32025 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32026 The message is temporarily rejected; the returned text is used as an error
32027 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32028 problem"& is used.
32029
32030 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32031 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32032 message is not written to the reject log. It has the effect of unsetting the
32033 &%rejected_header%& log selector for just this rejection. If
32034 &%rejected_header%& is already unset (see the discussion of the
32035 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32036 same as LOCAL_SCAN_REJECT.
32037
32038 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32039 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32040 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32041 .endlist
32042
32043 If the message is not being received by interactive SMTP, rejections are
32044 reported by writing to &%stderr%& or by sending an email, as configured by the
32045 &%-oe%& command line options.
32046
32047
32048
32049 .section "Configuration options for local_scan()" "SECTconoptloc"
32050 .cindex "&[local_scan()]& function" "configuration options"
32051 It is possible to have option settings in the main configuration file
32052 that set values in static variables in the &[local_scan()]& module. If you
32053 want to do this, you must have the line
32054 .code
32055 LOCAL_SCAN_HAS_OPTIONS=yes
32056 .endd
32057 in your &_Local/Makefile_& when you build Exim. (This line is in
32058 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32059 file, you must define static variables to hold the option values, and a table
32060 to define them.
32061
32062 The table must be a vector called &%local_scan_options%&, of type
32063 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32064 and a pointer to the variable that holds the value. The entries must appear in
32065 alphabetical order. Following &%local_scan_options%& you must also define a
32066 variable called &%local_scan_options_count%& that contains the number of
32067 entries in the table. Here is a short example, showing two kinds of option:
32068 .code
32069 static int my_integer_option = 42;
32070 static uschar *my_string_option = US"a default string";
32071
32072 optionlist local_scan_options[] = {
32073   { "my_integer", opt_int,       &my_integer_option },
32074   { "my_string",  opt_stringptr, &my_string_option }
32075 };
32076
32077 int local_scan_options_count =
32078   sizeof(local_scan_options)/sizeof(optionlist);
32079 .endd
32080 The values of the variables can now be changed from Exim's runtime
32081 configuration file by including a local scan section as in this example:
32082 .code
32083 begin local_scan
32084 my_integer = 99
32085 my_string = some string of text...
32086 .endd
32087 The available types of option data are as follows:
32088
32089 .vlist
32090 .vitem &*opt_bool*&
32091 This specifies a boolean (true/false) option. The address should point to a
32092 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32093 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32094 whether such a variable has been set at all, you can initialize it to
32095 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32096 values.)
32097
32098 .vitem &*opt_fixed*&
32099 This specifies a fixed point number, such as is used for load averages.
32100 The address should point to a variable of type &`int`&. The value is stored
32101 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32102
32103 .vitem &*opt_int*&
32104 This specifies an integer; the address should point to a variable of type
32105 &`int`&. The value may be specified in any of the integer formats accepted by
32106 Exim.
32107
32108 .vitem &*opt_mkint*&
32109 This is the same as &%opt_int%&, except that when such a value is output in a
32110 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32111 printed with the suffix K or M.
32112
32113 .vitem &*opt_octint*&
32114 This also specifies an integer, but the value is always interpreted as an
32115 octal integer, whether or not it starts with the digit zero, and it is
32116 always output in octal.
32117
32118 .vitem &*opt_stringptr*&
32119 This specifies a string value; the address must be a pointer to a
32120 variable that points to a string (for example, of type &`uschar *`&).
32121
32122 .vitem &*opt_time*&
32123 This specifies a time interval value. The address must point to a variable of
32124 type &`int`&. The value that is placed there is a number of seconds.
32125 .endlist
32126
32127 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32128 out the values of all the &[local_scan()]& options.
32129
32130
32131
32132 .section "Available Exim variables" "SECID208"
32133 .cindex "&[local_scan()]& function" "available Exim variables"
32134 The header &_local_scan.h_& gives you access to a number of C variables. These
32135 are the only ones that are guaranteed to be maintained from release to release.
32136 Note, however, that you can obtain the value of any Exim expansion variable,
32137 including &$recipients$&, by calling &'expand_string()'&. The exported
32138 C variables are as follows:
32139
32140 .vlist
32141 .vitem &*int&~body_linecount*&
32142 This variable contains the number of lines in the message's body.
32143
32144 .vitem &*int&~body_zerocount*&
32145 This variable contains the number of binary zero bytes in the message's body.
32146
32147 .vitem &*unsigned&~int&~debug_selector*&
32148 This variable is set to zero when no debugging is taking place. Otherwise, it
32149 is a bitmap of debugging selectors. Two bits are identified for use in
32150 &[local_scan()]&; they are defined as macros:
32151
32152 .ilist
32153 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32154 testing option that is not privileged &-- any caller may set it. All the
32155 other selector bits can be set only by admin users.
32156
32157 .next
32158 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32159 by the &`+local_scan`& debug selector. It is not included in the default set
32160 of debugging bits.
32161 .endlist ilist
32162
32163 Thus, to write to the debugging output only when &`+local_scan`& has been
32164 selected, you should use code like this:
32165 .code
32166 if ((debug_selector & D_local_scan) != 0)
32167   debug_printf("xxx", ...);
32168 .endd
32169 .vitem &*uschar&~*expand_string_message*&
32170 After a failing call to &'expand_string()'& (returned value NULL), the
32171 variable &%expand_string_message%& contains the error message, zero-terminated.
32172
32173 .vitem &*header_line&~*header_list*&
32174 A pointer to a chain of header lines. The &%header_line%& structure is
32175 discussed below.
32176
32177 .vitem &*header_line&~*header_last*&
32178 A pointer to the last of the header lines.
32179
32180 .vitem &*uschar&~*headers_charset*&
32181 The value of the &%headers_charset%& configuration option.
32182
32183 .vitem &*BOOL&~host_checking*&
32184 This variable is TRUE during a host checking session that is initiated by the
32185 &%-bh%& command line option.
32186
32187 .vitem &*uschar&~*interface_address*&
32188 The IP address of the interface that received the message, as a string. This
32189 is NULL for locally submitted messages.
32190
32191 .vitem &*int&~interface_port*&
32192 The port on which this message was received. When testing with the &%-bh%&
32193 command line option, the value of this variable is -1 unless a port has been
32194 specified via the &%-oMi%& option.
32195
32196 .vitem &*uschar&~*message_id*&
32197 This variable contains Exim's message id for the incoming message (the value of
32198 &$message_exim_id$&) as a zero-terminated string.
32199
32200 .vitem &*uschar&~*received_protocol*&
32201 The name of the protocol by which the message was received.
32202
32203 .vitem &*int&~recipients_count*&
32204 The number of accepted recipients.
32205
32206 .vitem &*recipient_item&~*recipients_list*&
32207 .cindex "recipient" "adding in local scan"
32208 .cindex "recipient" "removing in local scan"
32209 The list of accepted recipients, held in a vector of length
32210 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32211 can add additional recipients by calling &'receive_add_recipient()'& (see
32212 below). You can delete recipients by removing them from the vector and
32213 adjusting the value in &%recipients_count%&. In particular, by setting
32214 &%recipients_count%& to zero you remove all recipients. If you then return the
32215 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32216 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32217 and then call &'receive_add_recipient()'& as often as needed.
32218
32219 .vitem &*uschar&~*sender_address*&
32220 The envelope sender address. For bounce messages this is the empty string.
32221
32222 .vitem &*uschar&~*sender_host_address*&
32223 The IP address of the sending host, as a string. This is NULL for
32224 locally-submitted messages.
32225
32226 .vitem &*uschar&~*sender_host_authenticated*&
32227 The name of the authentication mechanism that was used, or NULL if the message
32228 was not received over an authenticated SMTP connection.
32229
32230 .vitem &*uschar&~*sender_host_name*&
32231 The name of the sending host, if known.
32232
32233 .vitem &*int&~sender_host_port*&
32234 The port on the sending host.
32235
32236 .vitem &*BOOL&~smtp_input*&
32237 This variable is TRUE for all SMTP input, including BSMTP.
32238
32239 .vitem &*BOOL&~smtp_batched_input*&
32240 This variable is TRUE for BSMTP input.
32241
32242 .vitem &*int&~store_pool*&
32243 The contents of this variable control which pool of memory is used for new
32244 requests. See section &<<SECTmemhanloc>>& for details.
32245 .endlist
32246
32247
32248 .section "Structure of header lines" "SECID209"
32249 The &%header_line%& structure contains the members listed below.
32250 You can add additional header lines by calling the &'header_add()'& function
32251 (see below). You can cause header lines to be ignored (deleted) by setting
32252 their type to *.
32253
32254
32255 .vlist
32256 .vitem &*struct&~header_line&~*next*&
32257 A pointer to the next header line, or NULL for the last line.
32258
32259 .vitem &*int&~type*&
32260 A code identifying certain headers that Exim recognizes. The codes are printing
32261 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32262 Notice in particular that any header line whose type is * is not transmitted
32263 with the message. This flagging is used for header lines that have been
32264 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32265 lines.) Effectively, * means &"deleted"&.
32266
32267 .vitem &*int&~slen*&
32268 The number of characters in the header line, including the terminating and any
32269 internal newlines.
32270
32271 .vitem &*uschar&~*text*&
32272 A pointer to the text of the header. It always ends with a newline, followed by
32273 a zero byte. Internal newlines are preserved.
32274 .endlist
32275
32276
32277
32278 .section "Structure of recipient items" "SECID210"
32279 The &%recipient_item%& structure contains these members:
32280
32281 .vlist
32282 .vitem &*uschar&~*address*&
32283 This is a pointer to the recipient address as it was received.
32284
32285 .vitem &*int&~pno*&
32286 This is used in later Exim processing when top level addresses are created by
32287 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32288 and must always contain -1 at this stage.
32289
32290 .vitem &*uschar&~*errors_to*&
32291 If this value is not NULL, bounce messages caused by failing to deliver to the
32292 recipient are sent to the address it contains. In other words, it overrides the
32293 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32294 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32295 an unqualified address, Exim qualifies it using the domain from
32296 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32297 is NULL for all recipients.
32298 .endlist
32299
32300
32301
32302 .section "Available Exim functions" "SECID211"
32303 .cindex "&[local_scan()]& function" "available Exim functions"
32304 The header &_local_scan.h_& gives you access to a number of Exim functions.
32305 These are the only ones that are guaranteed to be maintained from release to
32306 release:
32307
32308 .vlist
32309 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32310        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32311
32312 This function creates a child process that runs the command specified by
32313 &%argv%&. The environment for the process is specified by &%envp%&, which can
32314 be NULL if no environment variables are to be passed. A new umask is supplied
32315 for the process in &%newumask%&.
32316
32317 Pipes to the standard input and output of the new process are set up
32318 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32319 standard error is cloned to the standard output. If there are any file
32320 descriptors &"in the way"& in the new process, they are closed. If the final
32321 argument is TRUE, the new process is made into a process group leader.
32322
32323 The function returns the pid of the new process, or -1 if things go wrong.
32324
32325 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32326 This function waits for a child process to terminate, or for a timeout (in
32327 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32328 return value is as follows:
32329
32330 .ilist
32331 >= 0
32332
32333 The process terminated by a normal exit and the value is the process
32334 ending status.
32335
32336 .next
32337 < 0 and > &--256
32338
32339 The process was terminated by a signal and the value is the negation of the
32340 signal number.
32341
32342 .next
32343 &--256
32344
32345 The process timed out.
32346 .next
32347 &--257
32348
32349 The was some other error in wait(); &%errno%& is still set.
32350 .endlist
32351
32352 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32353 This function provide you with a means of submitting a new message to
32354 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32355 want, but this packages it all up for you.) The function creates a pipe,
32356 forks a subprocess that is running
32357 .code
32358 exim -t -oem -oi -f <>
32359 .endd
32360 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32361 that is connected to the standard input. The yield of the function is the PID
32362 of the subprocess. You can then write a message to the file descriptor, with
32363 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32364
32365 When you have finished, call &'child_close()'& to wait for the process to
32366 finish and to collect its ending status. A timeout value of zero is usually
32367 fine in this circumstance. Unless you have made a mistake with the recipient
32368 addresses, you should get a return code of zero.
32369
32370
32371 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32372        *sender_authentication)*&
32373 This function is a more sophisticated version of &'child_open()'&. The command
32374 that it runs is:
32375 .display
32376 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32377 .endd
32378 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32379
32380
32381 .vitem &*void&~debug_printf(char&~*,&~...)*&
32382 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32383 output is written to the standard error stream. If no debugging is selected,
32384 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32385 conditional on the &`local_scan`& debug selector by coding like this:
32386 .code
32387 if ((debug_selector & D_local_scan) != 0)
32388   debug_printf("xxx", ...);
32389 .endd
32390
32391 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32392 This is an interface to Exim's string expansion code. The return value is the
32393 expanded string, or NULL if there was an expansion failure.
32394 The C variable &%expand_string_message%& contains an error message after an
32395 expansion failure. If expansion does not change the string, the return value is
32396 the pointer to the input string. Otherwise, the return value points to a new
32397 block of memory that was obtained by a call to &'store_get()'&. See section
32398 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32399
32400 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32401 This function allows you to an add additional header line at the end of the
32402 existing ones. The first argument is the type, and should normally be a space
32403 character. The second argument is a format string and any number of
32404 substitution arguments as for &[sprintf()]&. You may include internal newlines
32405 if you want, and you must ensure that the string ends with a newline.
32406
32407 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32408         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32409 This function adds a new header line at a specified point in the header
32410 chain. The header itself is specified as for &'header_add()'&.
32411
32412 If &%name%& is NULL, the new header is added at the end of the chain if
32413 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32414 NULL, the header lines are searched for the first non-deleted header that
32415 matches the name. If one is found, the new header is added before it if
32416 &%after%& is false. If &%after%& is true, the new header is added after the
32417 found header and any adjacent subsequent ones with the same name (even if
32418 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32419 option controls where the header is added. If it is true, addition is at the
32420 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32421 headers, or at the top if there are no &'Received:'& headers, you could use
32422 .code
32423 header_add_at_position(TRUE, US"Received", TRUE,
32424   ' ', "X-xxx: ...");
32425 .endd
32426 Normally, there is always at least one non-deleted &'Received:'& header, but
32427 there may not be if &%received_header_text%& expands to an empty string.
32428
32429
32430 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32431 This function removes header lines. If &%occurrence%& is zero or negative, all
32432 occurrences of the header are removed. If occurrence is greater than zero, that
32433 particular instance of the header is removed. If no header(s) can be found that
32434 match the specification, the function does nothing.
32435
32436
32437 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32438         int&~length,&~BOOL&~notdel)*&"
32439 This function tests whether the given header has the given name. It is not just
32440 a string comparison, because white space is permitted between the name and the
32441 colon. If the &%notdel%& argument is true, a false return is forced for all
32442 &"deleted"& headers; otherwise they are not treated specially. For example:
32443 .code
32444 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32445 .endd
32446 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32447 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32448 This function base64-encodes a string, which is passed by address and length.
32449 The text may contain bytes of any value, including zero. The result is passed
32450 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32451 zero-terminated.
32452
32453 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32454 This function decodes a base64-encoded string. Its arguments are a
32455 zero-terminated base64-encoded string and the address of a variable that is set
32456 to point to the result, which is in dynamic memory. The length of the decoded
32457 string is the yield of the function. If the input is invalid base64 data, the
32458 yield is -1. A zero byte is added to the end of the output string to make it
32459 easy to interpret as a C string (assuming it contains no zeros of its own). The
32460 added zero byte is not included in the returned count.
32461
32462 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32463 This function checks for a match in a domain list. Domains are always
32464 matched caselessly. The return value is one of the following:
32465 .display
32466 &`OK     `& match succeeded
32467 &`FAIL   `& match failed
32468 &`DEFER  `& match deferred
32469 .endd
32470 DEFER is usually caused by some kind of lookup defer, such as the
32471 inability to contact a database.
32472
32473 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32474         BOOL&~caseless)*&"
32475 This function checks for a match in a local part list. The third argument
32476 controls case-sensitivity. The return values are as for
32477 &'lss_match_domain()'&.
32478
32479 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32480         BOOL&~caseless)*&"
32481 This function checks for a match in an address list. The third argument
32482 controls the case-sensitivity of the local part match. The domain is always
32483 matched caselessly. The return values are as for &'lss_match_domain()'&.
32484
32485 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32486         uschar&~*list)*&"
32487 This function checks for a match in a host list. The most common usage is
32488 expected to be
32489 .code
32490 lss_match_host(sender_host_name, sender_host_address, ...)
32491 .endd
32492 .vindex "&$sender_host_address$&"
32493 An empty address field matches an empty item in the host list. If the host name
32494 is NULL, the name corresponding to &$sender_host_address$& is automatically
32495 looked up if a host name is required to match an item in the list. The return
32496 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32497 returns ERROR in the case when it had to look up a host name, but the lookup
32498 failed.
32499
32500 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32501         *format,&~...)*&"
32502 This function writes to Exim's log files. The first argument should be zero (it
32503 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32504 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32505 them. It specifies to which log or logs the message is written. The remaining
32506 arguments are a format and relevant insertion arguments. The string should not
32507 contain any newlines, not even at the end.
32508
32509
32510 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32511 This function adds an additional recipient to the message. The first argument
32512 is the recipient address. If it is unqualified (has no domain), it is qualified
32513 with the &%qualify_recipient%& domain. The second argument must always be -1.
32514
32515 This function does not allow you to specify a private &%errors_to%& address (as
32516 described with the structure of &%recipient_item%& above), because it pre-dates
32517 the addition of that field to the structure. However, it is easy to add such a
32518 value afterwards. For example:
32519 .code
32520  receive_add_recipient(US"monitor@mydom.example", -1);
32521  recipients_list[recipients_count-1].errors_to =
32522    US"postmaster@mydom.example";
32523 .endd
32524
32525 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32526 This is a convenience function to remove a named recipient from the list of
32527 recipients. It returns true if a recipient was removed, and false if no
32528 matching recipient could be found. The argument must be a complete email
32529 address.
32530 .endlist
32531
32532
32533 .cindex "RFC 2047"
32534 .vlist
32535 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32536   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32537 This function decodes strings that are encoded according to RFC 2047. Typically
32538 these are the contents of header lines. First, each &"encoded word"& is decoded
32539 from the Q or B encoding into a byte-string. Then, if provided with the name of
32540 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32541 made  to translate the result to the named character set. If this fails, the
32542 binary string is returned with an error message.
32543
32544 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32545 maximum MIME word length is enforced. The third argument is the target
32546 encoding, or NULL if no translation is wanted.
32547
32548 .cindex "binary zero" "in RFC 2047 decoding"
32549 .cindex "RFC 2047" "binary zero in"
32550 If a binary zero is encountered in the decoded string, it is replaced by the
32551 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32552 not be 0 because header lines are handled as zero-terminated strings.
32553
32554 The function returns the result of processing the string, zero-terminated; if
32555 &%lenptr%& is not NULL, the length of the result is set in the variable to
32556 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32557
32558 If an error is encountered, the function returns NULL and uses the &%error%&
32559 argument to return an error message. The variable pointed to by &%error%& is
32560 set to NULL if there is no error; it may be set non-NULL even when the function
32561 returns a non-NULL value if decoding was successful, but there was a problem
32562 with translation.
32563
32564
32565 .vitem &*int&~smtp_fflush(void)*&
32566 This function is used in conjunction with &'smtp_printf()'&, as described
32567 below.
32568
32569 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32570 The arguments of this function are like &[printf()]&; it writes to the SMTP
32571 output stream. You should use this function only when there is an SMTP output
32572 stream, that is, when the incoming message is being received via interactive
32573 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32574 is FALSE. If you want to test for an incoming message from another host (as
32575 opposed to a local process that used the &%-bs%& command line option), you can
32576 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32577 is involved.
32578
32579 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32580 output function, so it can be used for all forms of SMTP connection.
32581
32582 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32583 must start with an appropriate response code: 550 if you are going to return
32584 LOCAL_SCAN_REJECT, 451 if you are going to return
32585 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32586 initial lines of a multi-line response, the code must be followed by a hyphen
32587 to indicate that the line is not the final response line. You must also ensure
32588 that the lines you write terminate with CRLF. For example:
32589 .code
32590 smtp_printf("550-this is some extra info\r\n");
32591 return LOCAL_SCAN_REJECT;
32592 .endd
32593 Note that you can also create multi-line responses by including newlines in
32594 the data returned via the &%return_text%& argument. The added value of using
32595 &'smtp_printf()'& is that, for instance, you could introduce delays between
32596 multiple output lines.
32597
32598 The &'smtp_printf()'& function does not return any error indication, because it
32599 does not automatically flush pending output, and therefore does not test
32600 the state of the stream. (In the main code of Exim, flushing and error
32601 detection is done when Exim is ready for the next SMTP input command.) If
32602 you want to flush the output and check for an error (for example, the
32603 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32604 arguments. It flushes the output stream, and returns a non-zero value if there
32605 is an error.
32606
32607 .vitem &*void&~*store_get(int)*&
32608 This function accesses Exim's internal store (memory) manager. It gets a new
32609 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32610 runs out of memory. See the next section for a discussion of memory handling.
32611
32612 .vitem &*void&~*store_get_perm(int)*&
32613 This function is like &'store_get()'&, but it always gets memory from the
32614 permanent pool. See the next section for a discussion of memory handling.
32615
32616 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32617 See below.
32618
32619 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32620 See below.
32621
32622 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32623 These three functions create strings using Exim's dynamic memory facilities.
32624 The first makes a copy of an entire string. The second copies up to a maximum
32625 number of characters, indicated by the second argument. The third uses a format
32626 and insertion arguments to create a new string. In each case, the result is a
32627 pointer to a new string in the current memory pool. See the next section for
32628 more discussion.
32629 .endlist
32630
32631
32632
32633 .section "More about Exim's memory handling" "SECTmemhanloc"
32634 .cindex "&[local_scan()]& function" "memory handling"
32635 No function is provided for freeing memory, because that is never needed.
32636 The dynamic memory that Exim uses when receiving a message is automatically
32637 recycled if another message is received by the same process (this applies only
32638 to incoming SMTP connections &-- other input methods can supply only one
32639 message at a time). After receiving the last message, a reception process
32640 terminates.
32641
32642 Because it is recycled, the normal dynamic memory cannot be used for holding
32643 data that must be preserved over a number of incoming messages on the same SMTP
32644 connection. However, Exim in fact uses two pools of dynamic memory; the second
32645 one is not recycled, and can be used for this purpose.
32646
32647 If you want to allocate memory that remains available for subsequent messages
32648 in the same SMTP connection, you should set
32649 .code
32650 store_pool = POOL_PERM
32651 .endd
32652 before calling the function that does the allocation. There is no need to
32653 restore the value if you do not need to; however, if you do want to revert to
32654 the normal pool, you can either restore the previous value of &%store_pool%& or
32655 set it explicitly to POOL_MAIN.
32656
32657 The pool setting applies to all functions that get dynamic memory, including
32658 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32659 There is also a convenience function called &'store_get_perm()'& that gets a
32660 block of memory from the permanent pool while preserving the value of
32661 &%store_pool%&.
32662 .ecindex IIDlosca
32663
32664
32665
32666
32667 . ////////////////////////////////////////////////////////////////////////////
32668 . ////////////////////////////////////////////////////////////////////////////
32669
32670 .chapter "System-wide message filtering" "CHAPsystemfilter"
32671 .scindex IIDsysfil1 "filter" "system filter"
32672 .scindex IIDsysfil2 "filtering all mail"
32673 .scindex IIDsysfil3 "system filter"
32674 The previous chapters (on ACLs and the local scan function) describe checks
32675 that can be applied to messages before they are accepted by a host. There is
32676 also a mechanism for checking messages once they have been received, but before
32677 they are delivered. This is called the &'system filter'&.
32678
32679 The system filter operates in a similar manner to users' filter files, but it
32680 is run just once per message (however many recipients the message has).
32681 It should not normally be used as a substitute for routing, because &%deliver%&
32682 commands in a system router provide new envelope recipient addresses.
32683 The system filter must be an Exim filter. It cannot be a Sieve filter.
32684
32685 The system filter is run at the start of a delivery attempt, before any routing
32686 is done. If a message fails to be completely delivered at the first attempt,
32687 the system filter is run again at the start of every retry.
32688 If you want your filter to do something only once per message, you can make use
32689 of the &%first_delivery%& condition in an &%if%& command in the filter to
32690 prevent it happening on retries.
32691
32692 .vindex "&$domain$&"
32693 .vindex "&$local_part$&"
32694 &*Warning*&: Because the system filter runs just once, variables that are
32695 specific to individual recipient addresses, such as &$local_part$& and
32696 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32697 you want to run a centrally-specified filter for each recipient address
32698 independently, you can do so by setting up a suitable &(redirect)& router, as
32699 described in section &<<SECTperaddfil>>& below.
32700
32701
32702 .section "Specifying a system filter" "SECID212"
32703 .cindex "uid (user id)" "system filter"
32704 .cindex "gid (group id)" "system filter"
32705 The name of the file that contains the system filter must be specified by
32706 setting &%system_filter%&. If you want the filter to run under a uid and gid
32707 other than root, you must also set &%system_filter_user%& and
32708 &%system_filter_group%& as appropriate. For example:
32709 .code
32710 system_filter = /etc/mail/exim.filter
32711 system_filter_user = exim
32712 .endd
32713 If a system filter generates any deliveries directly to files or pipes (via the
32714 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32715 specified by setting &%system_filter_file_transport%& and
32716 &%system_filter_pipe_transport%&, respectively. Similarly,
32717 &%system_filter_reply_transport%& must be set to handle any messages generated
32718 by the &%reply%& command.
32719
32720
32721 .section "Testing a system filter" "SECID213"
32722 You can run simple tests of a system filter in the same way as for a user
32723 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32724 are permitted only in system filters are recognized.
32725
32726 If you want to test the combined effect of a system filter and a user filter,
32727 you can use both &%-bF%& and &%-bf%& on the same command line.
32728
32729
32730
32731 .section "Contents of a system filter" "SECID214"
32732 The language used to specify system filters is the same as for users' filter
32733 files. It is described in the separate end-user document &'Exim's interface to
32734 mail filtering'&. However, there are some additional features that are
32735 available only in system filters; these are described in subsequent sections.
32736 If they are encountered in a user's filter file or when testing with &%-bf%&,
32737 they cause errors.
32738
32739 .cindex "frozen messages" "manual thaw; testing in filter"
32740 There are two special conditions which, though available in users' filter
32741 files, are designed for use in system filters. The condition &%first_delivery%&
32742 is true only for the first attempt at delivering a message, and
32743 &%manually_thawed%& is true only if the message has been frozen, and
32744 subsequently thawed by an admin user. An explicit forced delivery counts as a
32745 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32746
32747 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32748 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32749 succeed, it will not be tried again.
32750 If you want Exim to retry an unseen delivery until it succeeds, you should
32751 arrange to set it up every time the filter runs.
32752
32753 When a system filter finishes running, the values of the variables &$n0$& &--
32754 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32755 users' filter files. Thus a system filter can, for example, set up &"scores"&
32756 to which users' filter files can refer.
32757
32758
32759
32760 .section "Additional variable for system filters" "SECID215"
32761 .vindex "&$recipients$&"
32762 The expansion variable &$recipients$&, containing a list of all the recipients
32763 of the message (separated by commas and white space), is available in system
32764 filters. It is not available in users' filters for privacy reasons.
32765
32766
32767
32768 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32769 .cindex "freezing messages"
32770 .cindex "message" "freezing"
32771 .cindex "message" "forced failure"
32772 .cindex "&%fail%&" "in system filter"
32773 .cindex "&%freeze%& in system filter"
32774 .cindex "&%defer%& in system filter"
32775 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32776 always available in system filters, but are not normally enabled in users'
32777 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32778 for the &(redirect)& router.) These commands can optionally be followed by the
32779 word &%text%& and a string containing an error message, for example:
32780 .code
32781 fail text "this message looks like spam to me"
32782 .endd
32783 The keyword &%text%& is optional if the next character is a double quote.
32784
32785 The &%defer%& command defers delivery of the original recipients of the
32786 message. The &%fail%& command causes all the original recipients to be failed,
32787 and a bounce message to be created. The &%freeze%& command suspends all
32788 delivery attempts for the original recipients. In all cases, any new deliveries
32789 that are specified by the filter are attempted as normal after the filter has
32790 run.
32791
32792 The &%freeze%& command is ignored if the message has been manually unfrozen and
32793 not manually frozen since. This means that automatic freezing by a system
32794 filter can be used as a way of checking out suspicious messages. If a message
32795 is found to be all right, manually unfreezing it allows it to be delivered.
32796
32797 .cindex "log" "&%fail%& command log line"
32798 .cindex "&%fail%&" "log line; reducing"
32799 The text given with a fail command is used as part of the bounce message as
32800 well as being written to the log. If the message is quite long, this can fill
32801 up a lot of log space when such failures are common. To reduce the size of the
32802 log message, Exim interprets the text in a special way if it starts with the
32803 two characters &`<<`& and contains &`>>`& later. The text between these two
32804 strings is written to the log, and the rest of the text is used in the bounce
32805 message. For example:
32806 .code
32807 fail "<<filter test 1>>Your message is rejected \
32808      because it contains attachments that we are \
32809      not prepared to receive."
32810 .endd
32811
32812 .cindex "loop" "caused by &%fail%&"
32813 Take great care with the &%fail%& command when basing the decision to fail on
32814 the contents of the message, because the bounce message will of course include
32815 the contents of the original message and will therefore trigger the &%fail%&
32816 command again (causing a mail loop) unless steps are taken to prevent this.
32817 Testing the &%error_message%& condition is one way to prevent this. You could
32818 use, for example
32819 .code
32820 if $message_body contains "this is spam" and not error_message
32821 then fail text "spam is not wanted here" endif
32822 .endd
32823 though of course that might let through unwanted bounce messages. The
32824 alternative is clever checking of the body and/or headers to detect bounces
32825 generated by the filter.
32826
32827 The interpretation of a system filter file ceases after a
32828 &%defer%&,
32829 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32830 set up earlier in the filter file are honoured, so you can use a sequence such
32831 as
32832 .code
32833 mail ...
32834 freeze
32835 .endd
32836 to send a specified message when the system filter is freezing (or deferring or
32837 failing) a message. The normal deliveries for the message do not, of course,
32838 take place.
32839
32840
32841
32842 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32843 .cindex "header lines" "adding; in system filter"
32844 .cindex "header lines" "removing; in system filter"
32845 .cindex "filter" "header lines; adding/removing"
32846 Two filter commands that are available only in system filters are:
32847 .code
32848 headers add <string>
32849 headers remove <string>
32850 .endd
32851 The argument for the &%headers add%& is a string that is expanded and then
32852 added to the end of the message's headers. It is the responsibility of the
32853 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32854 space is ignored, and if the string is otherwise empty, or if the expansion is
32855 forced to fail, the command has no effect.
32856
32857 You can use &"\n"& within the string, followed by white space, to specify
32858 continued header lines. More than one header may be added in one command by
32859 including &"\n"& within the string without any following white space. For
32860 example:
32861 .code
32862 headers add "X-header-1: ....\n  \
32863              continuation of X-header-1 ...\n\
32864              X-header-2: ...."
32865 .endd
32866 Note that the header line continuation white space after the first newline must
32867 be placed before the backslash that continues the input string, because white
32868 space after input continuations is ignored.
32869
32870 The argument for &%headers remove%& is a colon-separated list of header names.
32871 This command applies only to those headers that are stored with the message;
32872 those that are added at delivery time (such as &'Envelope-To:'& and
32873 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32874 header with the same name, they are all removed.
32875
32876 The &%headers%& command in a system filter makes an immediate change to the set
32877 of header lines that was received with the message (with possible additions
32878 from ACL processing). Subsequent commands in the system filter operate on the
32879 modified set, which also forms the basis for subsequent message delivery.
32880 Unless further modified during routing or transporting, this set of headers is
32881 used for all recipients of the message.
32882
32883 During routing and transporting, the variables that refer to the contents of
32884 header lines refer only to those lines that are in this set. Thus, header lines
32885 that are added by a system filter are visible to users' filter files and to all
32886 routers and transports. This contrasts with the manipulation of header lines by
32887 routers and transports, which is not immediate, but which instead is saved up
32888 until the message is actually being written (see section
32889 &<<SECTheadersaddrem>>&).
32890
32891 If the message is not delivered at the first attempt, header lines that were
32892 added by the system filter are stored with the message, and so are still
32893 present at the next delivery attempt. Header lines that were removed are still
32894 present, but marked &"deleted"& so that they are not transported with the
32895 message. For this reason, it is usual to make the &%headers%& command
32896 conditional on &%first_delivery%& so that the set of header lines is not
32897 modified more than once.
32898
32899 Because header modification in a system filter acts immediately, you have to
32900 use an indirect approach if you want to modify the contents of a header line.
32901 For example:
32902 .code
32903 headers add "Old-Subject: $h_subject:"
32904 headers remove "Subject"
32905 headers add "Subject: new subject (was: $h_old-subject:)"
32906 headers remove "Old-Subject"
32907 .endd
32908
32909
32910
32911 .section "Setting an errors address in a system filter" "SECID217"
32912 .cindex "envelope sender"
32913 In a system filter, if a &%deliver%& command is followed by
32914 .code
32915 errors_to <some address>
32916 .endd
32917 in order to change the envelope sender (and hence the error reporting) for that
32918 delivery, any address may be specified. (In a user filter, only the current
32919 user's address can be set.) For example, if some mail is being monitored, you
32920 might use
32921 .code
32922 unseen deliver monitor@spying.example errors_to root@local.example
32923 .endd
32924 to take a copy which would not be sent back to the normal error reporting
32925 address if its delivery failed.
32926
32927
32928
32929 .section "Per-address filtering" "SECTperaddfil"
32930 .vindex "&$domain$&"
32931 .vindex "&$local_part$&"
32932 In contrast to the system filter, which is run just once per message for each
32933 delivery attempt, it is also possible to set up a system-wide filtering
32934 operation that runs once for each recipient address. In this case, variables
32935 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32936 filter file could be made dependent on them. This is an example of a router
32937 which implements such a filter:
32938 .code
32939 central_filter:
32940   check_local_user
32941   driver = redirect
32942   domains = +local_domains
32943   file = /central/filters/$local_part
32944   no_verify
32945   allow_filter
32946   allow_freeze
32947 .endd
32948 The filter is run in a separate process under its own uid. Therefore, either
32949 &%check_local_user%& must be set (as above), in which case the filter is run as
32950 the local user, or the &%user%& option must be used to specify which user to
32951 use. If both are set, &%user%& overrides.
32952
32953 Care should be taken to ensure that none of the commands in the filter file
32954 specify a significant delivery if the message is to go on to be delivered to
32955 its intended recipient. The router will not then claim to have dealt with the
32956 address, so it will be passed on to subsequent routers to be delivered in the
32957 normal way.
32958 .ecindex IIDsysfil1
32959 .ecindex IIDsysfil2
32960 .ecindex IIDsysfil3
32961
32962
32963
32964
32965
32966
32967 . ////////////////////////////////////////////////////////////////////////////
32968 . ////////////////////////////////////////////////////////////////////////////
32969
32970 .chapter "Message processing" "CHAPmsgproc"
32971 .scindex IIDmesproc "message" "general processing"
32972 Exim performs various transformations on the sender and recipient addresses of
32973 all messages that it handles, and also on the messages' header lines. Some of
32974 these are optional and configurable, while others always take place. All of
32975 this processing, except rewriting as a result of routing, and the addition or
32976 removal of header lines while delivering, happens when a message is received,
32977 before it is placed on Exim's queue.
32978
32979 Some of the automatic processing takes place by default only for
32980 &"locally-originated"& messages. This adjective is used to describe messages
32981 that are not received over TCP/IP, but instead are passed to an Exim process on
32982 its standard input. This includes the interactive &"local SMTP"& case that is
32983 set up by the &%-bs%& command line option.
32984
32985 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32986 or ::1) are not considered to be locally-originated. Exim does not treat the
32987 loopback interface specially in any way.
32988
32989 If you want the loopback interface to be treated specially, you must ensure
32990 that there are appropriate entries in your ACLs.
32991
32992
32993
32994
32995 .section "Submission mode for non-local messages" "SECTsubmodnon"
32996 .cindex "message" "submission"
32997 .cindex "submission mode"
32998 Processing that happens automatically for locally-originated messages (unless
32999 &%suppress_local_fixups%& is set) can also be requested for messages that are
33000 received over TCP/IP. The term &"submission mode"& is used to describe this
33001 state. Submission mode is set by the modifier
33002 .code
33003 control = submission
33004 .endd
33005 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33006 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33007 a local submission, and is normally used when the source of the message is
33008 known to be an MUA running on a client host (as opposed to an MTA). For
33009 example, to set submission mode for messages originating on the IPv4 loopback
33010 interface, you could include the following in the MAIL ACL:
33011 .code
33012 warn  hosts = 127.0.0.1
33013       control = submission
33014 .endd
33015 .cindex "&%sender_retain%& submission option"
33016 There are some options that can be used when setting submission mode. A slash
33017 is used to separate options. For example:
33018 .code
33019 control = submission/sender_retain
33020 .endd
33021 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33022 true and &%local_from_check%& false for the current incoming message. The first
33023 of these allows an existing &'Sender:'& header in the message to remain, and
33024 the second suppresses the check to ensure that &'From:'& matches the
33025 authenticated sender. With this setting, Exim still fixes up messages by adding
33026 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33027 attempt to check sender authenticity in header lines.
33028
33029 When &%sender_retain%& is not set, a submission mode setting may specify a
33030 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33031 example:
33032 .code
33033 control = submission/domain=some.domain
33034 .endd
33035 The domain may be empty. How this value is used is described in sections
33036 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33037 that allows you to specify the user's full name for inclusion in a created
33038 &'Sender:'& or &'From:'& header line. For example:
33039 .code
33040 accept authenticated = *
33041        control = submission/domain=wonderland.example/\
33042                             name=${lookup {$authenticated_id} \
33043                                    lsearch {/etc/exim/namelist}}
33044 .endd
33045 Because the name may contain any characters, including slashes, the &%name%&
33046 option must be given last. The remainder of the string is used as the name. For
33047 the example above, if &_/etc/exim/namelist_& contains:
33048 .code
33049 bigegg:  Humpty Dumpty
33050 .endd
33051 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33052 line would be:
33053 .code
33054 Sender: Humpty Dumpty <bigegg@wonderland.example>
33055 .endd
33056 .cindex "return path" "in submission mode"
33057 By default, submission mode forces the return path to the same address as is
33058 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33059 specified, the return path is also left unchanged.
33060
33061 &*Note*&: The changes caused by submission mode take effect after the predata
33062 ACL. This means that any sender checks performed before the fix-ups use the
33063 untrusted sender address specified by the user, not the trusted sender address
33064 specified by submission mode. Although this might be slightly unexpected, it
33065 does mean that you can configure ACL checks to spot that a user is trying to
33066 spoof another's address.
33067
33068 .section "Line endings" "SECTlineendings"
33069 .cindex "line endings"
33070 .cindex "carriage return"
33071 .cindex "linefeed"
33072 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33073 linefeed) is the line ending for messages transmitted over the Internet using
33074 SMTP over TCP/IP. However, within individual operating systems, different
33075 conventions are used. For example, Unix-like systems use just LF, but others
33076 use CRLF or just CR.
33077
33078 Exim was designed for Unix-like systems, and internally, it stores messages
33079 using the system's convention of a single LF as a line terminator. When
33080 receiving a message, all line endings are translated to this standard format.
33081 Originally, it was thought that programs that passed messages directly to an
33082 MTA within an operating system would use that system's convention. Experience
33083 has shown that this is not the case; for example, there are Unix applications
33084 that use CRLF in this circumstance. For this reason, and for compatibility with
33085 other MTAs, the way Exim handles line endings for all messages is now as
33086 follows:
33087
33088 .ilist
33089 LF not preceded by CR is treated as a line ending.
33090 .next
33091 CR is treated as a line ending; if it is immediately followed by LF, the LF
33092 is ignored.
33093 .next
33094 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33095 nor a local message in the state where a line containing only a dot is a
33096 terminator.
33097 .next
33098 If a bare CR is encountered within a header line, an extra space is added after
33099 the line terminator so as not to end the header line. The reasoning behind this
33100 is that bare CRs in header lines are most likely either to be mistakes, or
33101 people trying to play silly games.
33102 .next
33103 If the first header line received in a message ends with CRLF, a subsequent
33104 bare LF in a header line is treated in the same way as a bare CR in a header
33105 line.
33106 .endlist
33107
33108
33109
33110
33111
33112 .section "Unqualified addresses" "SECID218"
33113 .cindex "unqualified addresses"
33114 .cindex "address" "qualification"
33115 By default, Exim expects every envelope address it receives from an external
33116 host to be fully qualified. Unqualified addresses cause negative responses to
33117 SMTP commands. However, because SMTP is used as a means of transporting
33118 messages from MUAs running on personal workstations, there is sometimes a
33119 requirement to accept unqualified addresses from specific hosts or IP networks.
33120
33121 Exim has two options that separately control which hosts may send unqualified
33122 sender or recipient addresses in SMTP commands, namely
33123 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33124 cases, if an unqualified address is accepted, it is qualified by adding the
33125 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33126
33127 .oindex "&%qualify_domain%&"
33128 .oindex "&%qualify_recipient%&"
33129 Unqualified addresses in header lines are automatically qualified for messages
33130 that are locally originated, unless the &%-bnq%& option is given on the command
33131 line. For messages received over SMTP, unqualified addresses in header lines
33132 are qualified only if unqualified addresses are permitted in SMTP commands. In
33133 other words, such qualification is also controlled by
33134 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33135
33136
33137
33138
33139 .section "The UUCP From line" "SECID219"
33140 .cindex "&""From""& line"
33141 .cindex "UUCP" "&""From""& line"
33142 .cindex "sender" "address"
33143 .oindex "&%uucp_from_pattern%&"
33144 .oindex "&%uucp_from_sender%&"
33145 .cindex "envelope sender"
33146 .cindex "Sendmail compatibility" "&""From""& line"
33147 Messages that have come from UUCP (and some other applications) often begin
33148 with a line containing the envelope sender and a timestamp, following the word
33149 &"From"&. Examples of two common formats are:
33150 .code
33151 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33152 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33153 .endd
33154 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33155 Exim recognizes such lines at the start of messages that are submitted to it
33156 via the command line (that is, on the standard input). It does not recognize
33157 such lines in incoming SMTP messages, unless the sending host matches
33158 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33159 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33160 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33161 default value matches the two common cases shown above and puts the address
33162 that follows &"From"& into &$1$&.
33163
33164 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33165 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33166 a trusted user, the message's sender address is constructed by expanding the
33167 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33168 then parsed as an RFC 2822 address. If there is no domain, the local part is
33169 qualified with &%qualify_domain%& unless it is the empty string. However, if
33170 the command line &%-f%& option is used, it overrides the &"From"& line.
33171
33172 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33173 sender address is not changed. This is also the case for incoming SMTP messages
33174 that are permitted to contain &"From"& lines.
33175
33176 Only one &"From"& line is recognized. If there is more than one, the second is
33177 treated as a data line that starts the body of the message, as it is not valid
33178 as a header line. This also happens if a &"From"& line is present in an
33179 incoming SMTP message from a source that is not permitted to send them.
33180
33181
33182
33183 .section "Resent- header lines" "SECID220"
33184 .cindex "&%Resent-%& header lines"
33185 RFC 2822 makes provision for sets of header lines starting with the string
33186 &`Resent-`& to be added to a message when it is resent by the original
33187 recipient to somebody else. These headers are &'Resent-Date:'&,
33188 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33189 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33190
33191 .blockquote
33192 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33193 processing of replies or other such automatic actions on messages.'&
33194 .endblockquote
33195
33196 This leaves things a bit vague as far as other processing actions such as
33197 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33198 follows:
33199
33200 .ilist
33201 A &'Resent-From:'& line that just contains the login id of the submitting user
33202 is automatically rewritten in the same way as &'From:'& (see below).
33203 .next
33204 If there's a rewriting rule for a particular header line, it is also applied to
33205 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33206 &'From:'& also rewrites &'Resent-From:'&.
33207 .next
33208 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33209 also removed.
33210 .next
33211 For a locally-submitted message,
33212 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33213 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33214 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33215 included in log lines in this case.
33216 .next
33217 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33218 &%Resent-%& header lines are present.
33219 .endlist
33220
33221
33222
33223
33224 .section "The Auto-Submitted: header line" "SECID221"
33225 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33226 includes the header line:
33227 .code
33228 Auto-Submitted: auto-replied
33229 .endd
33230
33231 .section "The Bcc: header line" "SECID222"
33232 .cindex "&'Bcc:'& header line"
33233 If Exim is called with the &%-t%& option, to take recipient addresses from a
33234 message's header, it removes any &'Bcc:'& header line that may exist (after
33235 extracting its addresses). If &%-t%& is not present on the command line, any
33236 existing &'Bcc:'& is not removed.
33237
33238
33239 .section "The Date: header line" "SECID223"
33240 .cindex "&'Date:'& header line"
33241 If a locally-generated or submission-mode message has no &'Date:'& header line,
33242 Exim adds one, using the current date and time, unless the
33243 &%suppress_local_fixups%& control has been specified.
33244
33245 .section "The Delivery-date: header line" "SECID224"
33246 .cindex "&'Delivery-date:'& header line"
33247 .oindex "&%delivery_date_remove%&"
33248 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33249 set. Exim can be configured to add them to the final delivery of messages. (See
33250 the generic &%delivery_date_add%& transport option.) They should not be present
33251 in messages in transit. If the &%delivery_date_remove%& configuration option is
33252 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33253 messages.
33254
33255
33256 .section "The Envelope-to: header line" "SECID225"
33257 .cindex "&'Envelope-to:'& header line"
33258 .oindex "&%envelope_to_remove%&"
33259 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33260 Exim can be configured to add them to the final delivery of messages. (See the
33261 generic &%envelope_to_add%& transport option.) They should not be present in
33262 messages in transit. If the &%envelope_to_remove%& configuration option is set
33263 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33264 messages.
33265
33266
33267 .section "The From: header line" "SECTthefrohea"
33268 .cindex "&'From:'& header line"
33269 .cindex "Sendmail compatibility" "&""From""& line"
33270 .cindex "message" "submission"
33271 .cindex "submission mode"
33272 If a submission-mode message does not contain a &'From:'& header line, Exim
33273 adds one if either of the following conditions is true:
33274
33275 .ilist
33276 The envelope sender address is not empty (that is, this is not a bounce
33277 message). The added header line copies the envelope sender address.
33278 .next
33279 .vindex "&$authenticated_id$&"
33280 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33281 .olist
33282 .vindex "&$qualify_domain$&"
33283 If no domain is specified by the submission control, the local part is
33284 &$authenticated_id$& and the domain is &$qualify_domain$&.
33285 .next
33286 If a non-empty domain is specified by the submission control, the local
33287 part is &$authenticated_id$&, and the domain is the specified domain.
33288 .next
33289 If an empty domain is specified by the submission control,
33290 &$authenticated_id$& is assumed to be the complete address.
33291 .endlist
33292 .endlist
33293
33294 A non-empty envelope sender takes precedence.
33295
33296 If a locally-generated incoming message does not contain a &'From:'& header
33297 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33298 containing the sender's address. The calling user's login name and full name
33299 are used to construct the address, as described in section &<<SECTconstr>>&.
33300 They are obtained from the password data by calling &[getpwuid()]& (but see the
33301 &%unknown_login%& configuration option). The address is qualified with
33302 &%qualify_domain%&.
33303
33304 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33305 &'From:'& header line containing just the unqualified login name of the calling
33306 user, this is replaced by an address containing the user's login name and full
33307 name as described in section &<<SECTconstr>>&.
33308
33309
33310 .section "The Message-ID: header line" "SECID226"
33311 .cindex "&'Message-ID:'& header line"
33312 .cindex "message" "submission"
33313 .oindex "&%message_id_header_text%&"
33314 If a locally-generated or submission-mode incoming message does not contain a
33315 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33316 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33317 to the message. If there are any &'Resent-:'& headers in the message, it
33318 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33319 message id, preceded by the letter E to ensure it starts with a letter, and
33320 followed by @ and the primary host name. Additional information can be included
33321 in this header line by setting the &%message_id_header_text%& and/or
33322 &%message_id_header_domain%& options.
33323
33324
33325 .section "The Received: header line" "SECID227"
33326 .cindex "&'Received:'& header line"
33327 A &'Received:'& header line is added at the start of every message. The
33328 contents are defined by the &%received_header_text%& configuration option, and
33329 Exim automatically adds a semicolon and a timestamp to the configured string.
33330
33331 The &'Received:'& header is generated as soon as the message's header lines
33332 have been received. At this stage, the timestamp in the &'Received:'& header
33333 line is the time that the message started to be received. This is the value
33334 that is seen by the DATA ACL and by the &[local_scan()]& function.
33335
33336 Once a message is accepted, the timestamp in the &'Received:'& header line is
33337 changed to the time of acceptance, which is (apart from a small delay while the
33338 -H spool file is written) the earliest time at which delivery could start.
33339
33340
33341 .section "The References: header line" "SECID228"
33342 .cindex "&'References:'& header line"
33343 Messages created by the &(autoreply)& transport include a &'References:'&
33344 header line. This is constructed according to the rules that are described in
33345 section 3.64 of RFC 2822 (which states that replies should contain such a
33346 header line), and section 3.14 of RFC 3834 (which states that automatic
33347 responses are not different in this respect). However, because some mail
33348 processing software does not cope well with very long header lines, no more
33349 than 12 message IDs are copied from the &'References:'& header line in the
33350 incoming message. If there are more than 12, the first one and then the final
33351 11 are copied, before adding the message ID of the incoming message.
33352
33353
33354
33355 .section "The Return-path: header line" "SECID229"
33356 .cindex "&'Return-path:'& header line"
33357 .oindex "&%return_path_remove%&"
33358 &'Return-path:'& header lines are defined as something an MTA may insert when
33359 it does the final delivery of messages. (See the generic &%return_path_add%&
33360 transport option.) Therefore, they should not be present in messages in
33361 transit. If the &%return_path_remove%& configuration option is set (the
33362 default), Exim removes &'Return-path:'& header lines from incoming messages.
33363
33364
33365
33366 .section "The Sender: header line" "SECTthesenhea"
33367 .cindex "&'Sender:'& header line"
33368 .cindex "message" "submission"
33369 For a locally-originated message from an untrusted user, Exim may remove an
33370 existing &'Sender:'& header line, and it may add a new one. You can modify
33371 these actions by setting the &%local_sender_retain%& option true, the
33372 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33373 control setting.
33374
33375 When a local message is received from an untrusted user and
33376 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33377 control has not been set, a check is made to see if the address given in the
33378 &'From:'& header line is the correct (local) sender of the message. The address
33379 that is expected has the login name as the local part and the value of
33380 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33381 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33382 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33383 line is added to the message.
33384
33385 If you set &%local_from_check%& false, this checking does not occur. However,
33386 the removal of an existing &'Sender:'& line still happens, unless you also set
33387 &%local_sender_retain%& to be true. It is not possible to set both of these
33388 options true at the same time.
33389
33390 .cindex "submission mode"
33391 By default, no processing of &'Sender:'& header lines is done for messages
33392 received over TCP/IP or for messages submitted by trusted users. However, when
33393 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33394 not specified on the submission control, the following processing takes place:
33395
33396 .vindex "&$authenticated_id$&"
33397 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33398 authenticated, and &$authenticated_id$& is not empty, a sender address is
33399 created as follows:
33400
33401 .ilist
33402 .vindex "&$qualify_domain$&"
33403 If no domain is specified by the submission control, the local part is
33404 &$authenticated_id$& and the domain is &$qualify_domain$&.
33405 .next
33406 If a non-empty domain is specified by the submission control, the local part
33407 is &$authenticated_id$&, and the domain is the specified domain.
33408 .next
33409 If an empty domain is specified by the submission control,
33410 &$authenticated_id$& is assumed to be the complete address.
33411 .endlist
33412
33413 This address is compared with the address in the &'From:'& header line. If they
33414 are different, a &'Sender:'& header line containing the created address is
33415 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33416 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33417
33418 .cindex "return path" "created from &'Sender:'&"
33419 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33420 the message (the envelope sender address) is changed to be the same address,
33421 except in the case of submission mode when &%sender_retain%& is specified.
33422
33423
33424
33425 .section "Adding and removing header lines in routers and transports" &&&
33426          "SECTheadersaddrem"
33427 .cindex "header lines" "adding; in router or transport"
33428 .cindex "header lines" "removing; in router or transport"
33429 When a message is delivered, the addition and removal of header lines can be
33430 specified in a system filter, or on any of the routers and transports that
33431 process the message. Section &<<SECTaddremheasys>>& contains details about
33432 modifying headers in a system filter. Header lines can also be added in an ACL
33433 as a message is received (see section &<<SECTaddheadacl>>&).
33434
33435 In contrast to what happens in a system filter, header modifications that are
33436 specified on routers and transports apply only to the particular recipient
33437 addresses that are being processed by those routers and transports. These
33438 changes do not actually take place until a copy of the message is being
33439 transported. Therefore, they do not affect the basic set of header lines, and
33440 they do not affect the values of the variables that refer to header lines.
33441
33442 &*Note*&: In particular, this means that any expansions in the configuration of
33443 the transport cannot refer to the modified header lines, because such
33444 expansions all occur before the message is actually transported.
33445
33446 For both routers and transports, the argument of a &%headers_add%&
33447 option must be in the form of one or more RFC 2822 header lines, separated by
33448 newlines (coded as &"\n"&). For example:
33449 .code
33450 headers_add = X-added-header: added by $primary_hostname\n\
33451               X-added-second: another added header line
33452 .endd
33453 Exim does not check the syntax of these added header lines.
33454
33455 Multiple &%headers_add%& options for a single router or transport can be
33456 specified; the values will append to a single list of header lines.
33457 Each header-line is separately expanded.
33458
33459 The argument of a &%headers_remove%& option must consist of a colon-separated
33460 list of header names. This is confusing, because header names themselves are
33461 often terminated by colons. In this case, the colons are the list separators,
33462 not part of the names. For example:
33463 .code
33464 headers_remove = return-receipt-to:acknowledge-to
33465 .endd
33466
33467 Multiple &%headers_remove%& options for a single router or transport can be
33468 specified; the arguments will append to a single header-names list.
33469 Each item is separately expanded.
33470 Note that colons in complex expansions which are used to
33471 form all or part of a &%headers_remove%& list
33472 will act as list separators.
33473
33474 When &%headers_add%& or &%headers_remove%& is specified on a router,
33475 items are expanded at routing time,
33476 and then associated with all addresses that are
33477 accepted by that router, and also with any new addresses that it generates. If
33478 an address passes through several routers as a result of aliasing or
33479 forwarding, the changes are cumulative.
33480
33481 .oindex "&%unseen%&"
33482 However, this does not apply to multiple routers that result from the use of
33483 the &%unseen%& option. Any header modifications that were specified by the
33484 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33485
33486 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33487 settings cannot be delivered together in a batch, so a transport is always
33488 dealing with a set of addresses that have the same header-processing
33489 requirements.
33490
33491 The transport starts by writing the original set of header lines that arrived
33492 with the message, possibly modified by the system filter. As it writes out
33493 these lines, it consults the list of header names that were attached to the
33494 recipient address(es) by &%headers_remove%& options in routers, and it also
33495 consults the transport's own &%headers_remove%& option. Header lines whose
33496 names are on either of these lists are not written out. If there are multiple
33497 instances of any listed header, they are all skipped.
33498
33499 After the remaining original header lines have been written, new header
33500 lines that were specified by routers' &%headers_add%& options are written, in
33501 the order in which they were attached to the address. These are followed by any
33502 header lines specified by the transport's &%headers_add%& option.
33503
33504 This way of handling header line modifications in routers and transports has
33505 the following consequences:
33506
33507 .ilist
33508 The original set of header lines, possibly modified by the system filter,
33509 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33510 to it, at all times.
33511 .next
33512 Header lines that are added by a router's
33513 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33514 expansion syntax in subsequent routers or the transport.
33515 .next
33516 Conversely, header lines that are specified for removal by &%headers_remove%&
33517 in a router remain visible to subsequent routers and the transport.
33518 .next
33519 Headers added to an address by &%headers_add%& in a router cannot be removed by
33520 a later router or by a transport.
33521 .next
33522 An added header can refer to the contents of an original header that is to be
33523 removed, even it has the same name as the added header. For example:
33524 .code
33525 headers_remove = subject
33526 headers_add = Subject: new subject (was: $h_subject:)
33527 .endd
33528 .endlist
33529
33530 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33531 for a &(redirect)& router that has the &%one_time%& option set.
33532
33533
33534
33535
33536
33537 .section "Constructed addresses" "SECTconstr"
33538 .cindex "address" "constructed"
33539 .cindex "constructed address"
33540 When Exim constructs a sender address for a locally-generated message, it uses
33541 the form
33542 .display
33543 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33544 .endd
33545 For example:
33546 .code
33547 Zaphod Beeblebrox <zaphod@end.univ.example>
33548 .endd
33549 The user name is obtained from the &%-F%& command line option if set, or
33550 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33551 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33552 ampersand character, this is replaced by the login name with the first letter
33553 upper cased, as is conventional in a number of operating systems. See the
33554 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33555 The &%unknown_username%& option can be used to specify user names in cases when
33556 there is no password file entry.
33557
33558 .cindex "RFC 2047"
33559 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33560 parts of it if necessary. In addition, if it contains any non-printing
33561 characters, it is encoded as described in RFC 2047, which defines a way of
33562 including non-ASCII characters in header lines. The value of the
33563 &%headers_charset%& option specifies the name of the encoding that is used (the
33564 characters are assumed to be in this encoding). The setting of
33565 &%print_topbitchars%& controls whether characters with the top bit set (that
33566 is, with codes greater than 127) count as printing characters or not.
33567
33568
33569
33570 .section "Case of local parts" "SECID230"
33571 .cindex "case of local parts"
33572 .cindex "local part" "case of"
33573 RFC 2822 states that the case of letters in the local parts of addresses cannot
33574 be assumed to be non-significant. Exim preserves the case of local parts of
33575 addresses, but by default it uses a lower-cased form when it is routing,
33576 because on most Unix systems, usernames are in lower case and case-insensitive
33577 routing is required. However, any particular router can be made to use the
33578 original case for local parts by setting the &%caseful_local_part%& generic
33579 router option.
33580
33581 .cindex "mixed-case login names"
33582 If you must have mixed-case user names on your system, the best way to proceed,
33583 assuming you want case-independent handling of incoming email, is to set up
33584 your first router to convert incoming local parts in your domains to the
33585 correct case by means of a file lookup. For example:
33586 .code
33587 correct_case:
33588   driver = redirect
33589   domains = +local_domains
33590   data = ${lookup{$local_part}cdb\
33591               {/etc/usercased.cdb}{$value}fail}\
33592               @$domain
33593 .endd
33594 For this router, the local part is forced to lower case by the default action
33595 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33596 up a new local part in the correct case. If you then set &%caseful_local_part%&
33597 on any subsequent routers which process your domains, they will operate on
33598 local parts with the correct case in a case-sensitive manner.
33599
33600
33601
33602 .section "Dots in local parts" "SECID231"
33603 .cindex "dot" "in local part"
33604 .cindex "local part" "dots in"
33605 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33606 part may not begin or end with a dot, nor have two consecutive dots in the
33607 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33608 empty components for compatibility.
33609
33610
33611
33612 .section "Rewriting addresses" "SECID232"
33613 .cindex "rewriting" "addresses"
33614 Rewriting of sender and recipient addresses, and addresses in headers, can
33615 happen automatically, or as the result of configuration options, as described
33616 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33617 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33618
33619 Automatic rewriting includes qualification, as mentioned above. The other case
33620 in which it can happen is when an incomplete non-local domain is given. The
33621 routing process may cause this to be expanded into the full domain name. For
33622 example, a header such as
33623 .code
33624 To: hare@teaparty
33625 .endd
33626 might get rewritten as
33627 .code
33628 To: hare@teaparty.wonderland.fict.example
33629 .endd
33630 Rewriting as a result of routing is the one kind of message processing that
33631 does not happen at input time, as it cannot be done until the address has
33632 been routed.
33633
33634 Strictly, one should not do &'any'& deliveries of a message until all its
33635 addresses have been routed, in case any of the headers get changed as a
33636 result of routing. However, doing this in practice would hold up many
33637 deliveries for unreasonable amounts of time, just because one address could not
33638 immediately be routed. Exim therefore does not delay other deliveries when
33639 routing of one or more addresses is deferred.
33640 .ecindex IIDmesproc
33641
33642
33643
33644 . ////////////////////////////////////////////////////////////////////////////
33645 . ////////////////////////////////////////////////////////////////////////////
33646
33647 .chapter "SMTP processing" "CHAPSMTP"
33648 .scindex IIDsmtpproc1 "SMTP" "processing details"
33649 .scindex IIDsmtpproc2 "LMTP" "processing details"
33650 Exim supports a number of different ways of using the SMTP protocol, and its
33651 LMTP variant, which is an interactive protocol for transferring messages into a
33652 closed mail store application. This chapter contains details of how SMTP is
33653 processed. For incoming mail, the following are available:
33654
33655 .ilist
33656 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33657 .next
33658 SMTP over the standard input and output (the &%-bs%& option);
33659 .next
33660 Batched SMTP on the standard input (the &%-bS%& option).
33661 .endlist
33662
33663 For mail delivery, the following are available:
33664
33665 .ilist
33666 SMTP over TCP/IP (the &(smtp)& transport);
33667 .next
33668 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33669 &"lmtp"&);
33670 .next
33671 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33672 transport);
33673 .next
33674 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33675 the &%use_bsmtp%& option set).
33676 .endlist
33677
33678 &'Batched SMTP'& is the name for a process in which batches of messages are
33679 stored in or read from files (or pipes), in a format in which SMTP commands are
33680 used to contain the envelope information.
33681
33682
33683
33684 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33685 .cindex "SMTP" "outgoing over TCP/IP"
33686 .cindex "outgoing SMTP over TCP/IP"
33687 .cindex "LMTP" "over TCP/IP"
33688 .cindex "outgoing LMTP over TCP/IP"
33689 .cindex "EHLO"
33690 .cindex "HELO"
33691 .cindex "SIZE option on MAIL command"
33692 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33693 The &%protocol%& option selects which protocol is to be used, but the actual
33694 processing is the same in both cases.
33695
33696 If, in response to its EHLO command, Exim is told that the SIZE
33697 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33698 command. The value of <&'n'&> is the message size plus the value of the
33699 &%size_addition%& option (default 1024) to allow for additions to the message
33700 such as per-transport header lines, or changes made in a
33701 .cindex "transport" "filter"
33702 .cindex "filter" "transport filter"
33703 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33704 suppressed.
33705
33706 If the remote server advertises support for PIPELINING, Exim uses the
33707 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33708 required for the transaction.
33709
33710 If the remote server advertises support for the STARTTLS command, and Exim
33711 was built to support TLS encryption, it tries to start a TLS session unless the
33712 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33713 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33714 is called for verification.
33715
33716 If the remote server advertises support for the AUTH command, Exim scans
33717 the authenticators configuration for any suitable client settings, as described
33718 in chapter &<<CHAPSMTPAUTH>>&.
33719
33720 .cindex "carriage return"
33721 .cindex "linefeed"
33722 Responses from the remote host are supposed to be terminated by CR followed by
33723 LF. However, there are known to be hosts that do not send CR characters, so in
33724 order to be able to interwork with such hosts, Exim treats LF on its own as a
33725 line terminator.
33726
33727 If a message contains a number of different addresses, all those with the same
33728 characteristics (for example, the same envelope sender) that resolve to the
33729 same set of hosts, in the same order, are sent in a single SMTP transaction,
33730 even if they are for different domains, unless there are more than the setting
33731 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33732 they are split into groups containing no more than &%max_rcpt%&s addresses
33733 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33734 in parallel sessions. The order of hosts with identical MX values is not
33735 significant when checking whether addresses can be batched in this way.
33736
33737 When the &(smtp)& transport suffers a temporary failure that is not
33738 message-related, Exim updates its transport-specific database, which contains
33739 records indexed by host name that remember which messages are waiting for each
33740 particular host. It also updates the retry database with new retry times.
33741
33742 .cindex "hints database" "retry keys"
33743 Exim's retry hints are based on host name plus IP address, so if one address of
33744 a multi-homed host is broken, it will soon be skipped most of the time.
33745 See the next section for more detail about error handling.
33746
33747 .cindex "SMTP" "passed connection"
33748 .cindex "SMTP" "batching over TCP/IP"
33749 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33750 looks in the hints database for the transport to see if there are any queued
33751 messages waiting for the host to which it is connected. If it finds one, it
33752 creates a new Exim process using the &%-MC%& option (which can only be used by
33753 a process running as root or the Exim user) and passes the TCP/IP socket to it
33754 so that it can deliver another message using the same socket. The new process
33755 does only those deliveries that are routed to the connected host, and may in
33756 turn pass the socket on to a third process, and so on.
33757
33758 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33759 limit the number of messages sent down a single TCP/IP connection.
33760
33761 .cindex "asterisk" "after IP address"
33762 The second and subsequent messages delivered down an existing connection are
33763 identified in the main log by the addition of an asterisk after the closing
33764 square bracket of the IP address.
33765
33766
33767
33768
33769 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33770 .cindex "error" "in outgoing SMTP"
33771 .cindex "SMTP" "errors in outgoing"
33772 .cindex "host" "error"
33773 Three different kinds of error are recognized for outgoing SMTP: host errors,
33774 message errors, and recipient errors.
33775
33776 .vlist
33777 .vitem "&*Host errors*&"
33778 A host error is not associated with a particular message or with a
33779 particular recipient of a message. The host errors are:
33780
33781 .ilist
33782 Connection refused or timed out,
33783 .next
33784 Any error response code on connection,
33785 .next
33786 Any error response code to EHLO or HELO,
33787 .next
33788 Loss of connection at any time, except after &"."&,
33789 .next
33790 I/O errors at any time,
33791 .next
33792 Timeouts during the session, other than in response to MAIL, RCPT or
33793 the &"."& at the end of the data.
33794 .endlist ilist
33795
33796 For a host error, a permanent error response on connection, or in response to
33797 EHLO, causes all addresses routed to the host to be failed. Any other host
33798 error causes all addresses to be deferred, and retry data to be created for the
33799 host. It is not tried again, for any message, until its retry time arrives. If
33800 the current set of addresses are not all delivered in this run (to some
33801 alternative host), the message is added to the list of those waiting for this
33802 host, so if it is still undelivered when a subsequent successful delivery is
33803 made to the host, it will be sent down the same SMTP connection.
33804
33805 .vitem "&*Message errors*&"
33806 .cindex "message" "error"
33807 A message error is associated with a particular message when sent to a
33808 particular host, but not with a particular recipient of the message. The
33809 message errors are:
33810
33811 .ilist
33812 Any error response code to MAIL, DATA, or the &"."& that terminates
33813 the data,
33814 .next
33815 Timeout after MAIL,
33816 .next
33817 Timeout or loss of connection after the &"."& that terminates the data. A
33818 timeout after the DATA command itself is treated as a host error, as is loss of
33819 connection at any other time.
33820 .endlist ilist
33821
33822 For a message error, a permanent error response (5&'xx'&) causes all addresses
33823 to be failed, and a delivery error report to be returned to the sender. A
33824 temporary error response (4&'xx'&), or one of the timeouts, causes all
33825 addresses to be deferred. Retry data is not created for the host, but instead,
33826 a retry record for the combination of host plus message id is created. The
33827 message is not added to the list of those waiting for this host. This ensures
33828 that the failing message will not be sent to this host again until the retry
33829 time arrives. However, other messages that are routed to the host are not
33830 affected, so if it is some property of the message that is causing the error,
33831 it will not stop the delivery of other mail.
33832
33833 If the remote host specified support for the SIZE parameter in its response
33834 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33835 over-large message will cause a message error because the error arrives as a
33836 response to MAIL.
33837
33838 .vitem "&*Recipient errors*&"
33839 .cindex "recipient" "error"
33840 A recipient error is associated with a particular recipient of a message. The
33841 recipient errors are:
33842
33843 .ilist
33844 Any error response to RCPT,
33845 .next
33846 Timeout after RCPT.
33847 .endlist
33848
33849 For a recipient error, a permanent error response (5&'xx'&) causes the
33850 recipient address to be failed, and a bounce message to be returned to the
33851 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33852 address to be deferred, and routing retry data to be created for it. This is
33853 used to delay processing of the address in subsequent queue runs, until its
33854 routing retry time arrives. This applies to all messages, but because it
33855 operates only in queue runs, one attempt will be made to deliver a new message
33856 to the failing address before the delay starts to operate. This ensures that,
33857 if the failure is really related to the message rather than the recipient
33858 (&"message too big for this recipient"& is a possible example), other messages
33859 have a chance of getting delivered. If a delivery to the address does succeed,
33860 the retry information gets cleared, so all stuck messages get tried again, and
33861 the retry clock is reset.
33862
33863 The message is not added to the list of those waiting for this host. Use of the
33864 host for other messages is unaffected, and except in the case of a timeout,
33865 other recipients are processed independently, and may be successfully delivered
33866 in the current SMTP session. After a timeout it is of course impossible to
33867 proceed with the session, so all addresses get deferred. However, those other
33868 than the one that failed do not suffer any subsequent retry delays. Therefore,
33869 if one recipient is causing trouble, the others have a chance of getting
33870 through when a subsequent delivery attempt occurs before the failing
33871 recipient's retry time.
33872 .endlist
33873
33874 In all cases, if there are other hosts (or IP addresses) available for the
33875 current set of addresses (for example, from multiple MX records), they are
33876 tried in this run for any undelivered addresses, subject of course to their
33877 own retry data. In other words, recipient error retry data does not take effect
33878 until the next delivery attempt.
33879
33880 Some hosts have been observed to give temporary error responses to every
33881 MAIL command at certain times (&"insufficient space"& has been seen). It
33882 would be nice if such circumstances could be recognized, and defer data for the
33883 host itself created, but this is not possible within the current Exim design.
33884 What actually happens is that retry data for every (host, message) combination
33885 is created.
33886
33887 The reason that timeouts after MAIL and RCPT are treated specially is that
33888 these can sometimes arise as a result of the remote host's verification
33889 procedures. Exim makes this assumption, and treats them as if a temporary error
33890 response had been received. A timeout after &"."& is treated specially because
33891 it is known that some broken implementations fail to recognize the end of the
33892 message if the last character of the last line is a binary zero. Thus, it is
33893 helpful to treat this case as a message error.
33894
33895 Timeouts at other times are treated as host errors, assuming a problem with the
33896 host, or the connection to it. If a timeout after MAIL, RCPT,
33897 or &"."& is really a connection problem, the assumption is that at the next try
33898 the timeout is likely to occur at some other point in the dialogue, causing it
33899 then to be treated as a host error.
33900
33901 There is experimental evidence that some MTAs drop the connection after the
33902 terminating &"."& if they do not like the contents of the message for some
33903 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33904 should be given. That is why Exim treats this case as a message rather than a
33905 host error, in order not to delay other messages to the same host.
33906
33907
33908
33909
33910 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33911 .cindex "SMTP" "incoming over TCP/IP"
33912 .cindex "incoming SMTP over TCP/IP"
33913 .cindex "inetd"
33914 .cindex "daemon"
33915 Incoming SMTP messages can be accepted in one of two ways: by running a
33916 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33917 &_/etc/inetd.conf_& should be like this:
33918 .code
33919 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33920 .endd
33921 Exim distinguishes between this case and the case of a locally running user
33922 agent using the &%-bs%& option by checking whether or not the standard input is
33923 a socket. When it is, either the port must be privileged (less than 1024), or
33924 the caller must be root or the Exim user. If any other user passes a socket
33925 with an unprivileged port number, Exim prints a message on the standard error
33926 stream and exits with an error code.
33927
33928 By default, Exim does not make a log entry when a remote host connects or
33929 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33930 unexpected. It can be made to write such log entries by setting the
33931 &%smtp_connection%& log selector.
33932
33933 .cindex "carriage return"
33934 .cindex "linefeed"
33935 Commands from the remote host are supposed to be terminated by CR followed by
33936 LF. However, there are known to be hosts that do not send CR characters. In
33937 order to be able to interwork with such hosts, Exim treats LF on its own as a
33938 line terminator.
33939 Furthermore, because common code is used for receiving messages from all
33940 sources, a CR on its own is also interpreted as a line terminator. However, the
33941 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33942
33943 .cindex "EHLO" "invalid data"
33944 .cindex "HELO" "invalid data"
33945 One area that sometimes gives rise to problems concerns the EHLO or
33946 HELO commands. Some clients send syntactically invalid versions of these
33947 commands, which Exim rejects by default. (This is nothing to do with verifying
33948 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33949 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33950 match the broken hosts that send invalid commands.
33951
33952 .cindex "SIZE option on MAIL command"
33953 .cindex "MAIL" "SIZE option"
33954 The amount of disk space available is checked whenever SIZE is received on
33955 a MAIL command, independently of whether &%message_size_limit%& or
33956 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33957 false. A temporary error is given if there is not enough space. If
33958 &%check_spool_space%& is set, the check is for that amount of space plus the
33959 value given with SIZE, that is, it checks that the addition of the incoming
33960 message will not reduce the space below the threshold.
33961
33962 When a message is successfully received, Exim includes the local message id in
33963 its response to the final &"."& that terminates the data. If the remote host
33964 logs this text it can help with tracing what has happened to a message.
33965
33966 The Exim daemon can limit the number of simultaneous incoming connections it is
33967 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33968 number of simultaneous incoming connections from a single remote host (see the
33969 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33970 rejected using the SMTP temporary error code 421.
33971
33972 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33973 subprocess has finished, as this can get lost at busy times. Instead, it looks
33974 for completed subprocesses every time it wakes up. Provided there are other
33975 things happening (new incoming calls, starts of queue runs), completed
33976 processes will be noticed and tidied away. On very quiet systems you may
33977 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33978 it will be noticed when the daemon next wakes up.
33979
33980 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33981 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33982 high system load &-- for details see the &%smtp_accept_reserve%&,
33983 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33984 applies in both the daemon and &'inetd'& cases.
33985
33986 Exim normally starts a delivery process for each message received, though this
33987 can be varied by means of the &%-odq%& command line option and the
33988 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33989 number of simultaneously running delivery processes started in this way from
33990 SMTP input can be limited by the &%smtp_accept_queue%& and
33991 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33992 subsequently received messages are just put on the input queue without starting
33993 a delivery process.
33994
33995 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33996 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33997 started up from the &'inetd'& daemon, because in that case each connection is
33998 handled by an entirely independent Exim process. Control by load average is,
33999 however, available with &'inetd'&.
34000
34001 Exim can be configured to verify addresses in incoming SMTP commands as they
34002 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34003 to rewrite addresses at this time &-- before any syntax checking is done. See
34004 section &<<SECTrewriteS>>&.
34005
34006 Exim can also be configured to limit the rate at which a client host submits
34007 MAIL and RCPT commands in a single SMTP session. See the
34008 &%smtp_ratelimit_hosts%& option.
34009
34010
34011
34012 .section "Unrecognized SMTP commands" "SECID234"
34013 .cindex "SMTP" "unrecognized commands"
34014 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34015 commands during a single SMTP connection, it drops the connection after sending
34016 the error response to the last command. The default value for
34017 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34018 abuse that subvert web servers into making connections to SMTP ports; in these
34019 circumstances, a number of non-SMTP lines are sent first.
34020
34021
34022 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34023 .cindex "SMTP" "syntax errors"
34024 .cindex "SMTP" "protocol errors"
34025 A syntax error is detected if an SMTP command is recognized, but there is
34026 something syntactically wrong with its data, for example, a malformed email
34027 address in a RCPT command. Protocol errors include invalid command
34028 sequencing such as RCPT before MAIL. If Exim receives more than
34029 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34030 drops the connection after sending the error response to the last command. The
34031 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34032 broken clients that loop sending bad commands (yes, it has been seen).
34033
34034
34035
34036 .section "Use of non-mail SMTP commands" "SECID236"
34037 .cindex "SMTP" "non-mail commands"
34038 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34039 DATA. Exim counts such commands, and drops the connection if there are too
34040 many of them in a single SMTP session. This action catches some
34041 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34042 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34043 defines what &"too many"& means. Its default value is 10.
34044
34045 When a new message is expected, one occurrence of RSET is not counted. This
34046 allows a client to send one RSET between messages (this is not necessary,
34047 but some clients do it). Exim also allows one uncounted occurrence of HELO
34048 or EHLO, and one occurrence of STARTTLS between messages. After
34049 starting up a TLS session, another EHLO is expected, and so it too is not
34050 counted.
34051
34052 The first occurrence of AUTH in a connection, or immediately following
34053 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34054 RCPT, DATA, and QUIT are counted.
34055
34056 You can control which hosts are subject to the limit set by
34057 &%smtp_accept_max_nonmail%& by setting
34058 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34059 the limit apply to all hosts. This option means that you can exclude any
34060 specific badly-behaved hosts that you have to live with.
34061
34062
34063
34064
34065 .section "The VRFY and EXPN commands" "SECID237"
34066 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34067 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34068 appropriate) in order to decide whether the command should be accepted or not.
34069
34070 .new
34071 .cindex "VRFY" "processing"
34072 When no ACL is defined for VRFY, or if it rejects without
34073 setting an explicit response code, the command is accepted
34074 (with a 252 SMTP response code)
34075 in order to support awkward clients that do a VRFY before every RCPT.
34076 .wen
34077 When VRFY is accepted, it runs exactly the same code as when Exim is
34078 called with the &%-bv%& option, and returns 250/451/550
34079 SMTP response codes.
34080
34081 .cindex "EXPN" "processing"
34082 If no ACL for EXPN is defined, the command is rejected.
34083 When EXPN is accepted, a single-level expansion of the address is done.
34084 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34085 than a verification (the &%-bv%& option). If an unqualified local part is given
34086 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34087 of VRFY and EXPN commands are logged on the main and reject logs, and
34088 VRFY verification failures are logged on the main log for consistency with
34089 RCPT failures.
34090
34091
34092
34093 .section "The ETRN command" "SECTETRN"
34094 .cindex "ETRN" "processing"
34095 RFC 1985 describes an SMTP command called ETRN that is designed to
34096 overcome the security problems of the TURN command (which has fallen into
34097 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34098 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34099 should be accepted or not. If no ACL is defined, the command is rejected.
34100
34101 The ETRN command is concerned with &"releasing"& messages that are awaiting
34102 delivery to certain hosts. As Exim does not organize its message queue by host,
34103 the only form of ETRN that is supported by default is the one where the
34104 text starts with the &"#"& prefix, in which case the remainder of the text is
34105 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34106 the &%-R%& option to happen, with the remainder of the ETRN text as its
34107 argument. For example,
34108 .code
34109 ETRN #brigadoon
34110 .endd
34111 runs the command
34112 .code
34113 exim -R brigadoon
34114 .endd
34115 which causes a delivery attempt on all messages with undelivered addresses
34116 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34117 default), Exim prevents the simultaneous execution of more than one queue run
34118 for the same argument string as a result of an ETRN command. This stops
34119 a misbehaving client from starting more than one queue runner at once.
34120
34121 .cindex "hints database" "ETRN serialization"
34122 Exim implements the serialization by means of a hints database in which a
34123 record is written whenever a process is started by ETRN, and deleted when
34124 the process completes. However, Exim does not keep the SMTP session waiting for
34125 the ETRN process to complete. Once ETRN is accepted, the client is sent
34126 a &"success"& return code. Obviously there is scope for hints records to get
34127 left lying around if there is a system or program crash. To guard against this,
34128 Exim ignores any records that are more than six hours old.
34129
34130 .oindex "&%smtp_etrn_command%&"
34131 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34132 used. This specifies a command that is run whenever ETRN is received,
34133 whatever the form of its argument. For
34134 example:
34135 .code
34136 smtp_etrn_command = /etc/etrn_command $domain \
34137                     $sender_host_address
34138 .endd
34139 .vindex "&$domain$&"
34140 The string is split up into arguments which are independently expanded. The
34141 expansion variable &$domain$& is set to the argument of the ETRN command,
34142 and no syntax checking is done on the contents of this argument. Exim does not
34143 wait for the command to complete, so its status code is not checked. Exim runs
34144 under its own uid and gid when receiving incoming SMTP, so it is not possible
34145 for it to change them before running the command.
34146
34147
34148
34149 .section "Incoming local SMTP" "SECID238"
34150 .cindex "SMTP" "local incoming"
34151 Some user agents use SMTP to pass messages to their local MTA using the
34152 standard input and output, as opposed to passing the envelope on the command
34153 line and writing the message to the standard input. This is supported by the
34154 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34155 messages over TCP/IP (including the use of ACLs), except that the envelope
34156 sender given in a MAIL command is ignored unless the caller is trusted. In
34157 an ACL you can detect this form of SMTP input by testing for an empty host
34158 identification. It is common to have this as the first line in the ACL that
34159 runs for RCPT commands:
34160 .code
34161 accept hosts = :
34162 .endd
34163 This accepts SMTP messages from local processes without doing any other tests.
34164
34165
34166
34167 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34168 .cindex "SMTP" "batched outgoing"
34169 .cindex "batched SMTP output"
34170 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34171 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34172 be output in BSMTP format. No SMTP responses are possible for this form of
34173 delivery. All it is doing is using SMTP commands as a way of transmitting the
34174 envelope along with the message.
34175
34176 The message is written to the file or pipe preceded by the SMTP commands
34177 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34178 the message that start with a dot have an extra dot added. The SMTP command
34179 HELO is not normally used. If it is required, the &%message_prefix%& option
34180 can be used to specify it.
34181
34182 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34183 one recipient address at a time by default. However, you can arrange for them
34184 to handle several addresses at once by setting the &%batch_max%& option. When
34185 this is done for BSMTP, messages may contain multiple RCPT commands. See
34186 chapter &<<CHAPbatching>>& for more details.
34187
34188 .vindex "&$host$&"
34189 When one or more addresses are routed to a BSMTP transport by a router that
34190 sets up a host list, the name of the first host on the list is available to the
34191 transport in the variable &$host$&. Here is an example of such a transport and
34192 router:
34193 .code
34194 begin routers
34195 route_append:
34196   driver = manualroute
34197   transport = smtp_appendfile
34198   route_list = domain.example  batch.host.example
34199
34200 begin transports
34201 smtp_appendfile:
34202   driver = appendfile
34203   directory = /var/bsmtp/$host
34204   batch_max = 1000
34205   use_bsmtp
34206   user = exim
34207 .endd
34208 This causes messages addressed to &'domain.example'& to be written in BSMTP
34209 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34210 message (unless there are more than 1000 recipients).
34211
34212
34213
34214 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34215 .cindex "SMTP" "batched incoming"
34216 .cindex "batched SMTP input"
34217 The &%-bS%& command line option causes Exim to accept one or more messages by
34218 reading SMTP on the standard input, but to generate no responses. If the caller
34219 is trusted, the senders in the MAIL commands are believed; otherwise the
34220 sender is always the caller of Exim. Unqualified senders and receivers are not
34221 rejected (there seems little point) but instead just get qualified. HELO
34222 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34223 as NOOP; QUIT quits.
34224
34225 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34226 ACL is run in the same way as for non-SMTP local input.
34227
34228 If an error is detected while reading a message, including a missing &"."& at
34229 the end, Exim gives up immediately. It writes details of the error to the
34230 standard output in a stylized way that the calling program should be able to
34231 make some use of automatically, for example:
34232 .code
34233 554 Unexpected end of file
34234 Transaction started in line 10
34235 Error detected in line 14
34236 .endd
34237 It writes a more verbose version, for human consumption, to the standard error
34238 file, for example:
34239 .code
34240 An error was detected while processing a file of BSMTP input.
34241 The error message was:
34242
34243 501 '>' missing at end of address
34244
34245 The SMTP transaction started in line 10.
34246 The error was detected in line 12.
34247 The SMTP command at fault was:
34248
34249 rcpt to:<malformed@in.com.plete
34250
34251 1 previous message was successfully processed.
34252 The rest of the batch was abandoned.
34253 .endd
34254 The return code from Exim is zero only if there were no errors. It is 1 if some
34255 messages were accepted before an error was detected, and 2 if no messages were
34256 accepted.
34257 .ecindex IIDsmtpproc1
34258 .ecindex IIDsmtpproc2
34259
34260
34261
34262 . ////////////////////////////////////////////////////////////////////////////
34263 . ////////////////////////////////////////////////////////////////////////////
34264
34265 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34266          "Customizing messages"
34267 When a message fails to be delivered, or remains on the queue for more than a
34268 configured amount of time, Exim sends a message to the original sender, or
34269 to an alternative configured address. The text of these messages is built into
34270 the code of Exim, but it is possible to change it, either by adding a single
34271 string, or by replacing each of the paragraphs by text supplied in a file.
34272
34273 The &'From:'& and &'To:'& header lines are automatically generated; you can
34274 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34275 option. Exim also adds the line
34276 .code
34277 Auto-Submitted: auto-generated
34278 .endd
34279 to all warning and bounce messages,
34280
34281
34282 .section "Customizing bounce messages" "SECID239"
34283 .cindex "customizing" "bounce message"
34284 .cindex "bounce message" "customizing"
34285 If &%bounce_message_text%& is set, its contents are included in the default
34286 message immediately after &"This message was created automatically by mail
34287 delivery software."& The string is not expanded. It is not used if
34288 &%bounce_message_file%& is set.
34289
34290 When &%bounce_message_file%& is set, it must point to a template file for
34291 constructing error messages. The file consists of a series of text items,
34292 separated by lines consisting of exactly four asterisks. If the file cannot be
34293 opened, default text is used and a message is written to the main and panic
34294 logs. If any text item in the file is empty, default text is used for that
34295 item.
34296
34297 .vindex "&$bounce_recipient$&"
34298 .vindex "&$bounce_return_size_limit$&"
34299 Each item of text that is read from the file is expanded, and there are two
34300 expansion variables which can be of use here: &$bounce_recipient$& is set to
34301 the recipient of an error message while it is being created, and
34302 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34303 option, rounded to a whole number.
34304
34305 The items must appear in the file in the following order:
34306
34307 .ilist
34308 The first item is included in the headers, and should include at least a
34309 &'Subject:'& header. Exim does not check the syntax of these headers.
34310 .next
34311 The second item forms the start of the error message. After it, Exim lists the
34312 failing addresses with their error messages.
34313 .next
34314 The third item is used to introduce any text from pipe transports that is to be
34315 returned to the sender. It is omitted if there is no such text.
34316 .next
34317 The fourth, fifth and sixth items will be ignored and may be empty.
34318 The fields exist for back-compatibility
34319 .endlist
34320
34321 The default state (&%bounce_message_file%& unset) is equivalent to the
34322 following file, in which the sixth item is empty. The &'Subject:'& and some
34323 other lines have been split in order to fit them on the page:
34324 .code
34325 Subject: Mail delivery failed
34326   ${if eq{$sender_address}{$bounce_recipient}
34327   {: returning message to sender}}
34328 ****
34329 This message was created automatically by mail delivery software.
34330
34331 A message ${if eq{$sender_address}{$bounce_recipient}
34332   {that you sent }{sent by
34333
34334 <$sender_address>
34335
34336 }}could not be delivered to all of its recipients.
34337 This is a permanent error. The following address(es) failed:
34338 ****
34339 The following text was generated during the delivery attempt(s):
34340 ****
34341 ------ This is a copy of the message, including all the headers.
34342   ------
34343 ****
34344 ------ The body of the message is $message_size characters long;
34345   only the first
34346 ------ $bounce_return_size_limit or so are included here.
34347 ****
34348 .endd
34349 .section "Customizing warning messages" "SECTcustwarn"
34350 .cindex "customizing" "warning message"
34351 .cindex "warning of delay" "customizing the message"
34352 The option &%warn_message_file%& can be pointed at a template file for use when
34353 warnings about message delays are created. In this case there are only three
34354 text sections:
34355
34356 .ilist
34357 The first item is included in the headers, and should include at least a
34358 &'Subject:'& header. Exim does not check the syntax of these headers.
34359 .next
34360 The second item forms the start of the warning message. After it, Exim lists
34361 the delayed addresses.
34362 .next
34363 The third item then ends the message.
34364 .endlist
34365
34366 The default state is equivalent to the following file, except that some lines
34367 have been split here, in order to fit them on the page:
34368 .code
34369 Subject: Warning: message $message_exim_id delayed
34370   $warn_message_delay
34371 ****
34372 This message was created automatically by mail delivery software.
34373
34374 A message ${if eq{$sender_address}{$warn_message_recipients}
34375 {that you sent }{sent by
34376
34377 <$sender_address>
34378
34379 }}has not been delivered to all of its recipients after
34380 more than $warn_message_delay on the queue on $primary_hostname.
34381
34382 The message identifier is:     $message_exim_id
34383 The subject of the message is: $h_subject
34384 The date of the message is:    $h_date
34385
34386 The following address(es) have not yet been delivered:
34387 ****
34388 No action is required on your part. Delivery attempts will
34389 continue for some time, and this warning may be repeated at
34390 intervals if the message remains undelivered. Eventually the
34391 mail delivery software will give up, and when that happens,
34392 the message will be returned to you.
34393 .endd
34394 .vindex "&$warn_message_delay$&"
34395 .vindex "&$warn_message_recipients$&"
34396 However, in the default state the subject and date lines are omitted if no
34397 appropriate headers exist. During the expansion of this file,
34398 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34399 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34400 of recipients for the warning message. There may be more than one if there are
34401 multiple addresses with different &%errors_to%& settings on the routers that
34402 handled them.
34403
34404
34405
34406
34407 . ////////////////////////////////////////////////////////////////////////////
34408 . ////////////////////////////////////////////////////////////////////////////
34409
34410 .chapter "Some common configuration settings" "CHAPcomconreq"
34411 This chapter discusses some configuration settings that seem to be fairly
34412 common. More examples and discussion can be found in the Exim book.
34413
34414
34415
34416 .section "Sending mail to a smart host" "SECID240"
34417 .cindex "smart host" "example router"
34418 If you want to send all mail for non-local domains to a &"smart host"&, you
34419 should replace the default &(dnslookup)& router with a router which does the
34420 routing explicitly:
34421 .code
34422 send_to_smart_host:
34423   driver = manualroute
34424   route_list = !+local_domains smart.host.name
34425   transport = remote_smtp
34426 .endd
34427 You can use the smart host's IP address instead of the name if you wish.
34428 If you are using Exim only to submit messages to a smart host, and not for
34429 receiving incoming messages, you can arrange for it to do the submission
34430 synchronously by setting the &%mua_wrapper%& option (see chapter
34431 &<<CHAPnonqueueing>>&).
34432
34433
34434
34435
34436 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34437 .cindex "mailing lists"
34438 Exim can be used to run simple mailing lists, but for large and/or complicated
34439 requirements, the use of additional specialized mailing list software such as
34440 Majordomo or Mailman is recommended.
34441
34442 The &(redirect)& router can be used to handle mailing lists where each list
34443 is maintained in a separate file, which can therefore be managed by an
34444 independent manager. The &%domains%& router option can be used to run these
34445 lists in a separate domain from normal mail. For example:
34446 .code
34447 lists:
34448   driver = redirect
34449   domains = lists.example
34450   file = /usr/lists/$local_part
34451   forbid_pipe
34452   forbid_file
34453   errors_to = $local_part-request@lists.example
34454   no_more
34455 .endd
34456 This router is skipped for domains other than &'lists.example'&. For addresses
34457 in that domain, it looks for a file that matches the local part. If there is no
34458 such file, the router declines, but because &%no_more%& is set, no subsequent
34459 routers are tried, and so the whole delivery fails.
34460
34461 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34462 expanded into a file name or a pipe delivery, which is usually inappropriate in
34463 a mailing list.
34464
34465 .oindex "&%errors_to%&"
34466 The &%errors_to%& option specifies that any delivery errors caused by addresses
34467 taken from a mailing list are to be sent to the given address rather than the
34468 original sender of the message. However, before acting on this, Exim verifies
34469 the error address, and ignores it if verification fails.
34470
34471 For example, using the configuration above, mail sent to
34472 &'dicts@lists.example'& is passed on to those addresses contained in
34473 &_/usr/lists/dicts_&, with error reports directed to
34474 &'dicts-request@lists.example'&, provided that this address can be verified.
34475 There could be a file called &_/usr/lists/dicts-request_& containing
34476 the address(es) of this particular list's manager(s), but other approaches,
34477 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34478 or &%local_part_suffix%& options) to handle addresses of the form
34479 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34480
34481
34482
34483 .section "Syntax errors in mailing lists" "SECID241"
34484 .cindex "mailing lists" "syntax errors in"
34485 If an entry in redirection data contains a syntax error, Exim normally defers
34486 delivery of the original address. That means that a syntax error in a mailing
34487 list holds up all deliveries to the list. This may not be appropriate when a
34488 list is being maintained automatically from data supplied by users, and the
34489 addresses are not rigorously checked.
34490
34491 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34492 entries that fail to parse, noting the incident in the log. If in addition
34493 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34494 whenever a broken address is skipped. It is usually appropriate to set
34495 &%syntax_errors_to%& to the same address as &%errors_to%&.
34496
34497
34498
34499 .section "Re-expansion of mailing lists" "SECID242"
34500 .cindex "mailing lists" "re-expansion of"
34501 Exim remembers every individual address to which a message has been delivered,
34502 in order to avoid duplication, but it normally stores only the original
34503 recipient addresses with a message. If all the deliveries to a mailing list
34504 cannot be done at the first attempt, the mailing list is re-expanded when the
34505 delivery is next tried. This means that alterations to the list are taken into
34506 account at each delivery attempt, so addresses that have been added to
34507 the list since the message arrived will therefore receive a copy of the
34508 message, even though it pre-dates their subscription.
34509
34510 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34511 on the &(redirect)& router. If this is done, any addresses generated by the
34512 router that fail to deliver at the first attempt are added to the message as
34513 &"top level"& addresses, and the parent address that generated them is marked
34514 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34515 subsequent delivery attempts. The disadvantage of this is that if any of the
34516 failing addresses are incorrect, correcting them in the file has no effect on
34517 pre-existing messages.
34518
34519 The original top-level address is remembered with each of the generated
34520 addresses, and is output in any log messages. However, any intermediate parent
34521 addresses are not recorded. This makes a difference to the log only if the
34522 &%all_parents%& selector is set, but for mailing lists there is normally only
34523 one level of expansion anyway.
34524
34525
34526
34527 .section "Closed mailing lists" "SECID243"
34528 .cindex "mailing lists" "closed"
34529 The examples so far have assumed open mailing lists, to which anybody may
34530 send mail. It is also possible to set up closed lists, where mail is accepted
34531 from specified senders only. This is done by making use of the generic
34532 &%senders%& option to restrict the router that handles the list.
34533
34534 The following example uses the same file as a list of recipients and as a list
34535 of permitted senders. It requires three routers:
34536 .code
34537 lists_request:
34538   driver = redirect
34539   domains = lists.example
34540   local_part_suffix = -request
34541   file = /usr/lists/$local_part$local_part_suffix
34542   no_more
34543
34544 lists_post:
34545   driver = redirect
34546   domains = lists.example
34547   senders = ${if exists {/usr/lists/$local_part}\
34548              {lsearch;/usr/lists/$local_part}{*}}
34549   file = /usr/lists/$local_part
34550   forbid_pipe
34551   forbid_file
34552   errors_to = $local_part-request@lists.example
34553   no_more
34554
34555 lists_closed:
34556   driver = redirect
34557   domains = lists.example
34558   allow_fail
34559   data = :fail: $local_part@lists.example is a closed mailing list
34560 .endd
34561 All three routers have the same &%domains%& setting, so for any other domains,
34562 they are all skipped. The first router runs only if the local part ends in
34563 &%-request%&. It handles messages to the list manager(s) by means of an open
34564 mailing list.
34565
34566 The second router runs only if the &%senders%& precondition is satisfied. It
34567 checks for the existence of a list that corresponds to the local part, and then
34568 checks that the sender is on the list by means of a linear search. It is
34569 necessary to check for the existence of the file before trying to search it,
34570 because otherwise Exim thinks there is a configuration error. If the file does
34571 not exist, the expansion of &%senders%& is *, which matches all senders. This
34572 means that the router runs, but because there is no list, declines, and
34573 &%no_more%& ensures that no further routers are run. The address fails with an
34574 &"unrouteable address"& error.
34575
34576 The third router runs only if the second router is skipped, which happens when
34577 a mailing list exists, but the sender is not on it. This router forcibly fails
34578 the address, giving a suitable error message.
34579
34580
34581
34582
34583 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34584 .cindex "VERP"
34585 .cindex "Variable Envelope Return Paths"
34586 .cindex "envelope sender"
34587 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34588 are a way of helping mailing list administrators discover which subscription
34589 address is the cause of a particular delivery failure. The idea is to encode
34590 the original recipient address in the outgoing envelope sender address, so that
34591 if the message is forwarded by another host and then subsequently bounces, the
34592 original recipient can be extracted from the recipient address of the bounce.
34593
34594 .oindex &%errors_to%&
34595 .oindex &%return_path%&
34596 Envelope sender addresses can be modified by Exim using two different
34597 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34598 list examples), or the &%return_path%& option on a transport. The second of
34599 these is effective only if the message is successfully delivered to another
34600 host; it is not used for errors detected on the local host (see the description
34601 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34602 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34603 .code
34604 verp_smtp:
34605   driver = smtp
34606   max_rcpt = 1
34607   return_path = \
34608     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34609       {$1-request+$local_part=$domain@your.dom.example}fail}
34610 .endd
34611 This has the effect of rewriting the return path (envelope sender) on outgoing
34612 SMTP messages, if the local part of the original return path ends in
34613 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34614 local part and domain of the recipient into the return path. Suppose, for
34615 example, that a message whose return path has been set to
34616 &'somelist-request@your.dom.example'& is sent to
34617 &'subscriber@other.dom.example'&. In the transport, the return path is
34618 rewritten as
34619 .code
34620 somelist-request+subscriber=other.dom.example@your.dom.example
34621 .endd
34622 .vindex "&$local_part$&"
34623 For this to work, you must tell Exim to send multiple copies of messages that
34624 have more than one recipient, so that each copy has just one recipient. This is
34625 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34626 might be sent to several different recipients in the same domain, in which case
34627 &$local_part$& is not available in the transport, because it is not unique.
34628
34629 Unless your host is doing nothing but mailing list deliveries, you should
34630 probably use a separate transport for the VERP deliveries, so as not to use
34631 extra resources in making one-per-recipient copies for other deliveries. This
34632 can easily be done by expanding the &%transport%& option in the router:
34633 .code
34634 dnslookup:
34635   driver = dnslookup
34636   domains = ! +local_domains
34637   transport = \
34638     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34639       {verp_smtp}{remote_smtp}}
34640   no_more
34641 .endd
34642 If you want to change the return path using &%errors_to%& in a router instead
34643 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34644 routers that handle mailing list addresses. This will ensure that all delivery
34645 errors, including those detected on the local host, are sent to the VERP
34646 address.
34647
34648 On a host that does no local deliveries and has no manual routing, only the
34649 &(dnslookup)& router needs to be changed. A special transport is not needed for
34650 SMTP deliveries. Every mailing list recipient has its own return path value,
34651 and so Exim must hand them to the transport one at a time. Here is an example
34652 of a &(dnslookup)& router that implements VERP:
34653 .code
34654 verp_dnslookup:
34655   driver = dnslookup
34656   domains = ! +local_domains
34657   transport = remote_smtp
34658   errors_to = \
34659     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34660      {$1-request+$local_part=$domain@your.dom.example}fail}
34661   no_more
34662 .endd
34663 Before you start sending out messages with VERPed return paths, you must also
34664 configure Exim to accept the bounce messages that come back to those paths.
34665 Typically this is done by setting a &%local_part_suffix%& option for a
34666 router, and using this to route the messages to wherever you want to handle
34667 them.
34668
34669 The overhead incurred in using VERP depends very much on the size of the
34670 message, the number of recipient addresses that resolve to the same remote
34671 host, and the speed of the connection over which the message is being sent. If
34672 a lot of addresses resolve to the same host and the connection is slow, sending
34673 a separate copy of the message for each address may take substantially longer
34674 than sending a single copy with many recipients (for which VERP cannot be
34675 used).
34676
34677
34678
34679
34680
34681
34682 .section "Virtual domains" "SECTvirtualdomains"
34683 .cindex "virtual domains"
34684 .cindex "domain" "virtual"
34685 The phrase &'virtual domain'& is unfortunately used with two rather different
34686 meanings:
34687
34688 .ilist
34689 A domain for which there are no real mailboxes; all valid local parts are
34690 aliases for other email addresses. Common examples are organizational
34691 top-level domains and &"vanity"& domains.
34692 .next
34693 One of a number of independent domains that are all handled by the same host,
34694 with mailboxes on that host, but where the mailbox owners do not necessarily
34695 have login accounts on that host.
34696 .endlist
34697
34698 The first usage is probably more common, and does seem more &"virtual"& than
34699 the second. This kind of domain can be handled in Exim with a straightforward
34700 aliasing router. One approach is to create a separate alias file for each
34701 virtual domain. Exim can test for the existence of the alias file to determine
34702 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34703 to a router of this form:
34704 .code
34705 virtual:
34706   driver = redirect
34707   domains = dsearch;/etc/mail/virtual
34708   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34709   no_more
34710 .endd
34711 The &%domains%& option specifies that the router is to be skipped, unless there
34712 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34713 domain that is being processed. When the router runs, it looks up the local
34714 part in the file to find a new address (or list of addresses). The &%no_more%&
34715 setting ensures that if the lookup fails (leading to &%data%& being an empty
34716 string), Exim gives up on the address without trying any subsequent routers.
34717
34718 This one router can handle all the virtual domains because the alias file names
34719 follow a fixed pattern. Permissions can be arranged so that appropriate people
34720 can edit the different alias files. A successful aliasing operation results in
34721 a new envelope recipient address, which is then routed from scratch.
34722
34723 The other kind of &"virtual"& domain can also be handled in a straightforward
34724 way. One approach is to create a file for each domain containing a list of
34725 valid local parts, and use it in a router like this:
34726 .code
34727 my_domains:
34728   driver = accept
34729   domains = dsearch;/etc/mail/domains
34730   local_parts = lsearch;/etc/mail/domains/$domain
34731   transport = my_mailboxes
34732 .endd
34733 The address is accepted if there is a file for the domain, and the local part
34734 can be found in the file. The &%domains%& option is used to check for the
34735 file's existence because &%domains%& is tested before the &%local_parts%&
34736 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34737 because that option is tested after &%local_parts%&. The transport is as
34738 follows:
34739 .code
34740 my_mailboxes:
34741   driver = appendfile
34742   file = /var/mail/$domain/$local_part
34743   user = mail
34744 .endd
34745 This uses a directory of mailboxes for each domain. The &%user%& setting is
34746 required, to specify which uid is to be used for writing to the mailboxes.
34747
34748 The configuration shown here is just one example of how you might support this
34749 requirement. There are many other ways this kind of configuration can be set
34750 up, for example, by using a database instead of separate files to hold all the
34751 information about the domains.
34752
34753
34754
34755 .section "Multiple user mailboxes" "SECTmulbox"
34756 .cindex "multiple mailboxes"
34757 .cindex "mailbox" "multiple"
34758 .cindex "local part" "prefix"
34759 .cindex "local part" "suffix"
34760 Heavy email users often want to operate with multiple mailboxes, into which
34761 incoming mail is automatically sorted. A popular way of handling this is to
34762 allow users to use multiple sender addresses, so that replies can easily be
34763 identified. Users are permitted to add prefixes or suffixes to their local
34764 parts for this purpose. The wildcard facility of the generic router options
34765 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34766 example, consider this router:
34767 .code
34768 userforward:
34769   driver = redirect
34770   check_local_user
34771   file = $home/.forward
34772   local_part_suffix = -*
34773   local_part_suffix_optional
34774   allow_filter
34775 .endd
34776 .vindex "&$local_part_suffix$&"
34777 It runs a user's &_.forward_& file for all local parts of the form
34778 &'username-*'&. Within the filter file the user can distinguish different
34779 cases by testing the variable &$local_part_suffix$&. For example:
34780 .code
34781 if $local_part_suffix contains -special then
34782 save /home/$local_part/Mail/special
34783 endif
34784 .endd
34785 If the filter file does not exist, or does not deal with such addresses, they
34786 fall through to subsequent routers, and, assuming no subsequent use of the
34787 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34788 control over which suffixes are valid.
34789
34790 Alternatively, a suffix can be used to trigger the use of a different
34791 &_.forward_& file &-- which is the way a similar facility is implemented in
34792 another MTA:
34793 .code
34794 userforward:
34795   driver = redirect
34796   check_local_user
34797   file = $home/.forward$local_part_suffix
34798   local_part_suffix = -*
34799   local_part_suffix_optional
34800   allow_filter
34801 .endd
34802 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34803 example, &_.forward-special_& is used. Once again, if the appropriate file
34804 does not exist, or does not deal with the address, it is passed on to
34805 subsequent routers, which could, if required, look for an unqualified
34806 &_.forward_& file to use as a default.
34807
34808
34809
34810 .section "Simplified vacation processing" "SECID244"
34811 .cindex "vacation processing"
34812 The traditional way of running the &'vacation'& program is for a user to set up
34813 a pipe command in a &_.forward_& file
34814 (see section &<<SECTspecitredli>>& for syntax details).
34815 This is prone to error by inexperienced users. There are two features of Exim
34816 that can be used to make this process simpler for users:
34817
34818 .ilist
34819 A local part prefix such as &"vacation-"& can be specified on a router which
34820 can cause the message to be delivered directly to the &'vacation'& program, or
34821 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34822 &_.forward_& file are then much simpler. For example:
34823 .code
34824 spqr, vacation-spqr
34825 .endd
34826 .next
34827 The &%require_files%& generic router option can be used to trigger a
34828 vacation delivery by checking for the existence of a certain file in the
34829 user's home directory. The &%unseen%& generic option should also be used, to
34830 ensure that the original delivery also proceeds. In this case, all the user has
34831 to do is to create a file called, say, &_.vacation_&, containing a vacation
34832 message.
34833 .endlist
34834
34835 Another advantage of both these methods is that they both work even when the
34836 use of arbitrary pipes by users is locked out.
34837
34838
34839
34840 .section "Taking copies of mail" "SECID245"
34841 .cindex "message" "copying every"
34842 Some installations have policies that require archive copies of all messages to
34843 be made. A single copy of each message can easily be taken by an appropriate
34844 command in a system filter, which could, for example, use a different file for
34845 each day's messages.
34846
34847 There is also a shadow transport mechanism that can be used to take copies of
34848 messages that are successfully delivered by local transports, one copy per
34849 delivery. This could be used, &'inter alia'&, to implement automatic
34850 notification of delivery by sites that insist on doing such things.
34851
34852
34853
34854 .section "Intermittently connected hosts" "SECID246"
34855 .cindex "intermittently connected hosts"
34856 It has become quite common (because it is cheaper) for hosts to connect to the
34857 Internet periodically rather than remain connected all the time. The normal
34858 arrangement is that mail for such hosts accumulates on a system that is
34859 permanently connected.
34860
34861 Exim was designed for use on permanently connected hosts, and so it is not
34862 particularly well-suited to use in an intermittently connected environment.
34863 Nevertheless there are some features that can be used.
34864
34865
34866 .section "Exim on the upstream server host" "SECID247"
34867 It is tempting to arrange for incoming mail for the intermittently connected
34868 host to remain on Exim's queue until the client connects. However, this
34869 approach does not scale very well. Two different kinds of waiting message are
34870 being mixed up in the same queue &-- those that cannot be delivered because of
34871 some temporary problem, and those that are waiting for their destination host
34872 to connect. This makes it hard to manage the queue, as well as wasting
34873 resources, because each queue runner scans the entire queue.
34874
34875 A better approach is to separate off those messages that are waiting for an
34876 intermittently connected host. This can be done by delivering these messages
34877 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34878 format, from where they are transmitted by other software when their
34879 destination connects. This makes it easy to collect all the mail for one host
34880 in a single directory, and to apply local timeout rules on a per-message basis
34881 if required.
34882
34883 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34884 you are doing this, you should configure Exim with a long retry period for the
34885 intermittent host. For example:
34886 .code
34887 cheshire.wonderland.fict.example    *   F,5d,24h
34888 .endd
34889 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34890 which messages it has queued up for that host. Once the intermittent host comes
34891 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34892 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34893 causes all the queued up messages to be delivered, often down a single SMTP
34894 connection. While the host remains connected, any new messages get delivered
34895 immediately.
34896
34897 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34898 issued with a different IP address each time it connects, Exim's retry
34899 mechanisms on the holding host get confused, because the IP address is normally
34900 used as part of the key string for holding retry information. This can be
34901 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34902 Since this has disadvantages for permanently connected hosts, it is best to
34903 arrange a separate transport for the intermittently connected ones.
34904
34905
34906
34907 .section "Exim on the intermittently connected client host" "SECID248"
34908 The value of &%smtp_accept_queue_per_connection%& should probably be
34909 increased, or even set to zero (that is, disabled) on the intermittently
34910 connected host, so that all incoming messages down a single connection get
34911 delivered immediately.
34912
34913 .cindex "SMTP" "passed connection"
34914 .cindex "SMTP" "multiple deliveries"
34915 .cindex "multiple SMTP deliveries"
34916 Mail waiting to be sent from an intermittently connected host will probably
34917 not have been routed, because without a connection DNS lookups are not
34918 possible. This means that if a normal queue run is done at connection time,
34919 each message is likely to be sent in a separate SMTP session. This can be
34920 avoided by starting the queue run with a command line option beginning with
34921 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34922 first pass, routing is done but no deliveries take place. The second pass is a
34923 normal queue run; since all the messages have been previously routed, those
34924 destined for the same host are likely to get sent as multiple deliveries in a
34925 single SMTP connection.
34926
34927
34928
34929 . ////////////////////////////////////////////////////////////////////////////
34930 . ////////////////////////////////////////////////////////////////////////////
34931
34932 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34933          "Exim as a non-queueing client"
34934 .cindex "client, non-queueing"
34935 .cindex "smart host" "suppressing queueing"
34936 On a personal computer, it is a common requirement for all
34937 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34938 configured to operate that way, for all the popular operating systems.
34939 However, there are some MUAs for Unix-like systems that cannot be so
34940 configured: they submit messages using the command line interface of
34941 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34942 messages this way.
34943
34944 If the personal computer runs continuously, there is no problem, because it can
34945 run a conventional MTA that handles delivery to the smart host, and deal with
34946 any delays via its queueing mechanism. However, if the computer does not run
34947 continuously or runs different operating systems at different times, queueing
34948 email is not desirable.
34949
34950 There is therefore a requirement for something that can provide the
34951 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34952 any queueing or retrying facilities. Furthermore, the delivery to the smart
34953 host should be synchronous, so that if it fails, the sending MUA is immediately
34954 informed. In other words, we want something that extends an MUA that submits
34955 to a local MTA via the command line so that it behaves like one that submits
34956 to a remote smart host using TCP/SMTP.
34957
34958 There are a number of applications (for example, there is one called &'ssmtp'&)
34959 that do this job. However, people have found them to be lacking in various
34960 ways. For instance, you might want to allow aliasing and forwarding to be done
34961 before sending a message to the smart host.
34962
34963 Exim already had the necessary infrastructure for doing this job. Just a few
34964 tweaks were needed to make it behave as required, though it is somewhat of an
34965 overkill to use a fully-featured MTA for this purpose.
34966
34967 .oindex "&%mua_wrapper%&"
34968 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34969 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34970 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34971 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34972 compatible router and transport configuration. Typically there will be just one
34973 router and one transport, sending everything to a smart host.
34974
34975 When run in MUA wrapping mode, the behaviour of Exim changes in the
34976 following ways:
34977
34978 .ilist
34979 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34980 In other words, the only way to submit messages is via the command line.
34981 .next
34982 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34983 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34984 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34985 does not finish until the delivery attempt is complete. If the delivery is
34986 successful, a zero return code is given.
34987 .next
34988 Address redirection is permitted, but the final routing for all addresses must
34989 be to the same remote transport, and to the same list of hosts. Furthermore,
34990 the return address (envelope sender) must be the same for all recipients, as
34991 must any added or deleted header lines. In other words, it must be possible to
34992 deliver the message in a single SMTP transaction, however many recipients there
34993 are.
34994 .next
34995 If these conditions are not met, or if routing any address results in a
34996 failure or defer status, or if Exim is unable to deliver all the recipients
34997 successfully to one of the smart hosts, delivery of the entire message fails.
34998 .next
34999 Because no queueing is allowed, all failures are treated as permanent; there
35000 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35001 smart host. Furthermore, because only a single yes/no response can be given to
35002 the caller, it is not possible to deliver to some recipients and not others. If
35003 there is an error (temporary or permanent) for any recipient, all are failed.
35004 .next
35005 If more than one smart host is listed, Exim will try another host after a
35006 connection failure or a timeout, in the normal way. However, if this kind of
35007 failure happens for all the hosts, the delivery fails.
35008 .next
35009 When delivery fails, an error message is written to the standard error stream
35010 (as well as to Exim's log), and Exim exits to the caller with a return code
35011 value 1. The message is expunged from Exim's spool files. No bounce messages
35012 are ever generated.
35013 .next
35014 No retry data is maintained, and any retry rules are ignored.
35015 .next
35016 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35017 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35018 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35019 .endlist
35020
35021 The overall effect is that Exim makes a single synchronous attempt to deliver
35022 the message, failing if there is any kind of problem. Because no local
35023 deliveries are done and no daemon can be run, Exim does not need root
35024 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35025 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35026 the advantages and disadvantages of running without root privilege.
35027
35028
35029
35030
35031 . ////////////////////////////////////////////////////////////////////////////
35032 . ////////////////////////////////////////////////////////////////////////////
35033
35034 .chapter "Log files" "CHAPlog"
35035 .scindex IIDloggen "log" "general description"
35036 .cindex "log" "types of"
35037 Exim writes three different logs, referred to as the main log, the reject log,
35038 and the panic log:
35039
35040 .ilist
35041 .cindex "main log"
35042 The main log records the arrival of each message and each delivery in a single
35043 line in each case. The format is as compact as possible, in an attempt to keep
35044 down the size of log files. Two-character flag sequences make it easy to pick
35045 out these lines. A number of other events are recorded in the main log. Some of
35046 them are optional, in which case the &%log_selector%& option controls whether
35047 they are included or not. A Perl script called &'eximstats'&, which does simple
35048 analysis of main log files, is provided in the Exim distribution (see section
35049 &<<SECTmailstat>>&).
35050 .next
35051 .cindex "reject log"
35052 The reject log records information from messages that are rejected as a result
35053 of a configuration option (that is, for policy reasons).
35054 The first line of each rejection is a copy of the line that is also written to
35055 the main log. Then, if the message's header has been read at the time the log
35056 is written, its contents are written to this log. Only the original header
35057 lines are available; header lines added by ACLs are not logged. You can use the
35058 reject log to check that your policy controls are working correctly; on a busy
35059 host this may be easier than scanning the main log for rejection messages. You
35060 can suppress the writing of the reject log by setting &%write_rejectlog%&
35061 false.
35062 .next
35063 .cindex "panic log"
35064 .cindex "system log"
35065 When certain serious errors occur, Exim writes entries to its panic log. If the
35066 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35067 are usually written to the main log as well, but can get lost amid the mass of
35068 other entries. The panic log should be empty under normal circumstances. It is
35069 therefore a good idea to check it (or to have a &'cron'& script check it)
35070 regularly, in order to become aware of any problems. When Exim cannot open its
35071 panic log, it tries as a last resort to write to the system log (syslog). This
35072 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35073 message itself is written at priority LOG_CRIT.
35074 .endlist
35075
35076 Every log line starts with a timestamp, in the format shown in the following
35077 example. Note that many of the examples shown in this chapter are line-wrapped.
35078 In the log file, this would be all on one line:
35079 .code
35080 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35081   by QUIT
35082 .endd
35083 By default, the timestamps are in the local timezone. There are two
35084 ways of changing this:
35085
35086 .ilist
35087 You can set the &%timezone%& option to a different time zone; in particular, if
35088 you set
35089 .code
35090 timezone = UTC
35091 .endd
35092 the timestamps will be in UTC (aka GMT).
35093 .next
35094 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35095 example:
35096 .code
35097 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35098 .endd
35099 .endlist
35100
35101 .cindex "log" "process ids in"
35102 .cindex "pid (process id)" "in log lines"
35103 Exim does not include its process id in log lines by default, but you can
35104 request that it does so by specifying the &`pid`& log selector (see section
35105 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35106 brackets, immediately after the time and date.
35107
35108
35109
35110
35111 .section "Where the logs are written" "SECTwhelogwri"
35112 .cindex "log" "destination"
35113 .cindex "log" "to file"
35114 .cindex "log" "to syslog"
35115 .cindex "syslog"
35116 The logs may be written to local files, or to syslog, or both. However, it
35117 should be noted that many syslog implementations use UDP as a transport, and
35118 are therefore unreliable in the sense that messages are not guaranteed to
35119 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35120 It has also been reported that on large log files (tens of megabytes) you may
35121 need to tweak syslog to prevent it syncing the file with each write &-- on
35122 Linux this has been seen to make syslog take 90% plus of CPU time.
35123
35124 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35125 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35126 configuration. This latter string is expanded, so it can contain, for example,
35127 references to the host name:
35128 .code
35129 log_file_path = /var/log/$primary_hostname/exim_%slog
35130 .endd
35131 It is generally advisable, however, to set the string in &_Local/Makefile_&
35132 rather than at run time, because then the setting is available right from the
35133 start of Exim's execution. Otherwise, if there's something it wants to log
35134 before it has read the configuration file (for example, an error in the
35135 configuration file) it will not use the path you want, and may not be able to
35136 log at all.
35137
35138 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35139 list, currently limited to at most two items. This is one option where the
35140 facility for changing a list separator may not be used. The list must always be
35141 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35142 otherwise the item must either be an absolute path, containing &`%s`& at the
35143 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35144 implying the use of a default path.
35145
35146 When Exim encounters an empty item in the list, it searches the list defined by
35147 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35148 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35149 mean &"use the path specified at build time"&. It no such item exists, log
35150 files are written in the &_log_& subdirectory of the spool directory. This is
35151 equivalent to the setting:
35152 .code
35153 log_file_path = $spool_directory/log/%slog
35154 .endd
35155 If you do not specify anything at build time or run time,
35156 or if you unset the option at run time (i.e. &`log_file_path = `&),
35157 that is where the logs are written.
35158
35159 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35160 are in use &-- see section &<<SECTdatlogfil>>& below.
35161
35162 Here are some examples of possible settings:
35163 .display
35164 &`LOG_FILE_PATH=syslog                    `& syslog only
35165 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35166 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35167 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35168 .endd
35169 If there are more than two paths in the list, the first is used and a panic
35170 error is logged.
35171
35172
35173
35174 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35175 .cindex "log" "cycling local files"
35176 .cindex "cycling logs"
35177 .cindex "&'exicyclog'&"
35178 .cindex "log" "local files; writing to"
35179 Some operating systems provide centralized and standardized methods for cycling
35180 log files. For those that do not, a utility script called &'exicyclog'& is
35181 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35182 main and reject logs each time it is called. The maximum number of old logs to
35183 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35184
35185 An Exim delivery process opens the main log when it first needs to write to it,
35186 and it keeps the file open in case subsequent entries are required &-- for
35187 example, if a number of different deliveries are being done for the same
35188 message. However, remote SMTP deliveries can take a long time, and this means
35189 that the file may be kept open long after it is renamed if &'exicyclog'& or
35190 something similar is being used to rename log files on a regular basis. To
35191 ensure that a switch of log files is noticed as soon as possible, Exim calls
35192 &[stat()]& on the main log's name before reusing an open file, and if the file
35193 does not exist, or its inode has changed, the old file is closed and Exim
35194 tries to open the main log from scratch. Thus, an old log file may remain open
35195 for quite some time, but no Exim processes should write to it once it has been
35196 renamed.
35197
35198
35199
35200 .section "Datestamped log files" "SECTdatlogfil"
35201 .cindex "log" "datestamped files"
35202 Instead of cycling the main and reject log files by renaming them
35203 periodically, some sites like to use files whose names contain a datestamp,
35204 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35205 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35206 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35207 point where the datestamp is required. For example:
35208 .code
35209 log_file_path = /var/spool/exim/log/%slog-%D
35210 log_file_path = /var/log/exim-%s-%D.log
35211 log_file_path = /var/spool/exim/log/%D-%slog
35212 log_file_path = /var/log/exim/%s.%M
35213 .endd
35214 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35215 examples of names generated by the above examples:
35216 .code
35217 /var/spool/exim/log/mainlog-20021225
35218 /var/log/exim-reject-20021225.log
35219 /var/spool/exim/log/20021225-mainlog
35220 /var/log/exim/main.200212
35221 .endd
35222 When this form of log file is specified, Exim automatically switches to new
35223 files at midnight. It does not make any attempt to compress old logs; you
35224 will need to write your own script if you require this. You should not
35225 run &'exicyclog'& with this form of logging.
35226
35227 The location of the panic log is also determined by &%log_file_path%&, but it
35228 is not datestamped, because rotation of the panic log does not make sense.
35229 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35230 the string. In addition, if it immediately follows a slash, a following
35231 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35232 character is removed. Thus, the four examples above would give these panic
35233 log names:
35234 .code
35235 /var/spool/exim/log/paniclog
35236 /var/log/exim-panic.log
35237 /var/spool/exim/log/paniclog
35238 /var/log/exim/panic
35239 .endd
35240
35241
35242 .section "Logging to syslog" "SECID249"
35243 .cindex "log" "syslog; writing to"
35244 The use of syslog does not change what Exim logs or the format of its messages,
35245 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35246 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35247 that, the same strings are written to syslog as to log files. The syslog
35248 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35249 by default, but you can change these by setting the &%syslog_facility%& and
35250 &%syslog_processname%& options, respectively. If Exim was compiled with
35251 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35252 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35253 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35254 the time and host name to each line.
35255 The three log streams are mapped onto syslog priorities as follows:
35256
35257 .ilist
35258 &'mainlog'& is mapped to LOG_INFO
35259 .next
35260 &'rejectlog'& is mapped to LOG_NOTICE
35261 .next
35262 &'paniclog'& is mapped to LOG_ALERT
35263 .endlist
35264
35265 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35266 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35267 these are routed by syslog to the same place. You can suppress this duplication
35268 by setting &%syslog_duplication%& false.
35269
35270 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35271 entries contain multiple lines when headers are included. To cope with both
35272 these cases, entries written to syslog are split into separate &[syslog()]&
35273 calls at each internal newline, and also after a maximum of
35274 870 data characters. (This allows for a total syslog line length of 1024, when
35275 additions such as timestamps are added.) If you are running a syslog
35276 replacement that can handle lines longer than the 1024 characters allowed by
35277 RFC 3164, you should set
35278 .code
35279 SYSLOG_LONG_LINES=yes
35280 .endd
35281 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35282 lines, but it still splits at internal newlines in &'reject'& log entries.
35283
35284 To make it easy to re-assemble split lines later, each component of a split
35285 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35286 where <&'n'&> is the component number and <&'m'&> is the total number of
35287 components in the entry. The / delimiter is used when the line was split
35288 because it was too long; if it was split because of an internal newline, the \
35289 delimiter is used. For example, supposing the length limit to be 50 instead of
35290 870, the following would be the result of a typical rejection message to
35291 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35292 name, and pid as added by syslog:
35293 .code
35294 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35295 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35296 [3/5]  when scanning for sender: missing or malformed lo
35297 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35298 [5/5] mple>)
35299 .endd
35300 The same error might cause the following lines to be written to &"rejectlog"&
35301 (LOG_NOTICE):
35302 .code
35303 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35304 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35305 [3/18] er when scanning for sender: missing or malformed
35306 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35307 [5\18] .example>)
35308 [6\18] Recipients: ph10@some.domain.cam.example
35309 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35310 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35311 [9\18]        id 16RdAL-0006pc-00
35312 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35313 [11\18] 09:43 +0100
35314 [12\18] F From: <>
35315 [13\18]   Subject: this is a test header
35316 [18\18]   X-something: this is another header
35317 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35318 [16\18] le>
35319 [17\18] B Bcc:
35320 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35321 .endd
35322 Log lines that are neither too long nor contain newlines are written to syslog
35323 without modification.
35324
35325 If only syslog is being used, the Exim monitor is unable to provide a log tail
35326 display, unless syslog is routing &'mainlog'& to a file on the local host and
35327 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35328 where it is.
35329
35330
35331
35332 .section "Log line flags" "SECID250"
35333 One line is written to the main log for each message received, and for each
35334 successful, unsuccessful, and delayed delivery. These lines can readily be
35335 picked out by the distinctive two-character flags that immediately follow the
35336 timestamp. The flags are:
35337 .display
35338 &`<=`&     message arrival
35339 &`=>`&     normal message delivery
35340 &`->`&     additional address in same delivery
35341 &`>>`&     cutthrough message delivery
35342 &`*>`&     delivery suppressed by &%-N%&
35343 &`**`&     delivery failed; address bounced
35344 &`==`&     delivery deferred; temporary problem
35345 .endd
35346
35347
35348 .section "Logging message reception" "SECID251"
35349 .cindex "log" "reception line"
35350 The format of the single-line entry in the main log that is written for every
35351 message received is shown in the basic example below, which is split over
35352 several lines in order to fit it on the page:
35353 .code
35354 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35355   H=mailer.fict.example [192.168.123.123] U=exim
35356   P=smtp S=5678 id=<incoming message id>
35357 .endd
35358 The address immediately following &"<="& is the envelope sender address. A
35359 bounce message is shown with the sender address &"<>"&, and if it is locally
35360 generated, this is followed by an item of the form
35361 .code
35362 R=<message id>
35363 .endd
35364 which is a reference to the message that caused the bounce to be sent.
35365
35366 .cindex "HELO"
35367 .cindex "EHLO"
35368 For messages from other hosts, the H and U fields identify the remote host and
35369 record the RFC 1413 identity of the user that sent the message, if one was
35370 received. The number given in square brackets is the IP address of the sending
35371 host. If there is a single, unparenthesized  host name in the H field, as
35372 above, it has been verified to correspond to the IP address (see the
35373 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35374 by the remote host in the SMTP HELO or EHLO command, and has not been
35375 verified. If verification yields a different name to that given for HELO or
35376 EHLO, the verified name appears first, followed by the HELO or EHLO
35377 name in parentheses.
35378
35379 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35380 without brackets, in the HELO or EHLO command, leading to entries in
35381 the log containing text like these examples:
35382 .code
35383 H=(10.21.32.43) [192.168.8.34]
35384 H=([10.21.32.43]) [192.168.8.34]
35385 .endd
35386 This can be confusing. Only the final address in square brackets can be relied
35387 on.
35388
35389 For locally generated messages (that is, messages not received over TCP/IP),
35390 the H field is omitted, and the U field contains the login name of the caller
35391 of Exim.
35392
35393 .cindex "authentication" "logging"
35394 .cindex "AUTH" "logging"
35395 For all messages, the P field specifies the protocol used to receive the
35396 message. This is the value that is stored in &$received_protocol$&. In the case
35397 of incoming SMTP messages, the value indicates whether or not any SMTP
35398 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35399 session was encrypted, there is an additional X field that records the cipher
35400 suite that was used.
35401
35402 .cindex log protocol
35403 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35404 hosts that have authenticated themselves using the SMTP AUTH command. The first
35405 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35406 there is an additional item A= followed by the name of the authenticator that
35407 was used. If an authenticated identification was set up by the authenticator's
35408 &%server_set_id%& option, this is logged too, separated by a colon from the
35409 authenticator name.
35410
35411 .cindex "size" "of message"
35412 The id field records the existing message id, if present. The size of the
35413 received message is given by the S field. When the message is delivered,
35414 headers may be removed or added, so that the size of delivered copies of the
35415 message may not correspond with this value (and indeed may be different to each
35416 other).
35417
35418 The &%log_selector%& option can be used to request the logging of additional
35419 data when a message is received. See section &<<SECTlogselector>>& below.
35420
35421
35422
35423 .section "Logging deliveries" "SECID252"
35424 .cindex "log" "delivery line"
35425 The format of the single-line entry in the main log that is written for every
35426 delivery is shown in one of the examples below, for local and remote
35427 deliveries, respectively. Each example has been split into multiple lines in order
35428 to fit it on the page:
35429 .code
35430 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35431   <marv@hitch.fict.example> R=localuser T=local_delivery
35432 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35433   monk@holistic.fict.example R=dnslookup T=remote_smtp
35434   H=holistic.fict.example [192.168.234.234]
35435 .endd
35436 For ordinary local deliveries, the original address is given in angle brackets
35437 after the final delivery address, which might be a pipe or a file. If
35438 intermediate address(es) exist between the original and the final address, the
35439 last of these is given in parentheses after the final address. The R and T
35440 fields record the router and transport that were used to process the address.
35441
35442 If SMTP AUTH was used for the delivery there is an additional item A=
35443 followed by the name of the authenticator that was used.
35444 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35445 option, this is logged too, separated by a colon from the authenticator name.
35446
35447 If a shadow transport was run after a successful local delivery, the log line
35448 for the successful delivery has an item added on the end, of the form
35449 .display
35450 &`ST=<`&&'shadow transport name'&&`>`&
35451 .endd
35452 If the shadow transport did not succeed, the error message is put in
35453 parentheses afterwards.
35454
35455 .cindex "asterisk" "after IP address"
35456 When more than one address is included in a single delivery (for example, two
35457 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35458 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35459 down a single SMTP connection, an asterisk follows the IP address in the log
35460 lines for the second and subsequent messages.
35461
35462 .cindex "delivery" "cutthrough; logging"
35463 .cindex "cutthrough" "logging"
35464 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35465 line precedes the reception line, since cutthrough waits for a possible
35466 rejection from the destination in case it can reject the sourced item.
35467
35468 The generation of a reply message by a filter file gets logged as a
35469 &"delivery"& to the addressee, preceded by &">"&.
35470
35471 The &%log_selector%& option can be used to request the logging of additional
35472 data when a message is delivered. See section &<<SECTlogselector>>& below.
35473
35474
35475 .section "Discarded deliveries" "SECID253"
35476 .cindex "discarded messages"
35477 .cindex "message" "discarded"
35478 .cindex "delivery" "discarded; logging"
35479 When a message is discarded as a result of the command &"seen finish"& being
35480 obeyed in a filter file which generates no deliveries, a log entry of the form
35481 .code
35482 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35483   <low.club@bridge.example> R=userforward
35484 .endd
35485 is written, to record why no deliveries are logged. When a message is discarded
35486 because it is aliased to &":blackhole:"& the log line is like this:
35487 .code
35488 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35489   <hole@nowhere.example> R=blackhole_router
35490 .endd
35491
35492
35493 .section "Deferred deliveries" "SECID254"
35494 When a delivery is deferred, a line of the following form is logged:
35495 .code
35496 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35497   R=dnslookup T=smtp defer (146): Connection refused
35498 .endd
35499 In the case of remote deliveries, the error is the one that was given for the
35500 last IP address that was tried. Details of individual SMTP failures are also
35501 written to the log, so the above line would be preceded by something like
35502 .code
35503 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35504   mail1.endrest.example [192.168.239.239]: Connection refused
35505 .endd
35506 When a deferred address is skipped because its retry time has not been reached,
35507 a message is written to the log, but this can be suppressed by setting an
35508 appropriate value in &%log_selector%&.
35509
35510
35511
35512 .section "Delivery failures" "SECID255"
35513 .cindex "delivery" "failure; logging"
35514 If a delivery fails because an address cannot be routed, a line of the
35515 following form is logged:
35516 .code
35517 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35518   <jim@trek99.example>: unknown mail domain
35519 .endd
35520 If a delivery fails at transport time, the router and transport are shown, and
35521 the response from the remote host is included, as in this example:
35522 .code
35523 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35524   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35525   after pipelined RCPT TO:<ace400@pb.example>: host
35526   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35527   <ace400@pb.example>...Addressee unknown
35528 .endd
35529 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35530 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35531 disabling PIPELINING. The log lines for all forms of delivery failure are
35532 flagged with &`**`&.
35533
35534
35535
35536 .section "Fake deliveries" "SECID256"
35537 .cindex "delivery" "fake; logging"
35538 If a delivery does not actually take place because the &%-N%& option has been
35539 used to suppress it, a normal delivery line is written to the log, except that
35540 &"=>"& is replaced by &"*>"&.
35541
35542
35543
35544 .section "Completion" "SECID257"
35545 A line of the form
35546 .code
35547 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35548 .endd
35549 is written to the main log when a message is about to be removed from the spool
35550 at the end of its processing.
35551
35552
35553
35554
35555 .section "Summary of Fields in Log Lines" "SECID258"
35556 .cindex "log" "summary of fields"
35557 A summary of the field identifiers that are used in log lines is shown in
35558 the following table:
35559 .display
35560 &`A   `&        authenticator name (and optional id and sender)
35561 &`C   `&        SMTP confirmation on delivery
35562 &`    `&        command list for &"no mail in SMTP session"&
35563 &`CV  `&        certificate verification status
35564 &`D   `&        duration of &"no mail in SMTP session"&
35565 &`DN  `&        distinguished name from peer certificate
35566 &`DT  `&        on &`=>`& lines: time taken for a delivery
35567 &`F   `&        sender address (on delivery lines)
35568 &`H   `&        host name and IP address
35569 &`I   `&        local interface used
35570 &`id  `&        message id for incoming message
35571 &`P   `&        on &`<=`& lines: protocol used
35572 &`    `&        on &`=>`& and &`**`& lines: return path
35573 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35574 &`QT  `&        on &`=>`& lines: time spent on queue so far
35575 &`    `&        on &"Completed"& lines: time spent on queue
35576 &`R   `&        on &`<=`& lines: reference for local bounce
35577 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35578 &`S   `&        size of message
35579 &`SNI `&        server name indication from TLS client hello
35580 &`ST  `&        shadow transport name
35581 &`T   `&        on &`<=`& lines: message subject (topic)
35582 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35583 &`U   `&        local user or RFC 1413 identity
35584 &`X   `&        TLS cipher suite
35585 .endd
35586
35587
35588 .section "Other log entries" "SECID259"
35589 Various other types of log entry are written from time to time. Most should be
35590 self-explanatory. Among the more common are:
35591
35592 .ilist
35593 .cindex "retry" "time not reached"
35594 &'retry time not reached'&&~&~An address previously suffered a temporary error
35595 during routing or local delivery, and the time to retry has not yet arrived.
35596 This message is not written to an individual message log file unless it happens
35597 during the first delivery attempt.
35598 .next
35599 &'retry time not reached for any host'&&~&~An address previously suffered
35600 temporary errors during remote delivery, and the retry time has not yet arrived
35601 for any of the hosts to which it is routed.
35602 .next
35603 .cindex "spool directory" "file locked"
35604 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35605 some other Exim process is already working on the message. This can be quite
35606 common if queue running processes are started at frequent intervals. The
35607 &'exiwhat'& utility script can be used to find out what Exim processes are
35608 doing.
35609 .next
35610 .cindex "error" "ignored"
35611 &'error ignored'&&~&~There are several circumstances that give rise to this
35612 message:
35613 .olist
35614 Exim failed to deliver a bounce message whose age was greater than
35615 &%ignore_bounce_errors_after%&. The bounce was discarded.
35616 .next
35617 A filter file set up a delivery using the &"noerror"& option, and the delivery
35618 failed. The delivery was discarded.
35619 .next
35620 A delivery set up by a router configured with
35621 . ==== As this is a nested list, any displays it contains must be indented
35622 . ==== as otherwise they are too far to the left.
35623 .code
35624     errors_to = <>
35625 .endd
35626 failed. The delivery was discarded.
35627 .endlist olist
35628 .endlist ilist
35629
35630
35631
35632
35633
35634 .section "Reducing or increasing what is logged" "SECTlogselector"
35635 .cindex "log" "selectors"
35636 By setting the &%log_selector%& global option, you can disable some of Exim's
35637 default logging, or you can request additional logging. The value of
35638 &%log_selector%& is made up of names preceded by plus or minus characters. For
35639 example:
35640 .code
35641 log_selector = +arguments -retry_defer
35642 .endd
35643 The list of optional log items is in the following table, with the default
35644 selection marked by asterisks:
35645 .display
35646 &` 8bitmime                   `&  received 8BITMIME status
35647 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35648 &` address_rewrite            `&  address rewriting
35649 &` all_parents                `&  all parents in => lines
35650 &` arguments                  `&  command line arguments
35651 &`*connection_reject          `&  connection rejections
35652 &`*delay_delivery             `&  immediate delivery delayed
35653 &` deliver_time               `&  time taken to perform delivery
35654 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35655 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35656 &`*etrn                       `&  ETRN commands
35657 &`*host_lookup_failed         `&  as it says
35658 &` ident_timeout              `&  timeout for ident connection
35659 &` incoming_interface         `&  local interface on <= and => lines
35660 &` incoming_port              `&  remote port on <= lines
35661 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35662 .new
35663 &` outgoing_interface         `&  local interface on => lines
35664 .wen
35665 &` outgoing_port              `&  add remote port to => lines
35666 &`*queue_run                  `&  start and end queue runs
35667 &` queue_time                 `&  time on queue for one recipient
35668 &` queue_time_overall         `&  time on queue for whole message
35669 &` pid                        `&  Exim process id
35670 .new
35671 &` proxy                      `&  proxy address on <= and => lines
35672 .wen
35673 &` received_recipients        `&  recipients on <= lines
35674 &` received_sender            `&  sender on <= lines
35675 &`*rejected_header            `&  header contents on reject log
35676 &`*retry_defer                `&  &"retry time not reached"&
35677 &` return_path_on_delivery    `&  put return path on => and ** lines
35678 &` sender_on_delivery         `&  add sender to => lines
35679 &`*sender_verify_fail         `&  sender verification failures
35680 &`*size_reject                `&  rejection because too big
35681 &`*skip_delivery              `&  delivery skipped in a queue run
35682 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35683 &` smtp_connection            `&  incoming SMTP connections
35684 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35685 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35686 &` smtp_no_mail               `&  session with no MAIL commands
35687 &` smtp_protocol_error        `&  SMTP protocol errors
35688 &` smtp_syntax_error          `&  SMTP syntax errors
35689 &` subject                    `&  contents of &'Subject:'& on <= lines
35690 &`*tls_certificate_verified   `&  certificate verification status
35691 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35692 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35693 &` tls_sni                    `&  TLS SNI on <= lines
35694 &` unknown_in_list            `&  DNS lookup failed in list match
35695
35696 &` all                        `&  all of the above
35697 .endd
35698 See also the &%slow_lookup_log%& main configuration option,
35699 section &<<SECID99>>&
35700
35701 More details on each of these items follows:
35702
35703 .ilist
35704 .cindex "8BITMIME"
35705 .cindex "log" "8BITMIME"
35706 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35707 which may help in tracking down interoperability issues with ancient MTAs
35708 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35709 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35710 &`7BIT`& and &`8BITMIME`& respectively.
35711 .next
35712 .cindex "&%warn%& ACL verb" "log when skipping"
35713 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35714 its conditions cannot be evaluated, a log line to this effect is written if
35715 this log selector is set.
35716 .next
35717 .cindex "log" "rewriting"
35718 .cindex "rewriting" "logging"
35719 &%address_rewrite%&: This applies both to global rewrites and per-transport
35720 rewrites, but not to rewrites in filters run as an unprivileged user (because
35721 such users cannot access the log).
35722 .next
35723 .cindex "log" "full parentage"
35724 &%all_parents%&: Normally only the original and final addresses are logged on
35725 delivery lines; with this selector, intermediate parents are given in
35726 parentheses between them.
35727 .next
35728 .cindex "log" "Exim arguments"
35729 .cindex "Exim arguments, logging"
35730 &%arguments%&: This causes Exim to write the arguments with which it was called
35731 to the main log, preceded by the current working directory. This is a debugging
35732 feature, added to make it easier to find out how certain MUAs call
35733 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35734 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35735 that are empty or that contain white space are quoted. Non-printing characters
35736 are shown as escape sequences. This facility cannot log unrecognized arguments,
35737 because the arguments are checked before the configuration file is read. The
35738 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35739 between the caller and Exim.
35740 .next
35741 .cindex "log" "connection rejections"
35742 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35743 connection is rejected, for whatever reason.
35744 .next
35745 .cindex "log" "delayed delivery"
35746 .cindex "delayed delivery, logging"
35747 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35748 started for an incoming message because the load is too high or too many
35749 messages were received on one connection. Logging does not occur if no delivery
35750 process is started because &%queue_only%& is set or &%-odq%& was used.
35751 .next
35752 .cindex "log" "delivery duration"
35753 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35754 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35755 .next
35756 .cindex "log" "message size on delivery"
35757 .cindex "size" "of message"
35758 &%delivery_size%&: For each delivery, the size of message delivered is added to
35759 the &"=>"& line, tagged with S=.
35760 .next
35761 .cindex "log" "dnslist defer"
35762 .cindex "DNS list" "logging defer"
35763 .cindex "black list (DNS)"
35764 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35765 DNS black list suffers a temporary error.
35766 .next
35767 .cindex "log" "ETRN commands"
35768 .cindex "ETRN" "logging"
35769 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35770 is run to determine whether or not it is actually accepted. An invalid ETRN
35771 command, or one received within a message transaction is not logged by this
35772 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35773 .next
35774 .cindex "log" "host lookup failure"
35775 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35776 any addresses, or when a lookup of an IP address fails to find a host name, a
35777 log line is written. This logging does not apply to direct DNS lookups when
35778 routing email addresses, but it does apply to &"byname"& lookups.
35779 .next
35780 .cindex "log" "ident timeout"
35781 .cindex "RFC 1413" "logging timeout"
35782 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35783 client's ident port times out.
35784 .next
35785 .cindex "log" "incoming interface"
35786 .cindex "log" "local interface"
35787 .cindex "log" "local address and port"
35788 .cindex "TCP/IP" "logging local address and port"
35789 .cindex "interface" "logging"
35790 &%incoming_interface%&: The interface on which a message was received is added
35791 to the &"<="& line as an IP address in square brackets, tagged by I= and
35792 followed by a colon and the port number. The local interface and port are also
35793 added to other SMTP log lines, for example &"SMTP connection from"&, to
35794 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35795 .new
35796 The latter can be disabled by turning off the &%outgoing_interface%& option.
35797 .wen
35798 .next
35799 .new
35800 .cindex log "incoming proxy address"
35801 .cindex proxy "logging proxy address"
35802 .cindex "TCP/IP" "logging proxy address"
35803 &%proxy%&: The internal (closest to the system running Exim) IP address
35804 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35805 on a proxied connection
35806 or the &"=>"& line for a message delivered on a proxied connection..
35807 See &<<SECTproxyInbound>>& for more information.
35808 .wen
35809 .next
35810 .cindex "log" "incoming remote port"
35811 .cindex "port" "logging remote"
35812 .cindex "TCP/IP" "logging incoming remote port"
35813 .vindex "&$sender_fullhost$&"
35814 .vindex "&$sender_rcvhost$&"
35815 &%incoming_port%&: The remote port number from which a message was received is
35816 added to log entries and &'Received:'& header lines, following the IP address
35817 in square brackets, and separated from it by a colon. This is implemented by
35818 changing the value that is put in the &$sender_fullhost$& and
35819 &$sender_rcvhost$& variables. Recording the remote port number has become more
35820 important with the widening use of NAT (see RFC 2505).
35821 .next
35822 .cindex "log" "dropped connection"
35823 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35824 connection is unexpectedly dropped.
35825 .next
35826 .cindex "log" "outgoing interface"
35827 .cindex "log" "local interface"
35828 .cindex "log" "local address and port"
35829 .cindex "TCP/IP" "logging local address and port"
35830 .cindex "interface" "logging"
35831 .new
35832 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35833 interface on which a message was sent is added to delivery lines as an I= tag
35834 followed by IP address in square brackets. You can disable this by turning
35835 off the &%outgoing_interface%& option.
35836 .wen
35837 .next
35838 .cindex "log" "outgoing remote port"
35839 .cindex "port" "logging outgoint remote"
35840 .cindex "TCP/IP" "logging ougtoing remote port"
35841 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35842 containing => tags) following the IP address.
35843 .new
35844 The local port is also added if &%incoming_interface%& and
35845 &%outgoing_interface%& are both enabled.
35846 .wen
35847 This option is not included in the default setting, because for most ordinary
35848 configurations, the remote port number is always 25 (the SMTP port), and the
35849 local port is a random ephemeral port.
35850 .next
35851 .cindex "log" "process ids in"
35852 .cindex "pid (process id)" "in log lines"
35853 &%pid%&: The current process id is added to every log line, in square brackets,
35854 immediately after the time and date.
35855 .next
35856 .cindex "log" "queue run"
35857 .cindex "queue runner" "logging"
35858 &%queue_run%&: The start and end of every queue run are logged.
35859 .next
35860 .cindex "log" "queue time"
35861 &%queue_time%&: The amount of time the message has been in the queue on the
35862 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35863 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35864 includes reception time as well as the delivery time for the current address.
35865 This means that it may be longer than the difference between the arrival and
35866 delivery log line times, because the arrival log line is not written until the
35867 message has been successfully received.
35868 .next
35869 &%queue_time_overall%&: The amount of time the message has been in the queue on
35870 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35871 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35872 message, so it includes reception time as well as the total delivery time.
35873 .next
35874 .cindex "log" "recipients"
35875 &%received_recipients%&: The recipients of a message are listed in the main log
35876 as soon as the message is received. The list appears at the end of the log line
35877 that is written when a message is received, preceded by the word &"for"&. The
35878 addresses are listed after they have been qualified, but before any rewriting
35879 has taken place.
35880 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35881 in the list.
35882 .next
35883 .cindex "log" "sender reception"
35884 &%received_sender%&: The unrewritten original sender of a message is added to
35885 the end of the log line that records the message's arrival, after the word
35886 &"from"& (before the recipients if &%received_recipients%& is also set).
35887 .next
35888 .cindex "log" "header lines for rejection"
35889 &%rejected_header%&: If a message's header has been received at the time a
35890 rejection is written to the reject log, the complete header is added to the
35891 log. Header logging can be turned off individually for messages that are
35892 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35893 .next
35894 .cindex "log" "retry defer"
35895 &%retry_defer%&: A log line is written if a delivery is deferred because a
35896 retry time has not yet been reached. However, this &"retry time not reached"&
35897 message is always omitted from individual message logs after the first delivery
35898 attempt.
35899 .next
35900 .cindex "log" "return path"
35901 &%return_path_on_delivery%&: The return path that is being transmitted with
35902 the message is included in delivery and bounce lines, using the tag P=.
35903 This is omitted if no delivery actually happens, for example, if routing fails,
35904 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35905 .next
35906 .cindex "log" "sender on delivery"
35907 &%sender_on_delivery%&: The message's sender address is added to every delivery
35908 and bounce line, tagged by F= (for &"from"&).
35909 This is the original sender that was received with the message; it is not
35910 necessarily the same as the outgoing return path.
35911 .next
35912 .cindex "log" "sender verify failure"
35913 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35914 gives details of a sender verification failure is not written. Log lines for
35915 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35916 detail is lost.
35917 .next
35918 .cindex "log" "size rejection"
35919 &%size_reject%&: A log line is written whenever a message is rejected because
35920 it is too big.
35921 .next
35922 .cindex "log" "frozen messages; skipped"
35923 .cindex "frozen messages" "logging skipping"
35924 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35925 queue run because it is frozen or because another process is already delivering
35926 it.
35927 .cindex "&""spool file is locked""&"
35928 The message that is written is &"spool file is locked"&.
35929 .next
35930 .cindex "log" "smtp confirmation"
35931 .cindex "SMTP" "logging confirmation"
35932 .cindex "LMTP" "logging confirmation"
35933 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35934 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35935 A number of MTAs (including Exim) return an identifying string in this
35936 response.
35937 .next
35938 .cindex "log" "SMTP connections"
35939 .cindex "SMTP" "logging connections"
35940 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
35941 established or closed, unless the connection is from a host that matches
35942 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35943 only when the closure is unexpected.) This applies to connections from local
35944 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35945 dropped in the middle of a message, a log line is always written, whether or
35946 not this selector is set, but otherwise nothing is written at the start and end
35947 of connections unless this selector is enabled.
35948
35949 For TCP/IP connections to an Exim daemon, the current number of connections is
35950 included in the log message for each new connection, but note that the count is
35951 reset if the daemon is restarted.
35952 Also, because connections are closed (and the closure is logged) in
35953 subprocesses, the count may not include connections that have been closed but
35954 whose termination the daemon has not yet noticed. Thus, while it is possible to
35955 match up the opening and closing of connections in the log, the value of the
35956 logged counts may not be entirely accurate.
35957 .next
35958 .cindex "log" "SMTP transaction; incomplete"
35959 .cindex "SMTP" "logging incomplete transactions"
35960 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35961 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35962 and the message sender plus any accepted recipients are included in the log
35963 line. This can provide evidence of dictionary attacks.
35964 .next
35965 .cindex "log" "non-MAIL SMTP sessions"
35966 .cindex "MAIL" "logging session without"
35967 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35968 connection terminates without having issued a MAIL command. This includes both
35969 the case when the connection is dropped, and the case when QUIT is used. It
35970 does not include cases where the connection is rejected right at the start (by
35971 an ACL, or because there are too many connections, or whatever). These cases
35972 already have their own log lines.
35973
35974 The log line that is written contains the identity of the client in the usual
35975 way, followed by D= and a time, which records the duration of the connection.
35976 If the connection was authenticated, this fact is logged exactly as it is for
35977 an incoming message, with an A= item. If the connection was encrypted, CV=,
35978 DN=, and X= items may appear as they do for an incoming message, controlled by
35979 the same logging options.
35980
35981 Finally, if any SMTP commands were issued during the connection, a C= item
35982 is added to the line, listing the commands that were used. For example,
35983 .code
35984 C=EHLO,QUIT
35985 .endd
35986 shows that the client issued QUIT straight after EHLO. If there were fewer
35987 than 20 commands, they are all listed. If there were more than 20 commands,
35988 the last 20 are listed, preceded by &"..."&. However, with the default
35989 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
35990 have been aborted before 20 non-mail commands are processed.
35991 .next
35992 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35993 colon-separated, is appended to the A= item for a message arrival or delivery
35994 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35995 was accepted or used.
35996 .next
35997 .cindex "log" "SMTP protocol error"
35998 .cindex "SMTP" "logging protocol error"
35999 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36000 encountered. Exim does not have perfect detection of all protocol errors
36001 because of transmission delays and the use of pipelining. If PIPELINING has
36002 been advertised to a client, an Exim server assumes that the client will use
36003 it, and therefore it does not count &"expected"& errors (for example, RCPT
36004 received after rejecting MAIL) as protocol errors.
36005 .next
36006 .cindex "SMTP" "logging syntax errors"
36007 .cindex "SMTP" "syntax errors; logging"
36008 .cindex "SMTP" "unknown command; logging"
36009 .cindex "log" "unknown SMTP command"
36010 .cindex "log" "SMTP syntax error"
36011 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36012 encountered. An unrecognized command is treated as a syntax error. For an
36013 external connection, the host identity is given; for an internal connection
36014 using &%-bs%& the sender identification (normally the calling user) is given.
36015 .next
36016 .cindex "log" "subject"
36017 .cindex "subject, logging"
36018 &%subject%&: The subject of the message is added to the arrival log line,
36019 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36020 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36021 specifies whether characters with values greater than 127 should be logged
36022 unchanged, or whether they should be rendered as escape sequences.
36023 .next
36024 .cindex "log" "certificate verification"
36025 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36026 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36027 verified, and &`CV=no`& if not.
36028 .next
36029 .cindex "log" "TLS cipher"
36030 .cindex "TLS" "logging cipher"
36031 &%tls_cipher%&: When a message is sent or received over an encrypted
36032 connection, the cipher suite used is added to the log line, preceded by X=.
36033 .next
36034 .cindex "log" "TLS peer DN"
36035 .cindex "TLS" "logging peer DN"
36036 &%tls_peerdn%&: When a message is sent or received over an encrypted
36037 connection, and a certificate is supplied by the remote host, the peer DN is
36038 added to the log line, preceded by DN=.
36039 .next
36040 .cindex "log" "TLS SNI"
36041 .cindex "TLS" "logging SNI"
36042 &%tls_sni%&: When a message is received over an encrypted connection, and
36043 the remote host provided the Server Name Indication extension, the SNI is
36044 added to the log line, preceded by SNI=.
36045 .next
36046 .cindex "log" "DNS failure in list"
36047 &%unknown_in_list%&: This setting causes a log entry to be written when the
36048 result of a list match is failure because a DNS lookup failed.
36049 .endlist
36050
36051
36052 .section "Message log" "SECID260"
36053 .cindex "message" "log file for"
36054 .cindex "log" "message log; description of"
36055 .cindex "&_msglog_& directory"
36056 .oindex "&%preserve_message_logs%&"
36057 In addition to the general log files, Exim writes a log file for each message
36058 that it handles. The names of these per-message logs are the message ids, and
36059 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36060 message log contains copies of the log lines that apply to the message. This
36061 makes it easier to inspect the status of an individual message without having
36062 to search the main log. A message log is deleted when processing of the message
36063 is complete, unless &%preserve_message_logs%& is set, but this should be used
36064 only with great care because they can fill up your disk very quickly.
36065
36066 On a heavily loaded system, it may be desirable to disable the use of
36067 per-message logs, in order to reduce disk I/O. This can be done by setting the
36068 &%message_logs%& option false.
36069 .ecindex IIDloggen
36070
36071
36072
36073
36074 . ////////////////////////////////////////////////////////////////////////////
36075 . ////////////////////////////////////////////////////////////////////////////
36076
36077 .chapter "Exim utilities" "CHAPutils"
36078 .scindex IIDutils "utilities"
36079 A number of utility scripts and programs are supplied with Exim and are
36080 described in this chapter. There is also the Exim Monitor, which is covered in
36081 the next chapter. The utilities described here are:
36082
36083 .itable none 0 0 3  7* left  15* left  40* left
36084 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36085   "list what Exim processes are doing"
36086 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36087 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36088 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36089 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36090                                                 various criteria"
36091 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36092 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36093   "extract statistics from the log"
36094 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36095   "check address acceptance from given IP"
36096 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36097 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36098 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36099 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36100 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36101 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36102 .endtable
36103
36104 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36105 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36106 &url(http://duncanthrax.net/exilog/) for details.
36107
36108
36109
36110
36111 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36112 .cindex "&'exiwhat'&"
36113 .cindex "process, querying"
36114 .cindex "SIGUSR1"
36115 On operating systems that can restart a system call after receiving a signal
36116 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36117 a line describing what it is doing to the file &_exim-process.info_& in the
36118 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36119 processes it can find, having first emptied the file. It then waits for one
36120 second to allow the Exim processes to react before displaying the results. In
36121 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36122 send the signal to the Exim processes, so it is normally run as root.
36123
36124 &*Warning*&: This is not an efficient process. It is intended for occasional
36125 use by system administrators. It is not sensible, for example, to set up a
36126 script that sends SIGUSR1 signals to Exim processes at short intervals.
36127
36128
36129 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36130 varies in different operating systems. Not only are different options used,
36131 but the format of the output is different. For this reason, there are some
36132 system configuration options that configure exactly how &'exiwhat'& works. If
36133 it doesn't seem to be working for you, check the following compile-time
36134 options:
36135 .display
36136 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36137 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36138 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36139 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36140 .endd
36141 An example of typical output from &'exiwhat'& is
36142 .code
36143 164 daemon: -q1h, listening on port 25
36144 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36145 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36146   [10.19.42.42] (editor@ref.example)
36147 10592 handling incoming call from [192.168.243.242]
36148 10628 accepting a local non-SMTP message
36149 .endd
36150 The first number in the output line is the process number. The third line has
36151 been split here, in order to fit it on the page.
36152
36153
36154
36155 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36156 .cindex "&'exiqgrep'&"
36157 .cindex "queue" "grepping"
36158 This utility is a Perl script contributed by Matt Hubbard. It runs
36159 .code
36160 exim -bpu
36161 .endd
36162 or (in case &*-a*& switch is specified)
36163 .code
36164 exim -bp
36165 .endd
36166 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36167 contain alternate exim configuration the queue management might be using.
36168
36169 to obtain a queue listing, and then greps the output to select messages
36170 that match given criteria. The following selection options are available:
36171
36172 .vlist
36173 .vitem &*-f*&&~<&'regex'&>
36174 Match the sender address using a case-insensitive search. The field that is
36175 tested is enclosed in angle brackets, so you can test for bounce messages with
36176 .code
36177 exiqgrep -f '^<>$'
36178 .endd
36179 .vitem &*-r*&&~<&'regex'&>
36180 Match a recipient address using a case-insensitive search. The field that is
36181 tested is not enclosed in angle brackets.
36182
36183 .vitem &*-s*&&~<&'regex'&>
36184 Match against the size field.
36185
36186 .vitem &*-y*&&~<&'seconds'&>
36187 Match messages that are younger than the given time.
36188
36189 .vitem &*-o*&&~<&'seconds'&>
36190 Match messages that are older than the given time.
36191
36192 .vitem &*-z*&
36193 Match only frozen messages.
36194
36195 .vitem &*-x*&
36196 Match only non-frozen messages.
36197 .endlist
36198
36199 The following options control the format of the output:
36200
36201 .vlist
36202 .vitem &*-c*&
36203 Display only the count of matching messages.
36204
36205 .vitem &*-l*&
36206 Long format &-- display the full message information as output by Exim. This is
36207 the default.
36208
36209 .vitem &*-i*&
36210 Display message ids only.
36211
36212 .vitem &*-b*&
36213 Brief format &-- one line per message.
36214
36215 .vitem &*-R*&
36216 Display messages in reverse order.
36217
36218 .vitem &*-a*&
36219 Include delivered recipients in queue listing.
36220 .endlist
36221
36222 There is one more option, &%-h%&, which outputs a list of options.
36223
36224
36225
36226 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36227 .cindex "&'exiqsumm'&"
36228 .cindex "queue" "summary"
36229 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36230 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36231 running a command such as
36232 .code
36233 exim -bp | exiqsumm
36234 .endd
36235 The output consists of one line for each domain that has messages waiting for
36236 it, as in the following example:
36237 .code
36238 3   2322   74m   66m  msn.com.example
36239 .endd
36240 Each line lists the number of pending deliveries for a domain, their total
36241 volume, and the length of time that the oldest and the newest messages have
36242 been waiting. Note that the number of pending deliveries is greater than the
36243 number of messages when messages have more than one recipient.
36244
36245 A summary line is output at the end. By default the output is sorted on the
36246 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36247 the output to be sorted by oldest message and by count of messages,
36248 respectively. There are also three options that split the messages for each
36249 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36250 separates frozen messages, and &%-s%& separates messages according to their
36251 sender.
36252
36253 The output of &'exim -bp'& contains the original addresses in the message, so
36254 this also applies to the output from &'exiqsumm'&. No domains from addresses
36255 generated by aliasing or forwarding are included (unless the &%one_time%&
36256 option of the &(redirect)& router has been used to convert them into &"top
36257 level"& addresses).
36258
36259
36260
36261
36262 .section "Extracting specific information from the log (exigrep)" &&&
36263          "SECTextspeinf"
36264 .cindex "&'exigrep'&"
36265 .cindex "log" "extracts; grepping for"
36266 The &'exigrep'& utility is a Perl script that searches one or more main log
36267 files for entries that match a given pattern. When it finds a match, it
36268 extracts all the log entries for the relevant message, not just those that
36269 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36270 given message, or all mail for a given user, or for a given host, for example.
36271 The input files can be in Exim log format or syslog format.
36272 If a matching log line is not associated with a specific message, it is
36273 included in &'exigrep'&'s output without any additional lines. The usage is:
36274 .display
36275 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36276 .endd
36277 If no log file names are given on the command line, the standard input is read.
36278
36279 The &%-t%& argument specifies a number of seconds. It adds an additional
36280 condition for message selection. Messages that are complete are shown only if
36281 they spent more than <&'n'&> seconds on the queue.
36282
36283 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36284 makes it case-sensitive. This may give a performance improvement when searching
36285 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36286 option; with &%-I%& they do not. In both cases it is possible to change the
36287 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36288
36289 The &%-l%& option means &"literal"&, that is, treat all characters in the
36290 pattern as standing for themselves. Otherwise the pattern must be a Perl
36291 regular expression.
36292
36293 The &%-v%& option inverts the matching condition. That is, a line is selected
36294 if it does &'not'& match the pattern.
36295
36296 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36297 that are generated as a result/response to a message that &'exigrep'& matched
36298 normally.
36299
36300 Example of &%-M%&:
36301 user_a sends a message to user_b, which generates a bounce back to user_b. If
36302 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36303 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36304 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36305 when searching for &"user_a"& will show both messages since the bounce is
36306 &"related"& to or a &"result"& of the first message that was found by the
36307 search term.
36308
36309 If the location of a &'zcat'& command is known from the definition of
36310 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36311 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36312 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36313 autodetection of some well known compression extensions.
36314
36315
36316 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36317 .cindex "&'exipick'&"
36318 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36319 lists messages from the queue according to a variety of criteria. For details
36320 of &'exipick'&'s facilities, visit the web page at
36321 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36322 the &%--help%& option.
36323
36324
36325 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36326 .cindex "log" "cycling local files"
36327 .cindex "cycling logs"
36328 .cindex "&'exicyclog'&"
36329 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36330 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36331 you are using log files with datestamps in their names (see section
36332 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36333 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36334 There are two command line options for &'exicyclog'&:
36335 .ilist
36336 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36337 default that is set when Exim is built. The default default is 10.
36338 .next
36339 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36340 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36341 overriding the script's default, which is to find the setting from Exim's
36342 configuration.
36343 .endlist
36344
36345 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36346 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36347 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36348 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36349 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36350 logs are handled similarly.
36351
36352 If the limit is greater than 99, the script uses 3-digit numbers such as
36353 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36354 to one that is greater, or &'vice versa'&, you will have to fix the names of
36355 any existing log files.
36356
36357 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36358 the end are deleted. All files with numbers greater than 01 are compressed,
36359 using a compression command which is configured by the COMPRESS_COMMAND
36360 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36361 root &%crontab%& entry of the form
36362 .code
36363 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36364 .endd
36365 assuming you have used the name &"exim"& for the Exim user. You can run
36366 &'exicyclog'& as root if you wish, but there is no need.
36367
36368
36369
36370 .section "Mail statistics (eximstats)" "SECTmailstat"
36371 .cindex "statistics"
36372 .cindex "&'eximstats'&"
36373 A Perl script called &'eximstats'& is provided for extracting statistical
36374 information from log files. The output is either plain text, or HTML.
36375 Exim log files are also supported by the &'Lire'& system produced by the
36376 LogReport Foundation &url(http://www.logreport.org).
36377
36378 The &'eximstats'& script has been hacked about quite a bit over time. The
36379 latest version is the result of some extensive revision by Steve Campbell. A
36380 lot of information is given by default, but there are options for suppressing
36381 various parts of it. Following any options, the arguments to the script are a
36382 list of files, which should be main log files. For example:
36383 .code
36384 eximstats -nr /var/spool/exim/log/mainlog.01
36385 .endd
36386 By default, &'eximstats'& extracts information about the number and volume of
36387 messages received from or delivered to various hosts. The information is sorted
36388 both by message count and by volume, and the top fifty hosts in each category
36389 are listed on the standard output. Similar information, based on email
36390 addresses or domains instead of hosts can be requested by means of various
36391 options. For messages delivered and received locally, similar statistics are
36392 also produced per user.
36393
36394 The output also includes total counts and statistics about delivery errors, and
36395 histograms showing the number of messages received and deliveries made in each
36396 hour of the day. A delivery with more than one address in its envelope (for
36397 example, an SMTP transaction with more than one RCPT command) is counted
36398 as a single delivery by &'eximstats'&.
36399
36400 Though normally more deliveries than receipts are reported (as messages may
36401 have multiple recipients), it is possible for &'eximstats'& to report more
36402 messages received than delivered, even though the queue is empty at the start
36403 and end of the period in question. If an incoming message contains no valid
36404 recipients, no deliveries are recorded for it. A bounce message is handled as
36405 an entirely separate message.
36406
36407 &'eximstats'& always outputs a grand total summary giving the volume and number
36408 of messages received and deliveries made, and the number of hosts involved in
36409 each case. It also outputs the number of messages that were delayed (that is,
36410 not completely delivered at the first attempt), and the number that had at
36411 least one address that failed.
36412
36413 The remainder of the output is in sections that can be independently disabled
36414 or modified by various options. It consists of a summary of deliveries by
36415 transport, histograms of messages received and delivered per time interval
36416 (default per hour), information about the time messages spent on the queue,
36417 a list of relayed messages, lists of the top fifty sending hosts, local
36418 senders, destination hosts, and destination local users by count and by volume,
36419 and a list of delivery errors that occurred.
36420
36421 The relay information lists messages that were actually relayed, that is, they
36422 came from a remote host and were directly delivered to some other remote host,
36423 without being processed (for example, for aliasing or forwarding) locally.
36424
36425 There are quite a few options for &'eximstats'& to control exactly what it
36426 outputs. These are documented in the Perl script itself, and can be extracted
36427 by running the command &(perldoc)& on the script. For example:
36428 .code
36429 perldoc /usr/exim/bin/eximstats
36430 .endd
36431
36432 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36433 .cindex "&'exim_checkaccess'&"
36434 .cindex "policy control" "checking access"
36435 .cindex "checking access"
36436 The &%-bh%& command line argument allows you to run a fake SMTP session with
36437 debugging output, in order to check what Exim is doing when it is applying
36438 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36439 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36440 sometimes you just want to answer the question &"Does this address have
36441 access?"& without bothering with any further details.
36442
36443 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36444 two arguments, an IP address and an email address:
36445 .code
36446 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36447 .endd
36448 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36449 given email address would be accepted in a RCPT command in a TCP/IP
36450 connection from the host with the given IP address. The output of the utility
36451 is either the word &"accepted"&, or the SMTP error response, for example:
36452 .code
36453 Rejected:
36454 550 Relay not permitted
36455 .endd
36456 When running this test, the utility uses &`<>`& as the envelope sender address
36457 for the MAIL command, but you can change this by providing additional
36458 options. These are passed directly to the Exim command. For example, to specify
36459 that the test is to be run with the sender address &'himself@there.example'&
36460 you can use:
36461 .code
36462 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36463                  -f himself@there.example
36464 .endd
36465 Note that these additional Exim command line items must be given after the two
36466 mandatory arguments.
36467
36468 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36469 while running its checks. You can run checks that include callouts by using
36470 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36471
36472
36473
36474 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36475 .cindex "DBM" "building dbm files"
36476 .cindex "building DBM files"
36477 .cindex "&'exim_dbmbuild'&"
36478 .cindex "lower casing"
36479 .cindex "binary zero" "in lookup key"
36480 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36481 the format used by the &(lsearch)& lookup (see section
36482 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36483 names as keys and the remainder of the information as data. The lower-casing
36484 can be prevented by calling the program with the &%-nolc%& option.
36485
36486 A terminating zero is included as part of the key string. This is expected by
36487 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36488 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36489 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36490 files.
36491
36492 The program requires two arguments: the name of the input file (which can be a
36493 single hyphen to indicate the standard input), and the name of the output file.
36494 It creates the output under a temporary name, and then renames it if all went
36495 well.
36496
36497 .cindex "USE_DB"
36498 If the native DB interface is in use (USE_DB is set in a compile-time
36499 configuration file &-- this is common in free versions of Unix) the two file
36500 names must be different, because in this mode the Berkeley DB functions create
36501 a single output file using exactly the name given. For example,
36502 .code
36503 exim_dbmbuild /etc/aliases /etc/aliases.db
36504 .endd
36505 reads the system alias file and creates a DBM version of it in
36506 &_/etc/aliases.db_&.
36507
36508 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36509 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36510 environment, the suffixes are added to the second argument of
36511 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36512 when the Berkeley functions are used in compatibility mode (though this is not
36513 recommended), because in that case it adds a &_.db_& suffix to the file name.
36514
36515 If a duplicate key is encountered, the program outputs a warning, and when it
36516 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36517 option is used. By default, only the first of a set of duplicates is used &--
36518 this makes it compatible with &(lsearch)& lookups. There is an option
36519 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36520 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36521 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36522 return code is 2.
36523
36524
36525
36526
36527 .section "Finding individual retry times (exinext)" "SECTfinindret"
36528 .cindex "retry" "times"
36529 .cindex "&'exinext'&"
36530 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36531 fish specific information out of the retry database. Given a mail domain (or a
36532 complete address), it looks up the hosts for that domain, and outputs any retry
36533 information for the hosts or for the domain. At present, the retry information
36534 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36535 output. For example:
36536 .code
36537 $ exinext piglet@milne.fict.example
36538 kanga.milne.example:192.168.8.1 error 146: Connection refused
36539   first failed: 21-Feb-1996 14:57:34
36540   last tried:   21-Feb-1996 14:57:34
36541   next try at:  21-Feb-1996 15:02:34
36542 roo.milne.example:192.168.8.3 error 146: Connection refused
36543   first failed: 20-Jan-1996 13:12:08
36544   last tried:   21-Feb-1996 11:42:03
36545   next try at:  21-Feb-1996 19:42:03
36546   past final cutoff time
36547 .endd
36548 You can also give &'exinext'& a local part, without a domain, and it
36549 will give any retry information for that local part in your default domain.
36550 A message id can be used to obtain retry information pertaining to a specific
36551 message. This exists only when an attempt to deliver a message to a remote host
36552 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36553 &'exinext'& is not particularly efficient, but then it is not expected to be
36554 run very often.
36555
36556 The &'exinext'& utility calls Exim to find out information such as the location
36557 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36558 passed on to the &'exim'& commands. The first specifies an alternate Exim
36559 configuration file, and the second sets macros for use within the configuration
36560 file. These features are mainly to help in testing, but might also be useful in
36561 environments where more than one configuration file is in use.
36562
36563
36564
36565 .section "Hints database maintenance" "SECThindatmai"
36566 .cindex "hints database" "maintenance"
36567 .cindex "maintaining Exim's hints database"
36568 Three utility programs are provided for maintaining the DBM files that Exim
36569 uses to contain its delivery hint information. Each program requires two
36570 arguments. The first specifies the name of Exim's spool directory, and the
36571 second is the name of the database it is to operate on. These are as follows:
36572
36573 .ilist
36574 &'retry'&: the database of retry information
36575 .next
36576 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36577 for remote hosts
36578 .next
36579 &'callout'&: the callout cache
36580 .next
36581 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36582 .next
36583 &'misc'&: other hints data
36584 .endlist
36585
36586 The &'misc'& database is used for
36587
36588 .ilist
36589 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36590 .next
36591 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36592 &(smtp)& transport)
36593 .next
36594 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36595 in a transport)
36596 .endlist
36597
36598
36599
36600 .section "exim_dumpdb" "SECID261"
36601 .cindex "&'exim_dumpdb'&"
36602 The entire contents of a database are written to the standard output by the
36603 &'exim_dumpdb'& program, which has no options or arguments other than the
36604 spool and database names. For example, to dump the retry database:
36605 .code
36606 exim_dumpdb /var/spool/exim retry
36607 .endd
36608 Two lines of output are produced for each entry:
36609 .code
36610 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36611 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36612 .endd
36613 The first item on the first line is the key of the record. It starts with one
36614 of the letters R, or T, depending on whether it refers to a routing or
36615 transport retry. For a local delivery, the next part is the local address; for
36616 a remote delivery it is the name of the remote host, followed by its failing IP
36617 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36618 transport). If the remote port is not the standard one (port 25), it is added
36619 to the IP address. Then there follows an error code, an additional error code,
36620 and a textual description of the error.
36621
36622 The three times on the second line are the time of first failure, the time of
36623 the last delivery attempt, and the computed time for the next attempt. The line
36624 ends with an asterisk if the cutoff time for the last retry rule has been
36625 exceeded.
36626
36627 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36628 consists of a host name followed by a list of ids for messages that are or were
36629 waiting to be delivered to that host. If there are a very large number for any
36630 one host, continuation records, with a sequence number added to the host name,
36631 may be seen. The data in these records is often out of date, because a message
36632 may be routed to several alternative hosts, and Exim makes no effort to keep
36633 cross-references.
36634
36635
36636
36637 .section "exim_tidydb" "SECID262"
36638 .cindex "&'exim_tidydb'&"
36639 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36640 database. If run with no options, it removes all records that are more than 30
36641 days old. The age is calculated from the date and time that the record was last
36642 updated. Note that, in the case of the retry database, it is &'not'& the time
36643 since the first delivery failure. Information about a host that has been down
36644 for more than 30 days will remain in the database, provided that the record is
36645 updated sufficiently often.
36646
36647 The cutoff date can be altered by means of the &%-t%& option, which must be
36648 followed by a time. For example, to remove all records older than a week from
36649 the retry database:
36650 .code
36651 exim_tidydb -t 7d /var/spool/exim retry
36652 .endd
36653 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36654 message ids. In the former these appear as data in records keyed by host &--
36655 they were messages that were waiting for that host &-- and in the latter they
36656 are the keys for retry information for messages that have suffered certain
36657 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36658 message ids in database records are those of messages that are still on the
36659 queue. Message ids for messages that no longer exist are removed from
36660 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36661 For the &'retry'& database, records whose keys are non-existent message ids are
36662 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36663 whenever it removes information from the database.
36664
36665 Certain records are automatically removed by Exim when they are no longer
36666 needed, but others are not. For example, if all the MX hosts for a domain are
36667 down, a retry record is created for each one. If the primary MX host comes back
36668 first, its record is removed when Exim successfully delivers to it, but the
36669 records for the others remain because Exim has not tried to use those hosts.
36670
36671 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36672 hints databases. You should do this at a quiet time of day, because it requires
36673 a database to be locked (and therefore inaccessible to Exim) while it does its
36674 work. Removing records from a DBM file does not normally make the file smaller,
36675 but all the common DBM libraries are able to re-use the space that is released.
36676 After an initial phase of increasing in size, the databases normally reach a
36677 point at which they no longer get any bigger, as long as they are regularly
36678 tidied.
36679
36680 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36681 databases is likely to keep on increasing.
36682
36683
36684
36685
36686 .section "exim_fixdb" "SECID263"
36687 .cindex "&'exim_fixdb'&"
36688 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36689 Its main use is for testing Exim, but it might also be occasionally useful for
36690 getting round problems in a live system. It has no options, and its interface
36691 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36692 key of a database record can then be entered, and the data for that record is
36693 displayed.
36694
36695 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36696 except the &'retry'& database, that is the only operation that can be carried
36697 out. For the &'retry'& database, each field is output preceded by a number, and
36698 data for individual fields can be changed by typing the field number followed
36699 by new data, for example:
36700 .code
36701 > 4 951102:1000
36702 .endd
36703 resets the time of the next delivery attempt. Time values are given as a
36704 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36705 used as optional separators.
36706
36707
36708
36709
36710 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36711 .cindex "mailbox" "maintenance"
36712 .cindex "&'exim_lock'&"
36713 .cindex "locking mailboxes"
36714 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36715 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36716 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36717 a user agent while investigating a problem. The utility requires the name of
36718 the file as its first argument. If the locking is successful, the second
36719 argument is run as a command (using C's &[system()]& function); if there is no
36720 second argument, the value of the SHELL environment variable is used; if this
36721 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36722 is unlocked and the utility ends. The following options are available:
36723
36724 .vlist
36725 .vitem &%-fcntl%&
36726 Use &[fcntl()]& locking on the open mailbox.
36727
36728 .vitem &%-flock%&
36729 Use &[flock()]& locking on the open mailbox, provided the operating system
36730 supports it.
36731
36732 .vitem &%-interval%&
36733 This must be followed by a number, which is a number of seconds; it sets the
36734 interval to sleep between retries (default 3).
36735
36736 .vitem &%-lockfile%&
36737 Create a lock file before opening the mailbox.
36738
36739 .vitem &%-mbx%&
36740 Lock the mailbox using MBX rules.
36741
36742 .vitem &%-q%&
36743 Suppress verification output.
36744
36745 .vitem &%-retries%&
36746 This must be followed by a number; it sets the number of times to try to get
36747 the lock (default 10).
36748
36749 .vitem &%-restore_time%&
36750 This option causes &%exim_lock%& to restore the modified and read times to the
36751 locked file before exiting. This allows you to access a locked mailbox (for
36752 example, to take a backup copy) without disturbing the times that the user
36753 subsequently sees.
36754
36755 .vitem &%-timeout%&
36756 This must be followed by a number, which is a number of seconds; it sets a
36757 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36758 default), a non-blocking call is used.
36759
36760 .vitem &%-v%&
36761 Generate verbose output.
36762 .endlist
36763
36764 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36765 default is to create a lock file and also to use &[fcntl()]& locking on the
36766 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36767 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36768 requires that the directory containing the file be writeable. Locking by lock
36769 file does not last for ever; Exim assumes that a lock file is expired if it is
36770 more than 30 minutes old.
36771
36772 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36773 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36774 to be taken out on the open mailbox, and an exclusive lock on the file
36775 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36776 number of the mailbox file. When the locking is released, if an exclusive lock
36777 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36778
36779 The default output contains verification of the locking that takes place. The
36780 &%-v%& option causes some additional information to be given. The &%-q%& option
36781 suppresses all output except error messages.
36782
36783 A command such as
36784 .code
36785 exim_lock /var/spool/mail/spqr
36786 .endd
36787 runs an interactive shell while the file is locked, whereas
36788 .display
36789 &`exim_lock -q /var/spool/mail/spqr <<End`&
36790 <&'some commands'&>
36791 &`End`&
36792 .endd
36793 runs a specific non-interactive sequence of commands while the file is locked,
36794 suppressing all verification output. A single command can be run by a command
36795 such as
36796 .code
36797 exim_lock -q /var/spool/mail/spqr \
36798   "cp /var/spool/mail/spqr /some/where"
36799 .endd
36800 Note that if a command is supplied, it must be entirely contained within the
36801 second argument &-- hence the quotes.
36802 .ecindex IIDutils
36803
36804
36805 . ////////////////////////////////////////////////////////////////////////////
36806 . ////////////////////////////////////////////////////////////////////////////
36807
36808 .chapter "The Exim monitor" "CHAPeximon"
36809 .scindex IIDeximon "Exim monitor" "description"
36810 .cindex "X-windows"
36811 .cindex "&'eximon'&"
36812 .cindex "Local/eximon.conf"
36813 .cindex "&_exim_monitor/EDITME_&"
36814 The Exim monitor is an application which displays in an X window information
36815 about the state of Exim's queue and what Exim is doing. An admin user can
36816 perform certain operations on messages from this GUI interface; however all
36817 such facilities are also available from the command line, and indeed, the
36818 monitor itself makes use of the command line to perform any actions requested.
36819
36820
36821
36822 .section "Running the monitor" "SECID264"
36823 The monitor is started by running the script called &'eximon'&. This is a shell
36824 script that sets up a number of environment variables, and then runs the
36825 binary called &_eximon.bin_&. The default appearance of the monitor window can
36826 be changed by editing the &_Local/eximon.conf_& file created by editing
36827 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36828 parameters are for.
36829
36830 The parameters that get built into the &'eximon'& script can be overridden for
36831 a particular invocation by setting up environment variables of the same names,
36832 preceded by &`EXIMON_`&. For example, a shell command such as
36833 .code
36834 EXIMON_LOG_DEPTH=400 eximon
36835 .endd
36836 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36837 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36838 overrides the Exim log file configuration. This makes it possible to have
36839 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36840 syslog messages are routed to a file on the local host.
36841
36842 X resources can be used to change the appearance of the window in the normal
36843 way. For example, a resource setting of the form
36844 .code
36845 Eximon*background: gray94
36846 .endd
36847 changes the colour of the background to light grey rather than white. The
36848 stripcharts are drawn with both the data lines and the reference lines in
36849 black. This means that the reference lines are not visible when on top of the
36850 data. However, their colour can be changed by setting a resource called
36851 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36852 For example, if your X server is running Unix, you could set up lighter
36853 reference lines in the stripcharts by obeying
36854 .code
36855 xrdb -merge <<End
36856 Eximon*highlight: gray
36857 End
36858 .endd
36859 .cindex "admin user"
36860 In order to see the contents of messages on the queue, and to operate on them,
36861 &'eximon'& must either be run as root or by an admin user.
36862
36863 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36864 contain X11 resource parameters interpreted by the X11 library.  In addition,
36865 if the first parameter starts with the string "gdb" then it is removed and the
36866 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36867 versioned variants of gdb can be invoked).
36868
36869 The monitor's window is divided into three parts. The first contains one or
36870 more stripcharts and two action buttons, the second contains a &"tail"& of the
36871 main log file, and the third is a display of the queue of messages awaiting
36872 delivery, with two more action buttons. The following sections describe these
36873 different parts of the display.
36874
36875
36876
36877
36878 .section "The stripcharts" "SECID265"
36879 .cindex "stripchart"
36880 The first stripchart is always a count of messages on the queue. Its name can
36881 be configured by setting QUEUE_STRIPCHART_NAME in the
36882 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36883 configuration script by regular expression matches on log file entries, making
36884 it possible to display, for example, counts of messages delivered to certain
36885 hosts or using certain transports. The supplied defaults display counts of
36886 received and delivered messages, and of local and SMTP deliveries. The default
36887 period between stripchart updates is one minute; this can be adjusted by a
36888 parameter in the &_Local/eximon.conf_& file.
36889
36890 The stripchart displays rescale themselves automatically as the value they are
36891 displaying changes. There are always 10 horizontal lines in each chart; the
36892 title string indicates the value of each division when it is greater than one.
36893 For example, &"x2"& means that each division represents a value of 2.
36894
36895 It is also possible to have a stripchart which shows the percentage fullness of
36896 a particular disk partition, which is useful when local deliveries are confined
36897 to a single partition.
36898
36899 .cindex "&%statvfs%& function"
36900 This relies on the availability of the &[statvfs()]& function or equivalent in
36901 the operating system. Most, but not all versions of Unix that support Exim have
36902 this. For this particular stripchart, the top of the chart always represents
36903 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36904 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36905 &_Local/eximon.conf_& file.
36906
36907
36908
36909
36910 .section "Main action buttons" "SECID266"
36911 .cindex "size" "of monitor window"
36912 .cindex "Exim monitor" "window size"
36913 .cindex "window size"
36914 Below the stripcharts there is an action button for quitting the monitor. Next
36915 to this is another button marked &"Size"&. They are placed here so that
36916 shrinking the window to its default minimum size leaves just the queue count
36917 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36918 the window to expand to its maximum size, unless it is already at the maximum,
36919 in which case it is reduced to its minimum.
36920
36921 When expanding to the maximum, if the window cannot be fully seen where it
36922 currently is, it is moved back to where it was the last time it was at full
36923 size. When it is expanding from its minimum size, the old position is
36924 remembered, and next time it is reduced to the minimum it is moved back there.
36925
36926 The idea is that you can keep a reduced window just showing one or two
36927 stripcharts at a convenient place on your screen, easily expand it to show
36928 the full window when required, and just as easily put it back to what it was.
36929 The idea is copied from what the &'twm'& window manager does for its
36930 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36931 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36932
36933 Normally, the monitor starts up with the window at its full size, but it can be
36934 built so that it starts up with the window at its smallest size, by setting
36935 START_SMALL=yes in &_Local/eximon.conf_&.
36936
36937
36938
36939 .section "The log display" "SECID267"
36940 .cindex "log" "tail of; in monitor"
36941 The second section of the window is an area in which a display of the tail of
36942 the main log is maintained.
36943 To save space on the screen, the timestamp on each log line is shortened by
36944 removing the date and, if &%log_timezone%& is set, the timezone.
36945 The log tail is not available when the only destination for logging data is
36946 syslog, unless the syslog lines are routed to a local file whose name is passed
36947 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36948
36949 The log sub-window has a scroll bar at its lefthand side which can be used to
36950 move back to look at earlier text, and the up and down arrow keys also have a
36951 scrolling effect. The amount of log that is kept depends on the setting of
36952 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36953 to use. When this is full, the earlier 50% of data is discarded &-- this is
36954 much more efficient than throwing it away line by line. The sub-window also has
36955 a horizontal scroll bar for accessing the ends of long log lines. This is the
36956 only means of horizontal scrolling; the right and left arrow keys are not
36957 available. Text can be cut from this part of the window using the mouse in the
36958 normal way. The size of this subwindow is controlled by parameters in the
36959 configuration file &_Local/eximon.conf_&.
36960
36961 Searches of the text in the log window can be carried out by means of the ^R
36962 and ^S keystrokes, which default to a reverse and a forward search,
36963 respectively. The search covers only the text that is displayed in the window.
36964 It cannot go further back up the log.
36965
36966 The point from which the search starts is indicated by a caret marker. This is
36967 normally at the end of the text in the window, but can be positioned explicitly
36968 by pointing and clicking with the left mouse button, and is moved automatically
36969 by a successful search. If new text arrives in the window when it is scrolled
36970 back, the caret remains where it is, but if the window is not scrolled back,
36971 the caret is moved to the end of the new text.
36972
36973 Pressing ^R or ^S pops up a window into which the search text can be typed.
36974 There are buttons for selecting forward or reverse searching, for carrying out
36975 the search, and for cancelling. If the &"Search"& button is pressed, the search
36976 happens and the window remains so that further searches can be done. If the
36977 &"Return"& key is pressed, a single search is done and the window is closed. If
36978 ^C is typed the search is cancelled.
36979
36980 The searching facility is implemented using the facilities of the Athena text
36981 widget. By default this pops up a window containing both &"search"& and
36982 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36983 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36984 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36985 provided version of &%TextPop%& when the remaining parts of the text widget
36986 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36987 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36988 on these systems, at the expense of having unwanted items in the search popup
36989 window.
36990
36991
36992
36993 .section "The queue display" "SECID268"
36994 .cindex "queue" "display in monitor"
36995 The bottom section of the monitor window contains a list of all messages that
36996 are on the queue, which includes those currently being received or delivered,
36997 as well as those awaiting delivery. The size of this subwindow is controlled by
36998 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36999 at which it is updated is controlled by another parameter in the same file &--
37000 the default is 5 minutes, since queue scans can be quite expensive. However,
37001 there is an &"Update"& action button just above the display which can be used
37002 to force an update of the queue display at any time.
37003
37004 When a host is down for some time, a lot of pending mail can build up for it,
37005 and this can make it hard to deal with other messages on the queue. To help
37006 with this situation there is a button next to &"Update"& called &"Hide"&. If
37007 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37008 type anything in here and press &"Return"&, the text is added to a chain of
37009 such texts, and if every undelivered address in a message matches at least one
37010 of the texts, the message is not displayed.
37011
37012 If there is an address that does not match any of the texts, all the addresses
37013 are displayed as normal. The matching happens on the ends of addresses so, for
37014 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37015 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37016 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37017 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37018 a hide request is automatically cancelled after one hour.
37019
37020 While the dialogue box is displayed, you can't press any buttons or do anything
37021 else to the monitor window. For this reason, if you want to cut text from the
37022 queue display to use in the dialogue box, you have to do the cutting before
37023 pressing the &"Hide"& button.
37024
37025 The queue display contains, for each unhidden queued message, the length of
37026 time it has been on the queue, the size of the message, the message id, the
37027 message sender, and the first undelivered recipient, all on one line. If it is
37028 a bounce message, the sender is shown as &"<>"&. If there is more than one
37029 recipient to which the message has not yet been delivered, subsequent ones are
37030 listed on additional lines, up to a maximum configured number, following which
37031 an ellipsis is displayed. Recipients that have already received the message are
37032 not shown.
37033
37034 .cindex "frozen messages" "display"
37035 If a message is frozen, an asterisk is displayed at the left-hand side.
37036
37037 The queue display has a vertical scroll bar, and can also be scrolled by means
37038 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37039 The text searching facilities, as described above for the log window, are also
37040 available, but the caret is always moved to the end of the text when the queue
37041 display is updated.
37042
37043
37044
37045 .section "The queue menu" "SECID269"
37046 .cindex "queue" "menu in monitor"
37047 If the &%shift%& key is held down and the left button is clicked when the mouse
37048 pointer is over the text for any message, an action menu pops up, and the first
37049 line of the queue display for the message is highlighted. This does not affect
37050 any selected text.
37051
37052 If you want to use some other event for popping up the menu, you can set the
37053 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37054 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37055 value set in this parameter is a standard X event description. For example, to
37056 run eximon using &%ctrl%& rather than &%shift%& you could use
37057 .code
37058 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37059 .endd
37060 The title of the menu is the message id, and it contains entries which act as
37061 follows:
37062
37063 .ilist
37064 &'message log'&: The contents of the message log for the message are displayed
37065 in a new text window.
37066 .next
37067 &'headers'&: Information from the spool file that contains the envelope
37068 information and headers is displayed in a new text window. See chapter
37069 &<<CHAPspool>>& for a description of the format of spool files.
37070 .next
37071 &'body'&: The contents of the spool file containing the body of the message are
37072 displayed in a new text window. There is a default limit of 20,000 bytes to the
37073 amount of data displayed. This can be changed by setting the BODY_MAX
37074 option at compile time, or the EXIMON_BODY_MAX option at run time.
37075 .next
37076 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37077 delivery of the message. This causes an automatic thaw if the message is
37078 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37079 a new text window. The delivery is run in a separate process, to avoid holding
37080 up the monitor while the delivery proceeds.
37081 .next
37082 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37083 that the message be frozen.
37084 .next
37085 .cindex "thawing messages"
37086 .cindex "unfreezing messages"
37087 .cindex "frozen messages" "thawing"
37088 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37089 that the message be thawed.
37090 .next
37091 .cindex "delivery" "forcing failure"
37092 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37093 that Exim gives up trying to deliver the message. A bounce message is generated
37094 for any remaining undelivered addresses.
37095 .next
37096 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37097 that the message be deleted from the system without generating a bounce
37098 message.
37099 .next
37100 &'add recipient'&: A dialog box is displayed into which a recipient address can
37101 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37102 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37103 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37104 causes a call to Exim to be made using the &%-Mar%& option to request that an
37105 additional recipient be added to the message, unless the entry box is empty, in
37106 which case no action is taken.
37107 .next
37108 &'mark delivered'&: A dialog box is displayed into which a recipient address
37109 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37110 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37111 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37112 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37113 recipient address as already delivered, unless the entry box is empty, in which
37114 case no action is taken.
37115 .next
37116 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37117 mark all recipient addresses as already delivered.
37118 .next
37119 &'edit sender'&: A dialog box is displayed initialized with the current
37120 sender's address. Pressing RETURN causes a call to Exim to be made using the
37121 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37122 in which case no action is taken. If you want to set an empty sender (as in
37123 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37124 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37125 the address is qualified with that domain.
37126 .endlist
37127
37128 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37129 other cases when a call to Exim is made, if there is any output from Exim (in
37130 particular, if the command fails) a window containing the command and the
37131 output is displayed. Otherwise, the results of the action are normally apparent
37132 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37133 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37134 if no output is generated.
37135
37136 The queue display is automatically updated for actions such as freezing and
37137 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37138 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37139 force an update of the display after one of these actions.
37140
37141 In any text window that is displayed as result of a menu action, the normal
37142 cut-and-paste facility is available, and searching can be carried out using ^R
37143 and ^S, as described above for the log tail window.
37144 .ecindex IIDeximon
37145
37146
37147
37148
37149
37150 . ////////////////////////////////////////////////////////////////////////////
37151 . ////////////////////////////////////////////////////////////////////////////
37152
37153 .chapter "Security considerations" "CHAPsecurity"
37154 .scindex IIDsecurcon "security" "discussion of"
37155 This chapter discusses a number of issues concerned with security, some of
37156 which are also covered in other parts of this manual.
37157
37158 For reasons that this author does not understand, some people have promoted
37159 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37160 existence of this chapter in the documentation. However, the intent of the
37161 chapter is simply to describe the way Exim works in relation to certain
37162 security concerns, not to make any specific claims about the effectiveness of
37163 its security as compared with other MTAs.
37164
37165 What follows is a description of the way Exim is supposed to be. Best efforts
37166 have been made to try to ensure that the code agrees with the theory, but an
37167 absence of bugs can never be guaranteed. Any that are reported will get fixed
37168 as soon as possible.
37169
37170
37171 .section "Building a more &""hardened""& Exim" "SECID286"
37172 .cindex "security" "build-time features"
37173 There are a number of build-time options that can be set in &_Local/Makefile_&
37174 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37175 Exim administrator who does not have the root password, or by someone who has
37176 penetrated the Exim (but not the root) account. These options are as follows:
37177
37178 .ilist
37179 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37180 start of any file names used with the &%-C%& option. When it is set, these file
37181 names are also not allowed to contain the sequence &"/../"&. (However, if the
37182 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37183 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37184 default setting for &%ALT_CONFIG_PREFIX%&.
37185
37186 If the permitted configuration files are confined to a directory to
37187 which only root has access, this guards against someone who has broken
37188 into the Exim account from running a privileged Exim with an arbitrary
37189 configuration file, and using it to break into other accounts.
37190 .next
37191
37192 If a non-trusted configuration file (i.e. not the default configuration file
37193 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37194 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37195 the next item), then root privilege is retained only if the caller of Exim is
37196 root. This locks out the possibility of testing a configuration using &%-C%&
37197 right through message reception and delivery, even if the caller is root. The
37198 reception works, but by that time, Exim is running as the Exim user, so when
37199 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37200 privilege to be lost. However, root can test reception and delivery using two
37201 separate commands.
37202
37203 .next
37204 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37205 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37206 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37207 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37208 the restrictive side.  Requiring build-time selection of safe macros is onerous
37209 but this option is intended solely as a transition mechanism to permit
37210 previously-working configurations to continue to work after release 4.73.
37211 .next
37212 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37213 is disabled.
37214 .next
37215 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37216 never to be used for any deliveries. This is like the &%never_users%& runtime
37217 option, but it cannot be overridden; the runtime option adds additional users
37218 to the list. The default setting is &"root"&; this prevents a non-root user who
37219 is permitted to modify the runtime file from using Exim as a way to get root.
37220 .endlist
37221
37222
37223
37224 .section "Root privilege" "SECID270"
37225 .cindex "setuid"
37226 .cindex "root privilege"
37227 The Exim binary is normally setuid to root, which means that it gains root
37228 privilege (runs as root) when it starts execution. In some special cases (for
37229 example, when the daemon is not in use and there are no local deliveries), it
37230 may be possible to run Exim setuid to some user other than root. This is
37231 discussed in the next section. However, in most installations, root privilege
37232 is required for two things:
37233
37234 .ilist
37235 To set up a socket connected to the standard SMTP port (25) when initialising
37236 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37237 not required.
37238 .next
37239 To be able to change uid and gid in order to read users' &_.forward_& files and
37240 perform local deliveries as the receiving user or as specified in the
37241 configuration.
37242 .endlist
37243
37244 It is not necessary to be root to do any of the other things Exim does, such as
37245 receiving messages and delivering them externally over SMTP, and it is
37246 obviously more secure if Exim does not run as root except when necessary.
37247 For this reason, a user and group for Exim to use must be defined in
37248 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37249 group"&. Their values can be changed by the run time configuration, though this
37250 is not recommended. Often a user called &'exim'& is used, but some sites use
37251 &'mail'& or another user name altogether.
37252
37253 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37254 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37255 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37256
37257 After a new Exim process has interpreted its command line options, it changes
37258 uid and gid in the following cases:
37259
37260 .ilist
37261 .oindex "&%-C%&"
37262 .oindex "&%-D%&"
37263 If the &%-C%& option is used to specify an alternate configuration file, or if
37264 the &%-D%& option is used to define macro values for the configuration, and the
37265 calling process is not running as root, the uid and gid are changed to those of
37266 the calling process.
37267 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37268 option may not be used at all.
37269 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37270 can be supplied if the calling process is running as root, the Exim run-time
37271 user or CONFIGURE_OWNER, if defined.
37272 .next
37273 .oindex "&%-be%&"
37274 .oindex "&%-bf%&"
37275 .oindex "&%-bF%&"
37276 If the expansion test option (&%-be%&) or one of the filter testing options
37277 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37278 calling process.
37279 .next
37280 If the process is not a daemon process or a queue runner process or a delivery
37281 process or a process for testing address routing (started with &%-bt%&), the
37282 uid and gid are changed to the Exim user and group. This means that Exim always
37283 runs under its own uid and gid when receiving messages. This also applies when
37284 testing address verification
37285 .oindex "&%-bv%&"
37286 .oindex "&%-bh%&"
37287 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37288 option).
37289 .next
37290 For a daemon, queue runner, delivery, or address testing process, the uid
37291 remains as root at this stage, but the gid is changed to the Exim group.
37292 .endlist
37293
37294 The processes that initially retain root privilege behave as follows:
37295
37296 .ilist
37297 A daemon process changes the gid to the Exim group and the uid to the Exim
37298 user after setting up one or more listening sockets. The &[initgroups()]&
37299 function is called, so that if the Exim user is in any additional groups, they
37300 will be used during message reception.
37301 .next
37302 A queue runner process retains root privilege throughout its execution. Its
37303 job is to fork a controlled sequence of delivery processes.
37304 .next
37305 A delivery process retains root privilege throughout most of its execution,
37306 but any actual deliveries (that is, the transports themselves) are run in
37307 subprocesses which always change to a non-root uid and gid. For local
37308 deliveries this is typically the uid and gid of the owner of the mailbox; for
37309 remote deliveries, the Exim uid and gid are used. Once all the delivery
37310 subprocesses have been run, a delivery process changes to the Exim uid and gid
37311 while doing post-delivery tidying up such as updating the retry database and
37312 generating bounce and warning messages.
37313
37314 While the recipient addresses in a message are being routed, the delivery
37315 process runs as root. However, if a user's filter file has to be processed,
37316 this is done in a subprocess that runs under the individual user's uid and
37317 gid. A system filter is run as root unless &%system_filter_user%& is set.
37318 .next
37319 A process that is testing addresses (the &%-bt%& option) runs as root so that
37320 the routing is done in the same environment as a message delivery.
37321 .endlist
37322
37323
37324
37325
37326 .section "Running Exim without privilege" "SECTrunexiwitpri"
37327 .cindex "privilege, running without"
37328 .cindex "unprivileged running"
37329 .cindex "root privilege" "running without"
37330 Some installations like to run Exim in an unprivileged state for more of its
37331 operation, for added security. Support for this mode of operation is provided
37332 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37333 gid are changed to the Exim user and group at the start of a delivery process
37334 (and also queue runner and address testing processes). This means that address
37335 routing is no longer run as root, and the deliveries themselves cannot change
37336 to any other uid.
37337
37338 .cindex SIGHUP
37339 .cindex "daemon" "restarting"
37340 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37341 that the daemon can still be started in the usual way, and it can respond
37342 correctly to SIGHUP because the re-invocation regains root privilege.
37343
37344 An alternative approach is to make Exim setuid to the Exim user and also setgid
37345 to the Exim group. If you do this, the daemon must be started from a root
37346 process. (Calling Exim from a root process makes it behave in the way it does
37347 when it is setuid root.) However, the daemon cannot restart itself after a
37348 SIGHUP signal because it cannot regain privilege.
37349
37350 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37351 stops Exim from trying to re-invoke itself to do a delivery after a message has
37352 been received. Such a re-invocation is a waste of resources because it has no
37353 effect.
37354
37355 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37356 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37357 to the Exim user seems a clean approach, but there is one complication:
37358
37359 In this style of operation, Exim is running with the real uid and gid set to
37360 those of the calling process, and the effective uid/gid set to Exim's values.
37361 Ideally, any association with the calling process' uid/gid should be dropped,
37362 that is, the real uid/gid should be reset to the effective values so as to
37363 discard any privileges that the caller may have. While some operating systems
37364 have a function that permits this action for a non-root effective uid, quite a
37365 number of them do not. Because of this lack of standardization, Exim does not
37366 address this problem at this time.
37367
37368 For this reason, the recommended approach for &"mostly unprivileged"& running
37369 is to keep the Exim binary setuid to root, and to set
37370 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37371 be used in the most straightforward way.
37372
37373 If you configure Exim not to run delivery processes as root, there are a
37374 number of restrictions on what you can do:
37375
37376 .ilist
37377 You can deliver only as the Exim user/group. You should  explicitly use the
37378 &%user%& and &%group%& options to override routers or local transports that
37379 normally deliver as the recipient. This makes sure that configurations that
37380 work in this mode function the same way in normal mode. Any implicit or
37381 explicit specification of another user causes an error.
37382 .next
37383 Use of &_.forward_& files is severely restricted, such that it is usually
37384 not worthwhile to include them in the configuration.
37385 .next
37386 Users who wish to use &_.forward_& would have to make their home directory and
37387 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37388 and their equivalents in Exim filters, cannot be used. While they could be
37389 enabled in the Exim user's name, that would be insecure and not very useful.
37390 .next
37391 Unless the local user mailboxes are all owned by the Exim user (possible in
37392 some POP3 or IMAP-only environments):
37393
37394 .olist
37395 They must be owned by the Exim group and be writeable by that group. This
37396 implies you must set &%mode%& in the appendfile configuration, as well as the
37397 mode of the mailbox files themselves.
37398 .next
37399 You must set &%no_check_owner%&, since most or all of the files will not be
37400 owned by the Exim user.
37401 .next
37402 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37403 on a newly created mailbox when unprivileged. This also implies that new
37404 mailboxes need to be created manually.
37405 .endlist olist
37406 .endlist ilist
37407
37408
37409 These restrictions severely restrict what can be done in local deliveries.
37410 However, there are no restrictions on remote deliveries. If you are running a
37411 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37412 gives more security at essentially no cost.
37413
37414 If you are using the &%mua_wrapper%& facility (see chapter
37415 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37416
37417
37418
37419
37420 .section "Delivering to local files" "SECID271"
37421 Full details of the checks applied by &(appendfile)& before it writes to a file
37422 are given in chapter &<<CHAPappendfile>>&.
37423
37424
37425
37426 .section "Running local commands" "SECTsecconslocalcmds"
37427 .cindex "security" "local commands"
37428 .cindex "security" "command injection attacks"
37429 There are a number of ways in which an administrator can configure Exim to run
37430 commands based upon received, untrustworthy, data. Further, in some
37431 configurations a user who can control a &_.forward_& file can also arrange to
37432 run commands. Configuration to check includes, but is not limited to:
37433
37434 .ilist
37435 Use of &%use_shell%& in the pipe transport: various forms of shell command
37436 injection may be possible with this option present. It is dangerous and should
37437 be used only with considerable caution. Consider constraints which whitelist
37438 allowed characters in a variable which is to be used in a pipe transport that
37439 has &%use_shell%& enabled.
37440 .next
37441 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37442 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37443 &_.forward_& files in a redirect router. If Exim is running on a central mail
37444 hub to which ordinary users do not have shell access, but home directories are
37445 NFS mounted (for instance) then administrators should review the list of these
37446 forbid options available, and should bear in mind that the options that may
37447 need forbidding can change as new features are added between releases.
37448 .next
37449 The &%${run...}%& expansion item does not use a shell by default, but
37450 administrators can configure use of &_/bin/sh_& as part of the command.
37451 Such invocations should be viewed with prejudicial suspicion.
37452 .next
37453 Administrators who use embedded Perl are advised to explore how Perl's
37454 taint checking might apply to their usage.
37455 .next
37456 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37457 administrators are well advised to view its use with suspicion, in case (for
37458 instance) it allows a local-part to contain embedded Exim directives.
37459 .next
37460 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37461 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37462 each can reference arbitrary lists and files, rather than just being a list
37463 of opaque strings.
37464 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37465 real-world security vulnerabilities caused by its use with untrustworthy data
37466 injected in, for SQL injection attacks.
37467 Consider the use of the &%inlisti%& expansion condition instead.
37468 .endlist
37469
37470
37471
37472
37473 .section "Trust in configuration data" "SECTsecconfdata"
37474 .cindex "security" "data sources"
37475 .cindex "security" "regular expressions"
37476 .cindex "regular expressions" "security"
37477 .cindex "PCRE" "security"
37478 If configuration data for Exim can come from untrustworthy sources, there
37479 are some issues to be aware of:
37480
37481 .ilist
37482 Use of &%${expand...}%& may provide a path for shell injection attacks.
37483 .next
37484 Letting untrusted data provide a regular expression is unwise.
37485 .next
37486 Using &%${match...}%& to apply a fixed regular expression against untrusted
37487 data may result in pathological behaviour within PCRE.  Be aware of what
37488 "backtracking" means and consider options for being more strict with a regular
37489 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37490 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37491 possessive quantifiers or just not using regular expressions against untrusted
37492 data.
37493 .next
37494 It can be important to correctly use &%${quote:...}%&,
37495 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37496 items to ensure that data is correctly constructed.
37497 .next
37498 Some lookups might return multiple results, even though normal usage is only
37499 expected to yield one result.
37500 .endlist
37501
37502
37503
37504
37505 .section "IPv4 source routing" "SECID272"
37506 .cindex "source routing" "in IP packets"
37507 .cindex "IP source routing"
37508 Many operating systems suppress IP source-routed packets in the kernel, but
37509 some cannot be made to do this, so Exim does its own check. It logs incoming
37510 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37511 IPv6. No special checking is currently done.
37512
37513
37514
37515 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37516 Support for these SMTP commands is disabled by default. If required, they can
37517 be enabled by defining suitable ACLs.
37518
37519
37520
37521
37522 .section "Privileged users" "SECID274"
37523 .cindex "trusted users"
37524 .cindex "admin user"
37525 .cindex "privileged user"
37526 .cindex "user" "trusted"
37527 .cindex "user" "admin"
37528 Exim recognizes two sets of users with special privileges. Trusted users are
37529 able to submit new messages to Exim locally, but supply their own sender
37530 addresses and information about a sending host. For other users submitting
37531 local messages, Exim sets up the sender address from the uid, and doesn't
37532 permit a remote host to be specified.
37533
37534 .oindex "&%-f%&"
37535 However, an untrusted user is permitted to use the &%-f%& command line option
37536 in the special form &%-f <>%& to indicate that a delivery failure for the
37537 message should not cause an error report. This affects the message's envelope,
37538 but it does not affect the &'Sender:'& header. Untrusted users may also be
37539 permitted to use specific forms of address with the &%-f%& option by setting
37540 the &%untrusted_set_sender%& option.
37541
37542 Trusted users are used to run processes that receive mail messages from some
37543 other mail domain and pass them on to Exim for delivery either locally, or over
37544 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37545 as any user listed in the &%trusted_users%& configuration option, or under any
37546 group listed in the &%trusted_groups%& option.
37547
37548 Admin users are permitted to do things to the messages on Exim's queue. They
37549 can freeze or thaw messages, cause them to be returned to their senders, remove
37550 them entirely, or modify them in various ways. In addition, admin users can run
37551 the Exim monitor and see all the information it is capable of providing, which
37552 includes the contents of files on the spool.
37553
37554 .oindex "&%-M%&"
37555 .oindex "&%-q%&"
37556 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37557 delivery of messages on its queue is restricted to admin users. This
37558 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37559 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37560 queue is also restricted to admin users. This restriction can be relaxed by
37561 setting &%no_queue_list_requires_admin%&.
37562
37563 Exim recognizes an admin user if the calling process is running as root or as
37564 the Exim user or if any of the groups associated with the calling process is
37565 the Exim group. It is not necessary actually to be running under the Exim
37566 group. However, if admin users who are not root or the Exim user are to access
37567 the contents of files on the spool via the Exim monitor (which runs
37568 unprivileged), Exim must be built to allow group read access to its spool
37569 files.
37570
37571
37572
37573 .section "Spool files" "SECID275"
37574 .cindex "spool directory" "files"
37575 Exim's spool directory and everything it contains is owned by the Exim user and
37576 set to the Exim group. The mode for spool files is defined in the
37577 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37578 any user who is a member of the Exim group can access these files.
37579
37580
37581
37582 .section "Use of argv[0]" "SECID276"
37583 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37584 of specific strings, Exim assumes certain options. For example, calling Exim
37585 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37586 to calling it with the option &%-bS%&. There are no security implications in
37587 this.
37588
37589
37590
37591 .section "Use of %f formatting" "SECID277"
37592 The only use made of &"%f"& by Exim is in formatting load average values. These
37593 are actually stored in integer variables as 1000 times the load average.
37594 Consequently, their range is limited and so therefore is the length of the
37595 converted output.
37596
37597
37598
37599 .section "Embedded Exim path" "SECID278"
37600 Exim uses its own path name, which is embedded in the code, only when it needs
37601 to re-exec in order to regain root privilege. Therefore, it is not root when it
37602 does so. If some bug allowed the path to get overwritten, it would lead to an
37603 arbitrary program's being run as exim, not as root.
37604
37605
37606
37607 .section "Dynamic module directory" "SECTdynmoddir"
37608 Any dynamically loadable modules must be installed into the directory
37609 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37610 loading it.
37611
37612
37613 .section "Use of sprintf()" "SECID279"
37614 .cindex "&[sprintf()]&"
37615 A large number of occurrences of &"sprintf"& in the code are actually calls to
37616 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37617 The intermediate formatting is done into a large fixed buffer by a function
37618 that runs through the format string itself, and checks the length of each
37619 conversion before performing it, thus preventing buffer overruns.
37620
37621 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37622 the output buffer is known to be sufficiently long to contain the converted
37623 string.
37624
37625
37626
37627 .section "Use of debug_printf() and log_write()" "SECID280"
37628 Arbitrary strings are passed to both these functions, but they do their
37629 formatting by calling the function &'string_vformat()'&, which runs through
37630 the format string itself, and checks the length of each conversion.
37631
37632
37633
37634 .section "Use of strcat() and strcpy()" "SECID281"
37635 These are used only in cases where the output buffer is known to be large
37636 enough to hold the result.
37637 .ecindex IIDsecurcon
37638
37639
37640
37641
37642 . ////////////////////////////////////////////////////////////////////////////
37643 . ////////////////////////////////////////////////////////////////////////////
37644
37645 .chapter "Format of spool files" "CHAPspool"
37646 .scindex IIDforspo1 "format" "spool files"
37647 .scindex IIDforspo2 "spool directory" "format of files"
37648 .scindex IIDforspo3 "spool files" "format of"
37649 .cindex "spool files" "editing"
37650 A message on Exim's queue consists of two files, whose names are the message id
37651 followed by -D and -H, respectively. The data portion of the message is kept in
37652 the -D file on its own. The message's envelope, status, and headers are all
37653 kept in the -H file, whose format is described in this chapter. Each of these
37654 two files contains the final component of its own name as its first line. This
37655 is insurance against disk crashes where the directory is lost but the files
37656 themselves are recoverable.
37657
37658 Some people are tempted into editing -D files in order to modify messages. You
37659 need to be extremely careful if you do this; it is not recommended and you are
37660 on your own if you do it. Here are some of the pitfalls:
37661
37662 .ilist
37663 You must ensure that Exim does not try to deliver the message while you are
37664 fiddling with it. The safest way is to take out a write lock on the -D file,
37665 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37666 place, the lock will be retained. If you write a new file and rename it, the
37667 lock will be lost at the instant of rename.
37668 .next
37669 .vindex "&$body_linecount$&"
37670 If you change the number of lines in the file, the value of
37671 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37672 present, this value is not used by Exim, but there is no guarantee that this
37673 will always be the case.
37674 .next
37675 If the message is in MIME format, you must take care not to break it.
37676 .next
37677 If the message is cryptographically signed, any change will invalidate the
37678 signature.
37679 .endlist
37680 All in all, modifying -D files is fraught with danger.
37681
37682 Files whose names end with -J may also be seen in the &_input_& directory (or
37683 its subdirectories when &%split_spool_directory%& is set). These are journal
37684 files, used to record addresses to which the message has been delivered during
37685 the course of a delivery attempt. If there are still undelivered recipients at
37686 the end, the -H file is updated, and the -J file is deleted. If, however, there
37687 is some kind of crash (for example, a power outage) before this happens, the -J
37688 file remains in existence. When Exim next processes the message, it notices the
37689 -J file and uses it to update the -H file before starting the next delivery
37690 attempt.
37691
37692 .section "Format of the -H file" "SECID282"
37693 .cindex "uid (user id)" "in spool file"
37694 .cindex "gid (group id)" "in spool file"
37695 The second line of the -H file contains the login name for the uid of the
37696 process that called Exim to read the message, followed by the numerical uid and
37697 gid. For a locally generated message, this is normally the user who sent the
37698 message. For a message received over TCP/IP via the daemon, it is
37699 normally the Exim user.
37700
37701 The third line of the file contains the address of the message's sender as
37702 transmitted in the envelope, contained in angle brackets. The sender address is
37703 empty for bounce messages. For incoming SMTP mail, the sender address is given
37704 in the MAIL command. For locally generated mail, the sender address is
37705 created by Exim from the login name of the current user and the configured
37706 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37707 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37708 &"<>"& or an address that matches &%untrusted_set_senders%&.
37709
37710 The fourth line contains two numbers. The first is the time that the message
37711 was received, in the conventional Unix form &-- the number of seconds since the
37712 start of the epoch. The second number is a count of the number of messages
37713 warning of delayed delivery that have been sent to the sender.
37714
37715 There follow a number of lines starting with a hyphen. These can appear in any
37716 order, and are omitted when not relevant:
37717
37718 .vlist
37719 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37720 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37721 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37722 recognized, to provide backward compatibility. In the old format, a line of
37723 this form is present for every ACL variable that is not empty. The number
37724 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37725 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37726 the data string for the variable. The string itself starts at the beginning of
37727 the next line, and is followed by a newline character. It may contain internal
37728 newlines.
37729
37730 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37731 A line of this form is present for every ACL connection variable that is
37732 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37733 The length is the length of the data string for the variable. The string itself
37734 starts at the beginning of the next line, and is followed by a newline
37735 character. It may contain internal newlines.
37736
37737 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37738 A line of this form is present for every ACL message variable that is defined.
37739 Note that there is a space between &%-aclm%& and the rest of the name. The
37740 length is the length of the data string for the variable. The string itself
37741 starts at the beginning of the next line, and is followed by a newline
37742 character. It may contain internal newlines.
37743
37744 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37745 This is present if, when the message was received over SMTP, the value of
37746 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37747
37748 .vitem &%-allow_unqualified_recipient%&
37749 This is present if unqualified recipient addresses are permitted in header
37750 lines (to stop such addresses from being qualified if rewriting occurs at
37751 transport time). Local messages that were input using &%-bnq%& and remote
37752 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37753
37754 .vitem &%-allow_unqualified_sender%&
37755 This is present if unqualified sender addresses are permitted in header lines
37756 (to stop such addresses from being qualified if rewriting occurs at transport
37757 time). Local messages that were input using &%-bnq%& and remote messages from
37758 hosts that match &%sender_unqualified_hosts%& set this flag.
37759
37760 .vitem "&%-auth_id%&&~<&'text'&>"
37761 The id information for a message received on an authenticated SMTP connection
37762 &-- the value of the &$authenticated_id$& variable.
37763
37764 .vitem "&%-auth_sender%&&~<&'address'&>"
37765 The address of an authenticated sender &-- the value of the
37766 &$authenticated_sender$& variable.
37767
37768 .vitem "&%-body_linecount%&&~<&'number'&>"
37769 This records the number of lines in the body of the message, and is always
37770 present.
37771
37772 .vitem "&%-body_zerocount%&&~<&'number'&>"
37773 This records the number of binary zero bytes in the body of the message, and is
37774 present if the number is greater than zero.
37775
37776 .vitem &%-deliver_firsttime%&
37777 This is written when a new message is first added to the spool. When the spool
37778 file is updated after a deferral, it is omitted.
37779
37780 .vitem "&%-frozen%&&~<&'time'&>"
37781 .cindex "frozen messages" "spool data"
37782 The message is frozen, and the freezing happened at <&'time'&>.
37783
37784 .vitem "&%-helo_name%&&~<&'text'&>"
37785 This records the host name as specified by a remote host in a HELO or EHLO
37786 command.
37787
37788 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37789 This records the IP address of the host from which the message was received and
37790 the remote port number that was used. It is omitted for locally generated
37791 messages.
37792
37793 .vitem "&%-host_auth%&&~<&'text'&>"
37794 If the message was received on an authenticated SMTP connection, this records
37795 the name of the authenticator &-- the value of the
37796 &$sender_host_authenticated$& variable.
37797
37798 .vitem &%-host_lookup_failed%&
37799 This is present if an attempt to look up the sending host's name from its IP
37800 address failed. It corresponds to the &$host_lookup_failed$& variable.
37801
37802 .vitem "&%-host_name%&&~<&'text'&>"
37803 .cindex "reverse DNS lookup"
37804 .cindex "DNS" "reverse lookup"
37805 This records the name of the remote host from which the message was received,
37806 if the host name was looked up from the IP address when the message was being
37807 received. It is not present if no reverse lookup was done.
37808
37809 .vitem "&%-ident%&&~<&'text'&>"
37810 For locally submitted messages, this records the login of the originating user,
37811 unless it was a trusted user and the &%-oMt%& option was used to specify an
37812 ident value. For messages received over TCP/IP, this records the ident string
37813 supplied by the remote host, if any.
37814
37815 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37816 This records the IP address of the local interface and the port number through
37817 which a message was received from a remote host. It is omitted for locally
37818 generated messages.
37819
37820 .vitem &%-local%&
37821 The message is from a local sender.
37822
37823 .vitem &%-localerror%&
37824 The message is a locally-generated bounce message.
37825
37826 .vitem "&%-local_scan%&&~<&'string'&>"
37827 This records the data string that was returned by the &[local_scan()]& function
37828 when the message was received &-- the value of the &$local_scan_data$&
37829 variable. It is omitted if no data was returned.
37830
37831 .vitem &%-manual_thaw%&
37832 The message was frozen but has been thawed manually, that is, by an explicit
37833 Exim command rather than via the auto-thaw process.
37834
37835 .vitem &%-N%&
37836 A testing delivery process was started using the &%-N%& option to suppress any
37837 actual deliveries, but delivery was deferred. At any further delivery attempts,
37838 &%-N%& is assumed.
37839
37840 .vitem &%-received_protocol%&
37841 This records the value of the &$received_protocol$& variable, which contains
37842 the name of the protocol by which the message was received.
37843
37844 .vitem &%-sender_set_untrusted%&
37845 The envelope sender of this message was set by an untrusted local caller (used
37846 to ensure that the caller is displayed in queue listings).
37847
37848 .vitem "&%-spam_score_int%&&~<&'number'&>"
37849 If a message was scanned by SpamAssassin, this is present. It records the value
37850 of &$spam_score_int$&.
37851
37852 .vitem &%-tls_certificate_verified%&
37853 A TLS certificate was received from the client that sent this message, and the
37854 certificate was verified by the server.
37855
37856 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37857 When the message was received over an encrypted connection, this records the
37858 name of the cipher suite that was used.
37859
37860 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37861 When the message was received over an encrypted connection, and a certificate
37862 was received from the client, this records the Distinguished Name from that
37863 certificate.
37864 .endlist
37865
37866 Following the options there is a list of those addresses to which the message
37867 is not to be delivered. This set of addresses is initialized from the command
37868 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37869 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37870 the address is added to this set. The addresses are kept internally as a
37871 balanced binary tree, and it is a representation of that tree which is written
37872 to the spool file. If an address is expanded via an alias or forward file, the
37873 original address is added to the tree when deliveries to all its child
37874 addresses are complete.
37875
37876 If the tree is empty, there is a single line in the spool file containing just
37877 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37878 Y or N, followed by an address. The address is the value for the node of the
37879 tree, and the letters indicate whether the node has a left branch and/or a
37880 right branch attached to it, respectively. If branches exist, they immediately
37881 follow. Here is an example of a three-node tree:
37882 .code
37883 YY darcy@austen.fict.example
37884 NN alice@wonderland.fict.example
37885 NN editor@thesaurus.ref.example
37886 .endd
37887 After the non-recipients tree, there is a list of the message's recipients.
37888 This is a simple list, preceded by a count. It includes all the original
37889 recipients of the message, including those to whom the message has already been
37890 delivered. In the simplest case, the list contains one address per line. For
37891 example:
37892 .code
37893 4
37894 editor@thesaurus.ref.example
37895 darcy@austen.fict.example
37896 rdo@foundation
37897 alice@wonderland.fict.example
37898 .endd
37899 However, when a child address has been added to the top-level addresses as a
37900 result of the use of the &%one_time%& option on a &(redirect)& router, each
37901 line is of the following form:
37902 .display
37903 <&'top-level address'&> <&'errors_to address'&> &&&
37904   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37905 .endd
37906 The 01 flag bit indicates the presence of the three other fields that follow
37907 the top-level address. Other bits may be used in future to support additional
37908 fields. The <&'parent number'&> is the offset in the recipients list of the
37909 original parent of the &"one time"& address. The first two fields are the
37910 envelope sender that is associated with this address and its length. If the
37911 length is zero, there is no special envelope sender (there are then two space
37912 characters in the line). A non-empty field can arise from a &(redirect)& router
37913 that has an &%errors_to%& setting.
37914
37915
37916 A blank line separates the envelope and status information from the headers
37917 which follow. A header may occupy several lines of the file, and to save effort
37918 when reading it in, each header is preceded by a number and an identifying
37919 character. The number is the number of characters in the header, including any
37920 embedded newlines and the terminating newline. The character is one of the
37921 following:
37922
37923 .table2 50pt
37924 .row <&'blank'&>         "header in which Exim has no special interest"
37925 .row &`B`&               "&'Bcc:'& header"
37926 .row &`C`&               "&'Cc:'& header"
37927 .row &`F`&               "&'From:'& header"
37928 .row &`I`&               "&'Message-id:'& header"
37929 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37930 .row &`R`&               "&'Reply-To:'& header"
37931 .row &`S`&               "&'Sender:'& header"
37932 .row &`T`&               "&'To:'& header"
37933 .row &`*`&               "replaced or deleted header"
37934 .endtable
37935
37936 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37937 purposes. They are not transmitted when the message is delivered. Here is a
37938 typical set of headers:
37939 .code
37940 111P Received: by hobbit.fict.example with local (Exim 4.00)
37941 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37942 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37943 038* X-rewrote-sender: bb@hobbit.fict.example
37944 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37945 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37946 099* To: alice@wonderland.fict.example, rdo@foundation,
37947 darcy@austen.fict.example, editor@thesaurus.ref.example
37948 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37949 darcy@austen.fict.example, editor@thesaurus.ref.example
37950 038  Date: Fri, 11 May 2001 10:28:59 +0100
37951 .endd
37952 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37953 &'To:'& header have been rewritten, the last one because routing expanded the
37954 unqualified domain &'foundation'&.
37955 .ecindex IIDforspo1
37956 .ecindex IIDforspo2
37957 .ecindex IIDforspo3
37958
37959 . ////////////////////////////////////////////////////////////////////////////
37960 . ////////////////////////////////////////////////////////////////////////////
37961
37962 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37963          "DKIM Support"
37964 .cindex "DKIM"
37965
37966 DKIM is a mechanism by which messages sent by some entity can be provably
37967 linked to a domain which that entity controls.  It permits reputation to
37968 be tracked on a per-domain basis, rather than merely upon source IP address.
37969 DKIM is documented in RFC 4871.
37970
37971 .new
37972 DKIM support is compiled into Exim by default if TLS support is present.
37973 .wen
37974 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
37975
37976 Exim's DKIM implementation allows to
37977 .olist
37978 Sign outgoing messages: This function is implemented in the SMTP transport.
37979 It can co-exist with all other Exim features
37980 (including transport filters)
37981 except cutthrough delivery.
37982 .next
37983 Verify signatures in incoming messages: This is implemented by an additional
37984 ACL (acl_smtp_dkim), which can be called several times per message, with
37985 different signature contexts.
37986 .endlist
37987
37988 In typical Exim style, the verification implementation does not include any
37989 default "policy". Instead it enables you to build your own policy using
37990 Exim's standard controls.
37991
37992 Please note that verification of DKIM signatures in incoming mail is turned
37993 on by default for logging purposes. For each signature in incoming email,
37994 exim will log a line displaying the most important signature details, and the
37995 signature status. Here is an example (with line-breaks added for clarity):
37996 .code
37997 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37998     d=facebookmail.com s=q1-2009b
37999     c=relaxed/relaxed a=rsa-sha1
38000     i=@facebookmail.com t=1252484542 [verification succeeded]
38001 .endd
38002 You might want to turn off DKIM verification processing entirely for internal
38003 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38004 control modifier. This should typically be done in the RCPT ACL, at points
38005 where you accept mail from relay sources (internal hosts or authenticated
38006 senders).
38007
38008
38009 .section "Signing outgoing messages" "SECID513"
38010 .cindex "DKIM" "signing"
38011
38012 Signing is implemented by setting private options on the SMTP transport.
38013 These options take (expandable) strings as arguments.
38014
38015 .option dkim_domain smtp string&!! unset
38016 MANDATORY:
38017 The domain you want to sign with. The result of this expanded
38018 option is put into the &%$dkim_domain%& expansion variable.
38019
38020 .option dkim_selector smtp string&!! unset
38021 MANDATORY:
38022 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38023 variable to look up a matching selector. The result is put in the expansion
38024 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38025 option along with &%$dkim_domain%&.
38026
38027 .option dkim_private_key smtp string&!! unset
38028 MANDATORY:
38029 This sets the private key to use. You can use the &%$dkim_domain%& and
38030 &%$dkim_selector%& expansion variables to determine the private key to use.
38031 The result can either
38032 .ilist
38033 be a valid RSA private key in ASCII armor, including line breaks.
38034 .next
38035 start with a slash, in which case it is treated as a file that contains
38036 the private key.
38037 .next
38038 be "0", "false" or the empty string, in which case the message will not
38039 be signed. This case will not result in an error, even if &%dkim_strict%&
38040 is set.
38041 .endlist
38042
38043 .option dkim_canon smtp string&!! unset
38044 OPTIONAL:
38045 This option sets the canonicalization method used when signing a message.
38046 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38047 The option defaults to "relaxed" when unset. Note: the current implementation
38048 only supports using the same canonicalization method for both headers and body.
38049
38050 .option dkim_strict smtp string&!! unset
38051 OPTIONAL:
38052 This  option  defines  how  Exim  behaves  when  signing a message that
38053 should be signed fails for some reason.  When the expansion evaluates to
38054 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38055 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38056 variables here.
38057
38058 .option dkim_sign_headers smtp string&!! unset
38059 OPTIONAL:
38060 When set, this option must expand to (or be specified as) a colon-separated
38061 list of header names. Headers with these names will be included in the message
38062 signature. When unspecified, the header names recommended in RFC4871 will be
38063 used.
38064
38065
38066 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38067 .cindex "DKIM" "verification"
38068
38069 Verification of DKIM signatures in incoming email is implemented via the
38070 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38071 syntactically(!) correct signature in the incoming message.
38072 A missing ACL definition defaults to accept.
38073 If any ACL call does not accept, the message is not accepted.
38074 If a cutthrough delivery was in progress for the message it is
38075 summarily dropped (having wasted the transmission effort).
38076
38077 To evaluate the signature in the ACL a large number of expansion variables
38078 containing the signature status and its details are set up during the
38079 runtime of the ACL.
38080
38081 Calling the ACL only for existing signatures is not sufficient to build
38082 more advanced policies. For that reason, the global option
38083 &%dkim_verify_signers%&, and a global expansion variable
38084 &%$dkim_signers%& exist.
38085
38086 The global option &%dkim_verify_signers%& can be set to a colon-separated
38087 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38088 called. It is expanded when the message has been received. At this point,
38089 the expansion variable &%$dkim_signers%& already contains a colon-separated
38090 list of signer domains and identities for the message. When
38091 &%dkim_verify_signers%& is not specified in the main configuration,
38092 it defaults as:
38093 .code
38094 dkim_verify_signers = $dkim_signers
38095 .endd
38096 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38097 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38098 call the ACL for known domains or identities. This would be achieved as follows:
38099 .code
38100 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38101 .endd
38102 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38103 and "ebay.com", plus all domains and identities that have signatures in the message.
38104 You can also be more creative in constructing your policy. For example:
38105 .code
38106 dkim_verify_signers = $sender_address_domain:$dkim_signers
38107 .endd
38108
38109 If a domain or identity is listed several times in the (expanded) value of
38110 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38111
38112
38113 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38114 available (from most to least important):
38115
38116
38117 .vlist
38118 .vitem &%$dkim_cur_signer%&
38119 The signer that is being evaluated in this ACL run. This can be a domain or
38120 an identity. This is one of the list items from the expanded main option
38121 &%dkim_verify_signers%& (see above).
38122 .vitem &%$dkim_verify_status%&
38123 A string describing the general status of the signature. One of
38124 .ilist
38125 &%none%&: There is no signature in the message for the current domain or
38126 identity (as reflected by &%$dkim_cur_signer%&).
38127 .next
38128 &%invalid%&: The signature could not be verified due to a processing error.
38129 More detail is available in &%$dkim_verify_reason%&.
38130 .next
38131 &%fail%&: Verification of the signature failed.  More detail is
38132 available in &%$dkim_verify_reason%&.
38133 .next
38134 &%pass%&: The signature passed verification. It is valid.
38135 .endlist
38136 .vitem &%$dkim_verify_reason%&
38137 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38138 "fail" or "invalid". One of
38139 .ilist
38140 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38141 key for the domain could not be retrieved. This may be a temporary problem.
38142 .next
38143 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38144 record for the domain is syntactically invalid.
38145 .next
38146 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38147 body hash does not match the one specified in the signature header. This
38148 means that the message body was modified in transit.
38149 .next
38150 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38151 could not be verified. This may mean that headers were modified,
38152 re-written or otherwise changed in a way which is incompatible with
38153 DKIM verification. It may of course also mean that the signature is forged.
38154 .endlist
38155 .vitem &%$dkim_domain%&
38156 The signing domain. IMPORTANT: This variable is only populated if there is
38157 an actual signature in the message for the current domain or identity (as
38158 reflected by &%$dkim_cur_signer%&).
38159 .vitem &%$dkim_identity%&
38160 The signing identity, if present. IMPORTANT: This variable is only populated
38161 if there is an actual signature in the message for the current domain or
38162 identity (as reflected by &%$dkim_cur_signer%&).
38163 .vitem &%$dkim_selector%&
38164 The key record selector string.
38165 .vitem &%$dkim_algo%&
38166 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38167 .vitem &%$dkim_canon_body%&
38168 The body canonicalization method. One of 'relaxed' or 'simple'.
38169 .vitem &%dkim_canon_headers%&
38170 The header canonicalization method. One of 'relaxed' or 'simple'.
38171 .vitem &%$dkim_copiedheaders%&
38172 A transcript of headers and their values which are included in the signature
38173 (copied from the 'z=' tag of the signature).
38174 .vitem &%$dkim_bodylength%&
38175 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38176 limit was set by the signer, "9999999999999" is returned. This makes sure
38177 that this variable always expands to an integer value.
38178 .vitem &%$dkim_created%&
38179 UNIX timestamp reflecting the date and time when the signature was created.
38180 When this was not specified by the signer, "0" is returned.
38181 .vitem &%$dkim_expires%&
38182 UNIX timestamp reflecting the date and time when the signer wants the
38183 signature to be treated as "expired". When this was not specified by the
38184 signer, "9999999999999" is returned. This makes it possible to do useful
38185 integer size comparisons against this value.
38186 .vitem &%$dkim_headernames%&
38187 A colon-separated list of names of headers included in the signature.
38188 .vitem &%$dkim_key_testing%&
38189 "1" if the key record has the "testing" flag set, "0" if not.
38190 .vitem &%$dkim_key_nosubdomains%&
38191 "1" if the key record forbids subdomaining, "0" otherwise.
38192 .vitem &%$dkim_key_srvtype%&
38193 Service type (tag s=) from the key record. Defaults to "*" if not specified
38194 in the key record.
38195 .vitem &%$dkim_key_granularity%&
38196 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38197 in the key record.
38198 .vitem &%$dkim_key_notes%&
38199 Notes from the key record (tag n=).
38200 .vitem &%$dkim_key_length%&
38201 Number of bits in the key.
38202 .endlist
38203
38204 In addition, two ACL conditions are provided:
38205
38206 .vlist
38207 .vitem &%dkim_signers%&
38208 ACL condition that checks a colon-separated list of domains or identities
38209 for a match against the domain or identity that the ACL is currently verifying
38210 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38211 verb to a group of domains or identities. For example:
38212
38213 .code
38214 # Warn when Mail purportedly from GMail has no signature at all
38215 warn log_message = GMail sender without DKIM signature
38216      sender_domains = gmail.com
38217      dkim_signers = gmail.com
38218      dkim_status = none
38219 .endd
38220
38221 .vitem &%dkim_status%&
38222 ACL condition that checks a colon-separated list of possible DKIM verification
38223 results against the actual result of verification. This is typically used
38224 to restrict an ACL verb to a list of verification outcomes, for example:
38225
38226 .code
38227 deny message = Mail from Paypal with invalid/missing signature
38228      sender_domains = paypal.com:paypal.de
38229      dkim_signers = paypal.com:paypal.de
38230      dkim_status = none:invalid:fail
38231 .endd
38232
38233 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38234 see the documentation of the &%$dkim_verify_status%& expansion variable above
38235 for more information of what they mean.
38236 .endlist
38237
38238 . ////////////////////////////////////////////////////////////////////////////
38239 . ////////////////////////////////////////////////////////////////////////////
38240
38241 .chapter "Proxies" "CHAPproxies" &&&
38242          "Proxy support"
38243 .cindex "proxy support"
38244 .cindex "proxy" "access via"
38245
38246 .new
38247 A proxy is an intermediate system through which communication is passed.
38248 Proxies may provide a security, availability or load-distribution function.
38249
38250
38251 .section "Inbound proxies" SECTproxyInbound
38252 .cindex proxy inbound
38253 .cindex proxy "server side"
38254 .cindex proxy "Proxy protocol"
38255 .cindex "Proxy protocol" proxy
38256
38257 Exim has support for receiving inbound SMTP connections via a proxy
38258 that uses &"Proxy Protocol"& to speak to it.
38259 To include this support, include &"SUPPORT_PROXY=yes"&
38260 in Local/Makefile.
38261
38262 It was built on specifications from:
38263 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38264 That URL was revised in May 2014 to version 2 spec:
38265 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38266
38267 The purpose of this facility is so that an application load balancer,
38268 such as HAProxy, can sit in front of several Exim servers
38269 to distribute load.
38270 Exim uses the local protocol communication with the proxy to obtain
38271 the remote SMTP system IP address and port information.
38272 There is no logging if a host passes or
38273 fails Proxy Protocol negotiation, but it can easily be determined and
38274 recorded in an ACL (example is below).
38275
38276 Use of a proxy is enabled by setting the &%hosts_proxy%&
38277 main configuration option to a hostlist; connections from these
38278 hosts will use Proxy Protocol.
38279
38280 The following expansion variables are usable
38281 (&"internal"& and &"external"& here refer to the interfaces
38282 of the proxy):
38283 .display
38284 &'proxy_host_address   '& internal IP address of the proxy
38285 &'proxy_host_port      '& internal TCP port of the proxy
38286 &'proxy_target_address '& external IP address of the proxy
38287 &'proxy_target_port    '& external TCP port of the proxy
38288 &'proxy_session        '& boolean: SMTP connection via proxy
38289 .endd
38290 If &$proxy_session$& is set but &$proxy_host_address$& is empty
38291 there was a protocol error.
38292
38293 Since the real connections are all coming from the proxy, and the
38294 per host connection tracking is done before Proxy Protocol is
38295 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38296 handle all of the parallel volume you expect per inbound proxy.
38297 With the option set so high, you lose the ability
38298 to protect your server from many connections from one IP.
38299 In order to prevent your server from overload, you
38300 need to add a per connection ratelimit to your connect ACL.
38301 A possible solution is:
38302 .display
38303   # Set max number of connections per host
38304   LIMIT   = 5
38305   # Or do some kind of IP lookup in a flat file or database
38306   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38307
38308   defer   message        = Too many connections from this IP right now
38309           ratelimit      = LIMIT / 5s / per_conn / strict
38310 .endd
38311
38312
38313
38314 .section "Outbound proxies" SECTproxySOCKS
38315 .cindex proxy outbound
38316 .cindex proxy "client side"
38317 .cindex proxy SOCKS
38318 .cindex SOCKS proxy
38319 Exim has support for sending outbound SMTP via a proxy
38320 using a protocol called SOCKS5 (defined by RFC1928).
38321 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38322 Local/Makefile.
38323
38324 Use of a proxy is enabled by setting the &%socks_proxy%& option
38325 on an smtp transport.
38326 The option value is expanded and should then be a list
38327 (colon-separated by default) of proxy specifiers.
38328 Each proxy specifier is a list
38329 (space-separated by default) where the initial element
38330 is an IP address and any subsequent elements are options.
38331
38332 Options are a string <name>=<value>. 
38333 The list of options is in the following table:
38334 .display
38335 &'auth   '& authentication method
38336 &'name   '& authentication username
38337 &'pass   '& authentication password
38338 &'port   '& tcp port
38339 &'tmo    '& connection timeout
38340 &'pri    '& priority
38341 &'weight '& selection bias
38342 .endd
38343
38344 More details on each of these options follows:
38345
38346 .ilist
38347 .cindex authentication "to proxy"
38348 .cindex proxy authentication
38349 &%auth%&: Either &"none"& (default) or &"name"&.
38350 Using &"name"& selects username/password authentication per RFC 1929
38351 for access to the proxy.
38352 Default is &"none"&.
38353 .next
38354 &%name%&: sets the username for the &"name"& authentication method.
38355 Default is empty.
38356 .next
38357 &%pass%&: sets the password for the &"name"& authentication method.
38358 Default is empty.
38359 .next
38360 &%port%&: the TCP port number to use for the connection to the proxy.
38361 Default is 1080.
38362 .next
38363 &%tmo%&: sets a connection timeout in seconds for this proxy.
38364 Default is 5.
38365 .next
38366 &%pri%&: specifies a priority for the proxy within the list,
38367 higher values being tried first.
38368 The default priority is 1.
38369 .next
38370 &%weight%&: specifies a selection bias.
38371 Within a priority set servers are queried in a random fashion,
38372 weighted by this value.
38373 The default value for selection bias is 1.
38374 .endlist
38375
38376 Proxies from the list are tried according to their priority
38377 and weight settings until one responds.  The timeout for the
38378 overall connection applies to the set of proxied attempts.
38379
38380 .section Logging SECTproxyLog
38381 To log the (local) IP of a proxy in the incoming or delivery logline,
38382 add &"+proxy"& to the &%log_selector%& option.
38383 This will add a component tagged with &"PRX="& to the line.
38384 .wen
38385
38386 . ////////////////////////////////////////////////////////////////////////////
38387 . ////////////////////////////////////////////////////////////////////////////
38388
38389 .chapter "Internationalisation" "CHAPi18n" &&&
38390          "Internationalisation""
38391 .cindex internationalisation "email address"
38392 .cindex EAI
38393 .cindex i18n
38394 .cindex UTF-8 "mail name handling"
38395
38396 .new
38397 Exim has support for Internationalised mail names.
38398 To include this it must be built with SUPPORT_I18N and the libidn library.
38399 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38400
38401 .section "MTA operations" SECTi18nMTA
38402 .cindex SMTPUTF8 "ESMTP option"
38403 The main configuration option &%smtputf8_advertise_hosts%& specifies
38404 a host list.  If this matches the sending host and
38405 accept_8bitmime is true (the default) then the ESMTP option
38406 SMTPUTF8 will be advertised.
38407
38408 If the sender specifies the SMTPUTF8 option on a MAIL command
38409 international handling for the message is enabled and
38410 the expansion variable &$message_smtputf8$& will have value TRUE.
38411
38412 The option &%allow_utf8_domains%& is set to true for this
38413 message. All DNS lookups are converted to a-label form
38414 whatever the setting of &%allow_utf8_domains%&
38415 when Exim is built with SUPPORT_I18N.
38416
38417 Both localparts and domain are maintained as the original
38418 UTF-8 form internally; any comparison or regular-expression use will
38419 require appropriate care.  Filenames created, eg. by
38420 the appendfile transport, will have UTF-8 names.
38421
38422 HELO names sent by the smtp transport will have any UTF-8
38423 components expanded to a-label form,
38424 and any certificate name checks will be done using the a-label
38425 form of the name.
38426
38427 .cindex log protocol
38428 .cindex SMTPUTF8 logging
38429 Log lines and Received-by: header lines will acquire a "utf8"
38430 prefix on the protocol element, eg. utf8esmtp.
38431
38432 The following expansion operator can be used:
38433 .code
38434 ${utf8_domain_to_alabel:str}
38435 ${utf8_domain_from_alabel:str}
38436 ${utf8_localpart_to_alabel:str}
38437 ${utf8_localpart_from_alabel:str}
38438 .endd
38439
38440 ACLs may use the following modifier:
38441 .display
38442 control = utf8_downconvert
38443 control = utf8_downconvert/<value>
38444 .endd
38445 This sets a flag requiring that addresses are converted to
38446 a-label form before smtp delivery, for use in a
38447 Message Submission Agent context.
38448 If a value is appended it may be:
38449 .display
38450 &`1  `& (default) mandatory downconversion
38451 &`0  `& no downconversion
38452 &`-1 `& if SMTPUTF8 not supported by destination host
38453 .endd
38454
38455 If mua_wrapper is set, the utf8_downconvert control
38456 is initially set to -1.
38457
38458
38459 There is no explicit support for VRFY and EXPN.
38460 Configurations supporting these should inspect
38461 &$smtp_command_argument$& for an SMTPUTF8 argument.
38462
38463 There is no support for LMTP on Unix sockets.
38464 Using the "lmtp" protocol option on an smtp transport,
38465 for LMTP over TCP, should work as expected.
38466
38467 There is no support for DSN unitext handling,
38468 and no provision for converting logging from or to UTF-8.
38469
38470
38471
38472 .section "MDA operations" SECTi18nMDA
38473 To aid in constructing names suitable for IMAP folders
38474 the following expansion operator can be used:
38475 .code
38476 ${imapfolder {<string>} {<sep>} {<specials>}}
38477 .endd
38478
38479 The string is converted from the charset specified by
38480 the "headers charset" command (in a filter file)
38481 or &%headers_charset%& main configuration option (otherwise),
38482 to the
38483 modified UTF-7 encoding specified by RFC 2060,
38484 with the following exception: All occurences of <sep>
38485 (which has to be a single character)
38486 are replaced with periods ("."), and all periods and slashes that are not
38487 <sep> and are not in the <specials> string are BASE64 encoded.
38488
38489 The third argument can be omitted, defaulting to an empty string.
38490 The second argument can be omitted, defaulting to "/".
38491
38492 This is the encoding used by Courier for Maildir names on disk, and followed
38493 by many other IMAP servers.
38494
38495 Examples:
38496 .display
38497 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38498 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38499 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38500 .endd
38501
38502 Note that the source charset setting is vital, and also that characters
38503 must be representable in UTF-16.
38504
38505 .wen
38506
38507 . ////////////////////////////////////////////////////////////////////////////
38508 . ////////////////////////////////////////////////////////////////////////////
38509
38510 .chapter "Events" "CHAPevents" &&&
38511          "Events"
38512 .cindex events
38513
38514 .new
38515 The events mechanism in Exim can be used to intercept processing at a number
38516 of points.  It was originally invented to giave a way to do customised logging
38517 actions (for example, to a database) but can also be used to modify some
38518 processing actions.
38519
38520 Most installations will never need to use Events.
38521 The support can be left out of a build by defining DISABLE_EVENT=yes
38522 in &_Local/Makefile_&.
38523
38524 There are two major classes of events: main and transport.
38525 The main configuration option &%event_action%& controls reception events;
38526 a transport option &%event_action%& controls delivery events.
38527
38528 Both options are a string which is expanded when the event fires.
38529 An example might look like:
38530 .cindex logging custom
38531 .code
38532 event_action = ${if eq {msg:delivery}{$event_name} \
38533 {${lookup pgsql {SELECT * FROM record_Delivery( \
38534     '${quote_pgsql:$sender_address_domain}',\
38535     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38536     '${quote_pgsql:$domain}', \
38537     '${quote_pgsql:${lc:$local_part}}', \
38538     '${quote_pgsql:$host_address}', \
38539     '${quote_pgsql:${lc:$host}}', \
38540     '${quote_pgsql:$message_exim_id}')}} \
38541 } {}}
38542 .endd
38543
38544 Events have names which correspond to the point in process at which they fire.
38545 The name is placed in the variable &$event_name$& and the event action
38546 expansion must check this, as it will be called for every possible event type.
38547
38548 The current list of events is:
38549 .display
38550 &`msg:complete           after    main       `& per message
38551 &`msg:delivery           after    transport  `& per recipient
38552 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38553 &`msg:rcpt:defer         after    transport  `& per recipient
38554 &`msg:host:defer         after    transport  `& per attempt
38555 &`msg:fail:delivery      after    main       `& per recipient
38556 &`msg:fail:internal      after    main       `& per recipient
38557 &`tcp:connect            before   transport  `& per connection
38558 &`tcp:close              after    transport  `& per connection
38559 &`tls:cert               before   both       `& per certificate in verification chain
38560 &`smtp:connect           after    transport  `& per connection
38561 .endd
38562 New event types may be added in future.
38563
38564 The event name is a colon-separated list, defining the type of
38565 event in a tree of possibilities.  It may be used as a list
38566 or just matched on as a whole.  There will be no spaces in the name.
38567
38568 The second column in the table above describes whether the event fires
38569 before or after the action is associates with.  Those which fire before
38570 can be used to affect that action (more on this below).
38571
38572 An additional variable, &$event_data$&, is filled with information varying
38573 with the event type:
38574 .display
38575 &`msg:delivery         `& smtp confirmation mssage
38576 &`msg:rcpt:host:defer  `& error string
38577 &`msg:rcpt:defer       `& error string
38578 &`msg:host:defer       `& error string
38579 &`tls:cert             `& verification chain depth
38580 &`smtp:connect         `& smtp banner
38581 .endd
38582
38583 The :defer events populate one extra variable: &$event_defer_errno$&.
38584
38585 For complex operations an ACL expansion can be used in &%event_action%&
38586 however due to the multiple contextx that Exim operates in during
38587 the course of its processing:
38588 .ilist
38589 variables set in transport events will not be visible outside that
38590 transport call
38591 .next
38592 acl_m variables in a server context are lost on a new connection,
38593 and after smtp helo/ehlo/mail/starttls/rset commands
38594 .endlist
38595 Using an ACL expansion with the logwrite modifier can be
38596 a useful way of writing to the main log.
38597
38598 The expansion of the event_action option should normally
38599 return an empty string.  Should it return anything else the
38600 following will be forced:
38601 .display
38602 &`msg:delivery     `&  (ignored)
38603 &`msg:host:defer   `&  (ignored)
38604 &`msg:fail:delivery`&  (ignored)
38605 &`tcp:connect      `&  do not connect
38606 &`tcp:close        `&  (ignored)
38607 &`tls:cert         `&  refuse verification
38608 &`smtp:connect     `&  close connection
38609 .endd
38610 No other use is made of the result string.
38611
38612 For a tcp:connect event, if the connection is being made to a proxy
38613 then the address and port variables will be that of the proxy and not
38614 the target system.
38615
38616 For tls:cert events, if GnuTLS is in use this will trigger only per
38617 chain element received on the connection.
38618 For OpenSSL it will trigger for every chain element including those
38619 loaded locally.
38620 .wen
38621
38622 . ////////////////////////////////////////////////////////////////////////////
38623 . ////////////////////////////////////////////////////////////////////////////
38624
38625 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38626          "Adding drivers or lookups"
38627 .cindex "adding drivers"
38628 .cindex "new drivers, adding"
38629 .cindex "drivers" "adding new"
38630 The following actions have to be taken in order to add a new router, transport,
38631 authenticator, or lookup type to Exim:
38632
38633 .olist
38634 Choose a name for the driver or lookup type that does not conflict with any
38635 existing name; I will use &"newdriver"& in what follows.
38636 .next
38637 Add to &_src/EDITME_& the line:
38638 .display
38639 <&'type'&>&`_NEWDRIVER=yes`&
38640 .endd
38641 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38642 code is not to be included in the binary by default, comment this line out. You
38643 should also add any relevant comments about the driver or lookup type.
38644 .next
38645 Add to &_src/config.h.defaults_& the line:
38646 .code
38647 #define <type>_NEWDRIVER
38648 .endd
38649 .next
38650 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38651 and create a table entry as is done for all the other drivers and lookup types.
38652 .next
38653 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38654 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38655 Add your &`NEWDRIVER`& to that list.
38656 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38657 simple form that most lookups have.
38658 .next
38659 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38660 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38661 driver or lookup type and add it to the definition of OBJ.
38662 .next
38663 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38664 &_src_&.
38665 .next
38666 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38667 as for other drivers and lookups.
38668 .endlist
38669
38670 Then all you need to do is write the code! A good way to start is to make a
38671 proforma by copying an existing module of the same type, globally changing all
38672 occurrences of the name, and cutting out most of the code. Note that any
38673 options you create must be listed in alphabetical order, because the tables are
38674 searched using a binary chop procedure.
38675
38676 There is a &_README_& file in each of the sub-directories of &_src_& describing
38677 the interface that is expected.
38678
38679
38680
38681
38682 . ////////////////////////////////////////////////////////////////////////////
38683 . ////////////////////////////////////////////////////////////////////////////
38684
38685 . /////////////////////////////////////////////////////////////////////////////
38686 . These lines are processing instructions for the Simple DocBook Processor that
38687 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38688 . PDFs than using xmlto and fop. They will be ignored by all other XML
38689 . processors.
38690 . /////////////////////////////////////////////////////////////////////////////
38691
38692 .literal xml
38693 <?sdop
38694   format="newpage"
38695   foot_right_recto="&chaptertitle;"
38696   foot_right_verso="&chaptertitle;"
38697 ?>
38698 .literal off
38699
38700 .makeindex "Options index"   "option"
38701 .makeindex "Variables index" "variable"
38702 .makeindex "Concept index"   "concept"
38703
38704
38705 . /////////////////////////////////////////////////////////////////////////////
38706 . /////////////////////////////////////////////////////////////////////////////