Extend configure.sample and the relevant spec part
[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 "environment"
3155 If &%environment%& is given as an argument, the set of environment
3156 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3157 variables.
3158
3159 .cindex "options" "macro &-- extracting"
3160 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3161 are available, similarly to the drivers.  Because macros are sometimes used
3162 for storing passwords, this option is restricted.
3163 The output format is one item per line.
3164
3165 .vitem &%-bp%&
3166 .oindex "&%-bp%&"
3167 .cindex "queue" "listing messages on"
3168 .cindex "listing" "messages on the queue"
3169 This option requests a listing of the contents of the mail queue on the
3170 standard output. If the &%-bp%& option is followed by a list of message ids,
3171 just those messages are listed. By default, this option can be used only by an
3172 admin user. However, the &%queue_list_requires_admin%& option can be set false
3173 to allow any user to see the queue.
3174
3175 Each message on the queue is displayed as in the following example:
3176 .code
3177 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3178           red.king@looking-glass.fict.example
3179           <other addresses>
3180 .endd
3181 .cindex "message" "size in queue listing"
3182 .cindex "size" "of message"
3183 The first line contains the length of time the message has been on the queue
3184 (in this case 25 minutes), the size of the message (2.9K), the unique local
3185 identifier for the message, and the message sender, as contained in the
3186 envelope. For bounce messages, the sender address is empty, and appears as
3187 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3188 the default sender address, the user's login name is shown in parentheses
3189 before the sender address.
3190
3191 .cindex "frozen messages" "in queue listing"
3192 If the message is frozen (attempts to deliver it are suspended) then the text
3193 &"*** frozen ***"& is displayed at the end of this line.
3194
3195 The recipients of the message (taken from the envelope, not the headers) are
3196 displayed on subsequent lines. Those addresses to which the message has already
3197 been delivered are marked with the letter D. If an original address gets
3198 expanded into several addresses via an alias or forward file, the original is
3199 displayed with a D only when deliveries for all of its child addresses are
3200 complete.
3201
3202
3203 .vitem &%-bpa%&
3204 .oindex "&%-bpa%&"
3205 This option operates like &%-bp%&, but in addition it shows delivered addresses
3206 that were generated from the original top level address(es) in each message by
3207 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3208 of just &"D"&.
3209
3210
3211 .vitem &%-bpc%&
3212 .oindex "&%-bpc%&"
3213 .cindex "queue" "count of messages on"
3214 This option counts the number of messages on the queue, and writes the total
3215 to the standard output. It is restricted to admin users, unless
3216 &%queue_list_requires_admin%& is set false.
3217
3218
3219 .vitem &%-bpr%&
3220 .oindex "&%-bpr%&"
3221 This option operates like &%-bp%&, but the output is not sorted into
3222 chronological order of message arrival. This can speed it up when there are
3223 lots of messages on the queue, and is particularly useful if the output is
3224 going to be post-processed in a way that doesn't need the sorting.
3225
3226 .vitem &%-bpra%&
3227 .oindex "&%-bpra%&"
3228 This option is a combination of &%-bpr%& and &%-bpa%&.
3229
3230 .vitem &%-bpru%&
3231 .oindex "&%-bpru%&"
3232 This option is a combination of &%-bpr%& and &%-bpu%&.
3233
3234
3235 .vitem &%-bpu%&
3236 .oindex "&%-bpu%&"
3237 This option operates like &%-bp%& but shows only undelivered top-level
3238 addresses for each message displayed. Addresses generated by aliasing or
3239 forwarding are not shown, unless the message was deferred after processing by a
3240 router with the &%one_time%& option set.
3241
3242
3243 .vitem &%-brt%&
3244 .oindex "&%-brt%&"
3245 .cindex "testing" "retry configuration"
3246 .cindex "retry" "configuration testing"
3247 This option is for testing retry rules, and it must be followed by up to three
3248 arguments. It causes Exim to look for a retry rule that matches the values
3249 and to write it to the standard output. For example:
3250 .code
3251 exim -brt bach.comp.mus.example
3252 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3253 .endd
3254 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3255 argument, which is required, can be a complete address in the form
3256 &'local_part@domain'&, or it can be just a domain name. If the second argument
3257 contains a dot, it is interpreted as an optional second domain name; if no
3258 retry rule is found for the first argument, the second is tried. This ties in
3259 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3260 rule is found that matches the host, one that matches the mail domain is
3261 sought. Finally, an argument that is the name of a specific delivery error, as
3262 used in setting up retry rules, can be given. For example:
3263 .code
3264 exim -brt haydn.comp.mus.example quota_3d
3265 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3266 .endd
3267
3268 .vitem &%-brw%&
3269 .oindex "&%-brw%&"
3270 .cindex "testing" "rewriting"
3271 .cindex "rewriting" "testing"
3272 This option is for testing address rewriting rules, and it must be followed by
3273 a single argument, consisting of either a local part without a domain, or a
3274 complete address with a fully qualified domain. Exim outputs how this address
3275 would be rewritten for each possible place it might appear. See chapter
3276 &<<CHAPrewrite>>& for further details.
3277
3278 .vitem &%-bS%&
3279 .oindex "&%-bS%&"
3280 .cindex "SMTP" "batched incoming"
3281 .cindex "batched SMTP input"
3282 This option is used for batched SMTP input, which is an alternative interface
3283 for non-interactive local message submission. A number of messages can be
3284 submitted in a single run. However, despite its name, this is not really SMTP
3285 input. Exim reads each message's envelope from SMTP commands on the standard
3286 input, but generates no responses. If the caller is trusted, or
3287 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3288 believed; otherwise the sender is always the caller of Exim.
3289
3290 The message itself is read from the standard input, in SMTP format (leading
3291 dots doubled), terminated by a line containing just a single dot. An error is
3292 provoked if the terminating dot is missing. A further message may then follow.
3293
3294 As for other local message submissions, the contents of incoming batch SMTP
3295 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3296 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3297 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3298
3299 Some other SMTP commands are recognized in the input. HELO and EHLO act
3300 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3301 QUIT quits, ignoring the rest of the standard input.
3302
3303 .cindex "return code" "for &%-bS%&"
3304 If any error is encountered, reports are written to the standard output and
3305 error streams, and Exim gives up immediately. The return code is 0 if no error
3306 was detected; it is 1 if one or more messages were accepted before the error
3307 was detected; otherwise it is 2.
3308
3309 More details of input using batched SMTP are given in section
3310 &<<SECTincomingbatchedSMTP>>&.
3311
3312 .vitem &%-bs%&
3313 .oindex "&%-bs%&"
3314 .cindex "SMTP" "local input"
3315 .cindex "local SMTP input"
3316 This option causes Exim to accept one or more messages by reading SMTP commands
3317 on the standard input, and producing SMTP replies on the standard output. SMTP
3318 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3319 Some user agents use this interface as a way of passing locally-generated
3320 messages to the MTA.
3321
3322 In
3323 .cindex "sender" "source of"
3324 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3325 set, the senders of messages are taken from the SMTP MAIL commands.
3326 Otherwise the content of these commands is ignored and the sender is set up as
3327 the calling user. Unqualified addresses are automatically qualified using
3328 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3329 &%-bnq%& option is used.
3330
3331 .cindex "inetd"
3332 The
3333 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3334 using a listening daemon. Exim can distinguish the two cases by checking
3335 whether the standard input is a TCP/IP socket. When Exim is called from
3336 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3337 above concerning senders and qualification do not apply. In this situation,
3338 Exim behaves in exactly the same way as it does when receiving a message via
3339 the listening daemon.
3340
3341 .vitem &%-bt%&
3342 .oindex "&%-bt%&"
3343 .cindex "testing" "addresses"
3344 .cindex "address" "testing"
3345 This option runs Exim in address testing mode, in which each argument is taken
3346 as a recipient address to be tested for deliverability. The results are
3347 written to the standard output. If a test fails, and the caller is not an admin
3348 user, no details of the failure are output, because these might contain
3349 sensitive information such as usernames and passwords for database lookups.
3350
3351 If no arguments are given, Exim runs in an interactive manner, prompting with a
3352 right angle bracket for addresses to be tested.
3353
3354 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3355 &[readline()]& function, because it is running as &'root'& and there are
3356 security issues.
3357
3358 Each address is handled as if it were the recipient address of a message
3359 (compare the &%-bv%& option). It is passed to the routers and the result is
3360 written to the standard output. However, any router that has
3361 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3362 genuine routing tests if your first router passes everything to a scanner
3363 program.
3364
3365 .cindex "return code" "for &%-bt%&"
3366 The return code is 2 if any address failed outright; it is 1 if no address
3367 failed outright but at least one could not be resolved for some reason. Return
3368 code 0 is given only when all addresses succeed.
3369
3370 .cindex "duplicate addresses"
3371 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3372 addresses after routing is complete, so that only one delivery takes place.
3373 This does not happen when testing with &%-bt%&; the full results of routing are
3374 always shown.
3375
3376 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3377 routers in the configuration makes any tests on the sender address of a
3378 message,
3379 .oindex "&%-f%&" "for address testing"
3380 you can use the &%-f%& option to set an appropriate sender when running
3381 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3382 default qualifying domain. However, if you have set up (for example) routers
3383 whose behaviour depends on the contents of an incoming message, you cannot test
3384 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3385 doing such tests.
3386
3387 .vitem &%-bV%&
3388 .oindex "&%-bV%&"
3389 .cindex "version number of Exim"
3390 This option causes Exim to write the current version number, compilation
3391 number, and compilation date of the &'exim'& binary to the standard output.
3392 It also lists the DBM library that is being used, the optional modules (such as
3393 specific lookup types), the drivers that are included in the binary, and the
3394 name of the run time configuration file that is in use.
3395
3396 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3397 configuration file. However, this is a static check only. It cannot check
3398 values that are to be expanded. For example, although a misspelt ACL verb is
3399 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3400 alone to discover (for example) all the typos in the configuration; some
3401 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3402 dynamic testing facilities.
3403
3404 .vitem &%-bv%&
3405 .oindex "&%-bv%&"
3406 .cindex "verifying address" "using &%-bv%&"
3407 .cindex "address" "verification"
3408 This option runs Exim in address verification mode, in which each argument is
3409 taken as a recipient address to be verified by the routers. (This does
3410 not involve any verification callouts). During normal operation, verification
3411 happens mostly as a consequence processing a &%verify%& condition in an ACL
3412 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3413 including callouts, see the &%-bh%& and &%-bhc%& options.
3414
3415 If verification fails, and the caller is not an admin user, no details of the
3416 failure are output, because these might contain sensitive information such as
3417 usernames and passwords for database lookups.
3418
3419 If no arguments are given, Exim runs in an interactive manner, prompting with a
3420 right angle bracket for addresses to be verified.
3421
3422 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3423 &[readline()]& function, because it is running as &'exim'& and there are
3424 security issues.
3425
3426 Verification differs from address testing (the &%-bt%& option) in that routers
3427 that have &%no_verify%& set are skipped, and if the address is accepted by a
3428 router that has &%fail_verify%& set, verification fails. The address is
3429 verified as a recipient if &%-bv%& is used; to test verification for a sender
3430 address, &%-bvs%& should be used.
3431
3432 If the &%-v%& option is not set, the output consists of a single line for each
3433 address, stating whether it was verified or not, and giving a reason in the
3434 latter case. Without &%-v%&, generating more than one address by redirection
3435 causes verification to end successfully, without considering the generated
3436 addresses. However, if just one address is generated, processing continues,
3437 and the generated address must verify successfully for the overall verification
3438 to succeed.
3439
3440 When &%-v%& is set, more details are given of how the address has been handled,
3441 and in the case of address redirection, all the generated addresses are also
3442 considered. Verification may succeed for some and fail for others.
3443
3444 The
3445 .cindex "return code" "for &%-bv%&"
3446 return code is 2 if any address failed outright; it is 1 if no address
3447 failed outright but at least one could not be resolved for some reason. Return
3448 code 0 is given only when all addresses succeed.
3449
3450 If any of the routers in the configuration makes any tests on the sender
3451 address of a message, you should use the &%-f%& option to set an appropriate
3452 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3453 calling user at the default qualifying domain.
3454
3455 .vitem &%-bvs%&
3456 .oindex "&%-bvs%&"
3457 This option acts like &%-bv%&, but verifies the address as a sender rather
3458 than a recipient address. This affects any rewriting and qualification that
3459 might happen.
3460
3461 .vitem &%-bw%&
3462 .oindex "&%-bw%&"
3463 .cindex "daemon"
3464 .cindex "inetd"
3465 .cindex "inetd" "wait mode"
3466 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3467 similarly to the &%-bd%& option.  All port specifications on the command-line
3468 and in the configuration file are ignored.  Queue-running may not be specified.
3469
3470 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3471 listening for connections.  This permits the system to start up and have
3472 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3473 each port only when the first connection is received.
3474
3475 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3476 which the daemon will exit, which should cause inetd to listen once more.
3477
3478 .vitem &%-C%&&~<&'filelist'&>
3479 .oindex "&%-C%&"
3480 .cindex "configuration file" "alternate"
3481 .cindex "CONFIGURE_FILE"
3482 .cindex "alternate configuration file"
3483 This option causes Exim to find the run time configuration file from the given
3484 list instead of from the list specified by the CONFIGURE_FILE
3485 compile-time setting. Usually, the list will consist of just a single file
3486 name, but it can be a colon-separated list of names. In this case, the first
3487 file that exists is used. Failure to open an existing file stops Exim from
3488 proceeding any further along the list, and an error is generated.
3489
3490 When this option is used by a caller other than root, and the list is different
3491 from the compiled-in list, Exim gives up its root privilege immediately, and
3492 runs with the real and effective uid and gid set to those of the caller.
3493 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3494 file contains a list of full pathnames, one per line, for configuration files
3495 which are trusted. Root privilege is retained for any configuration file so
3496 listed, as long as the caller is the Exim user (or the user specified in the
3497 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3498 not writeable by inappropriate users or groups.
3499
3500 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3501 configuration using &%-C%& right through message reception and delivery,
3502 even if the caller is root. The reception works, but by that time, Exim is
3503 running as the Exim user, so when it re-executes to regain privilege for the
3504 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3505 test reception and delivery using two separate commands (one to put a message
3506 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3507
3508 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3509 prefix string with which any file named in a &%-C%& command line option
3510 must start. In addition, the file name must not contain the sequence &`/../`&.
3511 However, if the value of the &%-C%& option is identical to the value of
3512 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3513 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3514 unset, any file name can be used with &%-C%&.
3515
3516 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3517 to a directory to which only root has access. This prevents someone who has
3518 broken into the Exim account from running a privileged Exim with an arbitrary
3519 configuration file.
3520
3521 The &%-C%& facility is useful for ensuring that configuration files are
3522 syntactically correct, but cannot be used for test deliveries, unless the
3523 caller is privileged, or unless it is an exotic configuration that does not
3524 require privilege. No check is made on the owner or group of the files
3525 specified by this option.
3526
3527
3528 .vitem &%-D%&<&'macro'&>=<&'value'&>
3529 .oindex "&%-D%&"
3530 .cindex "macro" "setting on command line"
3531 This option can be used to override macro definitions in the configuration file
3532 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3533 unprivileged caller, it causes Exim to give up its root privilege.
3534 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3535 completely disabled, and its use causes an immediate error exit.
3536
3537 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3538 colon-separated list of macros which are considered safe and, if &%-D%& only
3539 supplies macros from this list, and the values are acceptable, then Exim will
3540 not give up root privilege if the caller is root, the Exim run-time user, or
3541 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3542 to be removed in the future.  Acceptable values for the macros satisfy the
3543 regexp: &`^[A-Za-z0-9_/.-]*$`&
3544
3545 The entire option (including equals sign if present) must all be within one
3546 command line item. &%-D%& can be used to set the value of a macro to the empty
3547 string, in which case the equals sign is optional. These two commands are
3548 synonymous:
3549 .code
3550 exim -DABC  ...
3551 exim -DABC= ...
3552 .endd
3553 To include spaces in a macro definition item, quotes must be used. If you use
3554 quotes, spaces are permitted around the macro name and the equals sign. For
3555 example:
3556 .code
3557 exim '-D ABC = something' ...
3558 .endd
3559 &%-D%& may be repeated up to 10 times on a command line.
3560 .new
3561 Only macro names up to 22 letters long can be set.
3562 .wen
3563
3564
3565 .vitem &%-d%&<&'debug&~options'&>
3566 .oindex "&%-d%&"
3567 .cindex "debugging" "list of selectors"
3568 .cindex "debugging" "&%-d%& option"
3569 This option causes debugging information to be written to the standard
3570 error stream. It is restricted to admin users because debugging output may show
3571 database queries that contain password information. Also, the details of users'
3572 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3573 writes an error message to the standard error stream and exits with a non-zero
3574 return code.
3575
3576 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3577 standard debugging data is output. This can be reduced, or increased to include
3578 some more rarely needed information, by directly following &%-d%& with a string
3579 made up of names preceded by plus or minus characters. These add or remove sets
3580 of debugging data, respectively. For example, &%-d+filter%& adds filter
3581 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3582 no spaces are allowed in the debug setting. The available debugging categories
3583 are:
3584 .display
3585 &`acl            `& ACL interpretation
3586 &`auth           `& authenticators
3587 &`deliver        `& general delivery logic
3588 &`dns            `& DNS lookups (see also resolver)
3589 &`dnsbl          `& DNS black list (aka RBL) code
3590 &`exec           `& arguments for &[execv()]& calls
3591 &`expand         `& detailed debugging for string expansions
3592 &`filter         `& filter handling
3593 &`hints_lookup   `& hints data lookups
3594 &`host_lookup    `& all types of name-to-IP address handling
3595 &`ident          `& ident lookup
3596 &`interface      `& lists of local interfaces
3597 &`lists          `& matching things in lists
3598 &`load           `& system load checks
3599 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3600                     &<<CHAPlocalscan>>&)
3601 &`lookup         `& general lookup code and all lookups
3602 &`memory         `& memory handling
3603 &`pid            `& add pid to debug output lines
3604 &`process_info   `& setting info for the process log
3605 &`queue_run      `& queue runs
3606 &`receive        `& general message reception logic
3607 &`resolver       `& turn on the DNS resolver's debugging output
3608 &`retry          `& retry handling
3609 &`rewrite        `& address rewriting
3610 &`route          `& address routing
3611 &`timestamp      `& add timestamp to debug output lines
3612 &`tls            `& TLS logic
3613 &`transport      `& transports
3614 &`uid            `& changes of uid/gid and looking up uid/gid
3615 &`verify         `& address verification logic
3616 &`all            `& almost all of the above (see below), and also &%-v%&
3617 .endd
3618 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3619 for &`-all`&. The reason for this is that &`+all`& is something that people
3620 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3621 is included, an awful lot of output that is very rarely of interest is
3622 generated, so it now has to be explicitly requested. However, &`-all`& does
3623 turn everything off.
3624
3625 .cindex "resolver, debugging output"
3626 .cindex "DNS resolver, debugging output"
3627 The &`resolver`& option produces output only if the DNS resolver was compiled
3628 with DEBUG enabled. This is not the case in some operating systems. Also,
3629 unfortunately, debugging output from the DNS resolver is written to stdout
3630 rather than stderr.
3631
3632 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3633 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3634 However, the &`pid`& selector is forced when debugging is turned on for a
3635 daemon, which then passes it on to any re-executed Exims. Exim also
3636 automatically adds the pid to debug lines when several remote deliveries are
3637 run in parallel.
3638
3639 The &`timestamp`& selector causes the current time to be inserted at the start
3640 of all debug output lines. This can be useful when trying to track down delays
3641 in processing.
3642
3643 If the &%debug_print%& option is set in any driver, it produces output whenever
3644 any debugging is selected, or if &%-v%& is used.
3645
3646 .vitem &%-dd%&<&'debug&~options'&>
3647 .oindex "&%-dd%&"
3648 This option behaves exactly like &%-d%& except when used on a command that
3649 starts a daemon process. In that case, debugging is turned off for the
3650 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3651 behaviour of the daemon without creating as much output as full debugging does.
3652
3653 .vitem &%-dropcr%&
3654 .oindex "&%-dropcr%&"
3655 This is an obsolete option that is now a no-op. It used to affect the way Exim
3656 handled CR and LF characters in incoming messages. What happens now is
3657 described in section &<<SECTlineendings>>&.
3658
3659 .vitem &%-E%&
3660 .oindex "&%-E%&"
3661 .cindex "bounce message" "generating"
3662 This option specifies that an incoming message is a locally-generated delivery
3663 failure report. It is used internally by Exim when handling delivery failures
3664 and is not intended for external use. Its only effect is to stop Exim
3665 generating certain messages to the postmaster, as otherwise message cascades
3666 could occur in some situations. As part of the same option, a message id may
3667 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3668 new message contains the id, following &"R="&, as a cross-reference.
3669
3670 .vitem &%-e%&&'x'&
3671 .oindex "&%-e%&&'x'&"
3672 There are a number of Sendmail options starting with &%-oe%& which seem to be
3673 called by various programs without the leading &%o%& in the option. For
3674 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3675 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3676
3677 .vitem &%-F%&&~<&'string'&>
3678 .oindex "&%-F%&"
3679 .cindex "sender" "name"
3680 .cindex "name" "of sender"
3681 This option sets the sender's full name for use when a locally-generated
3682 message is being accepted. In the absence of this option, the user's &'gecos'&
3683 entry from the password data is used. As users are generally permitted to alter
3684 their &'gecos'& entries, no security considerations are involved. White space
3685 between &%-F%& and the <&'string'&> is optional.
3686
3687 .vitem &%-f%&&~<&'address'&>
3688 .oindex "&%-f%&"
3689 .cindex "sender" "address"
3690 .cindex "address" "sender"
3691 .cindex "trusted users"
3692 .cindex "envelope sender"
3693 .cindex "user" "trusted"
3694 This option sets the address of the envelope sender of a locally-generated
3695 message (also known as the return path). The option can normally be used only
3696 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3697 users to use it.
3698
3699 Processes running as root or the Exim user are always trusted. Other
3700 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3701 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3702 of a local message is set to the caller's login name at the default qualify
3703 domain.
3704
3705 There is one exception to the restriction on the use of &%-f%&: an empty sender
3706 can be specified by any user, trusted or not, to create a message that can
3707 never provoke a bounce. An empty sender can be specified either as an empty
3708 string, or as a pair of angle brackets with nothing between them, as in these
3709 examples of shell commands:
3710 .code
3711 exim -f '<>' user@domain
3712 exim -f "" user@domain
3713 .endd
3714 In addition, the use of &%-f%& is not restricted when testing a filter file
3715 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3716 &%-bv%& options.
3717
3718 Allowing untrusted users to change the sender address does not of itself make
3719 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3720 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3721 though this can be overridden by setting &%no_local_from_check%&.
3722
3723 White
3724 .cindex "&""From""& line"
3725 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3726 given as two arguments or one combined argument). The sender of a
3727 locally-generated message can also be set (when permitted) by an initial
3728 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3729 if &%-f%& is also present, it overrides &"From&~"&.
3730
3731 .vitem &%-G%&
3732 .oindex "&%-G%&"
3733 .cindex "submission fixups, suppressing (command-line)"
3734 This option is equivalent to an ACL applying:
3735 .code
3736 control = suppress_local_fixups
3737 .endd
3738 for every message received.  Note that Sendmail will complain about such
3739 bad formatting, where Exim silently just does not fix it up.  This may change
3740 in future.
3741
3742 As this affects audit information, the caller must be a trusted user to use
3743 this option.
3744
3745 .vitem &%-h%&&~<&'number'&>
3746 .oindex "&%-h%&"
3747 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3748 This option is accepted for compatibility with Sendmail, but has no effect. (In
3749 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3750 headers.)
3751
3752 .vitem &%-i%&
3753 .oindex "&%-i%&"
3754 .cindex "Solaris" "&'mail'& command"
3755 .cindex "dot" "in incoming non-SMTP message"
3756 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3757 line by itself should not terminate an incoming, non-SMTP message. I can find
3758 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3759 command in Solaris 2.4 uses it. See also &%-ti%&.
3760
3761 .vitem &%-L%&&~<&'tag'&>
3762 .oindex "&%-L%&"
3763 .cindex "syslog" "process name; set with flag"
3764 This option is equivalent to setting &%syslog_processname%& in the config
3765 file and setting &%log_file_path%& to &`syslog`&.
3766 Its use is restricted to administrators.  The configuration file has to be
3767 read and parsed, to determine access rights, before this is set and takes
3768 effect, so early configuration file errors will not honour this flag.
3769
3770 The tag should not be longer than 32 characters.
3771
3772 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3773 .oindex "&%-M%&"
3774 .cindex "forcing delivery"
3775 .cindex "delivery" "forcing attempt"
3776 .cindex "frozen messages" "forcing delivery"
3777 This option requests Exim to run a delivery attempt on each message in turn. If
3778 any of the messages are frozen, they are automatically thawed before the
3779 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3780 and &%hold_domains%& are ignored.
3781
3782 Retry
3783 .cindex "hints database" "overriding retry hints"
3784 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3785 the normal retry time has not yet been reached. This option requires the caller
3786 to be an admin user. However, there is an option called &%prod_requires_admin%&
3787 which can be set false to relax this restriction (and also the same requirement
3788 for the &%-q%&, &%-R%&, and &%-S%& options).
3789
3790 The deliveries happen synchronously, that is, the original Exim process does
3791 not terminate until all the delivery attempts have finished. No output is
3792 produced unless there is a serious error. If you want to see what is happening,
3793 use the &%-v%& option as well, or inspect Exim's main log.
3794
3795 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3796 .oindex "&%-Mar%&"
3797 .cindex "message" "adding recipients"
3798 .cindex "recipient" "adding"
3799 This option requests Exim to add the addresses to the list of recipients of the
3800 message (&"ar"& for &"add recipients"&). The first argument must be a message
3801 id, and the remaining ones must be email addresses. However, if the message is
3802 active (in the middle of a delivery attempt), it is not altered. This option
3803 can be used only by an admin user.
3804
3805 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3806         &~<&'message&~id'&>"
3807 .oindex "&%-MC%&"
3808 .cindex "SMTP" "passed connection"
3809 .cindex "SMTP" "multiple deliveries"
3810 .cindex "multiple SMTP deliveries"
3811 This option is not intended for use by external callers. It is used internally
3812 by Exim to invoke another instance of itself to deliver a waiting message using
3813 an existing SMTP connection, which is passed as the standard input. Details are
3814 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3815 must be root or the Exim user in order to use it.
3816
3817 .vitem &%-MCA%&
3818 .oindex "&%-MCA%&"
3819 This option is not intended for use by external callers. It is used internally
3820 by Exim in conjunction with the &%-MC%& option. It signifies that the
3821 connection to the remote host has been authenticated.
3822
3823 .vitem &%-MCD%&
3824 .oindex "&%-MCD%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option. It signifies that the
3827 remote host supports the ESMTP &_DSN_& extension.
3828
3829 .vitem &%-MCP%&
3830 .oindex "&%-MCP%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3833 which Exim is connected supports pipelining.
3834
3835 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3836 .oindex "&%-MCQ%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option when the original delivery was
3839 started by a queue runner. It passes on the process id of the queue runner,
3840 together with the file descriptor number of an open pipe. Closure of the pipe
3841 signals the final completion of the sequence of processes that are passing
3842 messages through the same SMTP connection.
3843
3844 .vitem &%-MCS%&
3845 .oindex "&%-MCS%&"
3846 This option is not intended for use by external callers. It is used internally
3847 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3848 SMTP SIZE option should be used on messages delivered down the existing
3849 connection.
3850
3851 .vitem &%-MCT%&
3852 .oindex "&%-MCT%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3855 host to which Exim is connected supports TLS encryption.
3856
3857 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3858 .oindex "&%-Mc%&"
3859 .cindex "hints database" "not overridden by &%-Mc%&"
3860 .cindex "delivery" "manually started &-- not forced"
3861 This option requests Exim to run a delivery attempt on each message in turn,
3862 but unlike the &%-M%& option, it does check for retry hints, and respects any
3863 that are found. This option is not very useful to external callers. It is
3864 provided mainly for internal use by Exim when it needs to re-invoke itself in
3865 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3866 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3867 respects retry times and other options such as &%hold_domains%& that are
3868 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3869 If you want to run a specific delivery as if in a queue run, you should use
3870 &%-q%& with a message id argument. A distinction between queue run deliveries
3871 and other deliveries is made in one or two places.
3872
3873 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3874 .oindex "&%-Mes%&"
3875 .cindex "message" "changing sender"
3876 .cindex "sender" "changing"
3877 This option requests Exim to change the sender address in the message to the
3878 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3879 &"edit sender"&). There must be exactly two arguments. The first argument must
3880 be a message id, and the second one an email address. However, if the message
3881 is active (in the middle of a delivery attempt), its status is not altered.
3882 This option can be used only by an admin user.
3883
3884 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3885 .oindex "&%-Mf%&"
3886 .cindex "freezing messages"
3887 .cindex "message" "manually freezing"
3888 This option requests Exim to mark each listed message as &"frozen"&. This
3889 prevents any delivery attempts taking place until the message is &"thawed"&,
3890 either manually or as a result of the &%auto_thaw%& configuration option.
3891 However, if any of the messages are active (in the middle of a delivery
3892 attempt), their status is not altered. This option can be used only by an admin
3893 user.
3894
3895 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3896 .oindex "&%-Mg%&"
3897 .cindex "giving up on messages"
3898 .cindex "message" "abandoning delivery attempts"
3899 .cindex "delivery" "abandoning further attempts"
3900 This option requests Exim to give up trying to deliver the listed messages,
3901 including any that are frozen. However, if any of the messages are active,
3902 their status is not altered. For non-bounce messages, a delivery error message
3903 is sent to the sender, containing the text &"cancelled by administrator"&.
3904 Bounce messages are just discarded. This option can be used only by an admin
3905 user.
3906
3907 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3908 .oindex "&%-Mmad%&"
3909 .cindex "delivery" "cancelling all"
3910 This option requests Exim to mark all the recipient addresses in the messages
3911 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3912 message is active (in the middle of a delivery attempt), its status is not
3913 altered. This option can be used only by an admin user.
3914
3915 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3916 .oindex "&%-Mmd%&"
3917 .cindex "delivery" "cancelling by address"
3918 .cindex "recipient" "removing"
3919 .cindex "removing recipients"
3920 This option requests Exim to mark the given addresses as already delivered
3921 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3922 the remaining ones must be email addresses. These are matched to recipient
3923 addresses in the message in a case-sensitive manner. If the message is active
3924 (in the middle of a delivery attempt), its status is not altered. This option
3925 can be used only by an admin user.
3926
3927 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3928 .oindex "&%-Mrm%&"
3929 .cindex "removing messages"
3930 .cindex "abandoning mail"
3931 .cindex "message" "manually discarding"
3932 This option requests Exim to remove the given messages from the queue. No
3933 bounce messages are sent; each message is simply forgotten. However, if any of
3934 the messages are active, their status is not altered. This option can be used
3935 only by an admin user or by the user who originally caused the message to be
3936 placed on the queue.
3937
3938 .vitem &%-Mset%&&~<&'message&~id'&>
3939 .oindex "&%-Mset%&
3940 .cindex "testing" "string expansion"
3941 .cindex "expansion" "testing"
3942 This option is useful only in conjunction with &%-be%& (that is, when testing
3943 string expansions). Exim loads the given message from its spool before doing
3944 the test expansions, thus setting message-specific variables such as
3945 &$message_size$& and the header variables. The &$recipients$& variable is made
3946 available. This feature is provided to make it easier to test expansions that
3947 make use of these variables. However, this option can be used only by an admin
3948 user. See also &%-bem%&.
3949
3950 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3951 .oindex "&%-Mt%&"
3952 .cindex "thawing messages"
3953 .cindex "unfreezing messages"
3954 .cindex "frozen messages" "thawing"
3955 .cindex "message" "thawing frozen"
3956 This option requests Exim to &"thaw"& any of the listed messages that are
3957 &"frozen"&, so that delivery attempts can resume. However, if any of the
3958 messages are active, their status is not altered. This option can be used only
3959 by an admin user.
3960
3961 .vitem &%-Mvb%&&~<&'message&~id'&>
3962 .oindex "&%-Mvb%&"
3963 .cindex "listing" "message body"
3964 .cindex "message" "listing body of"
3965 This option causes the contents of the message body (-D) spool file to be
3966 written to the standard output. This option can be used only by an admin user.
3967
3968 .vitem &%-Mvc%&&~<&'message&~id'&>
3969 .oindex "&%-Mvc%&"
3970 .cindex "message" "listing in RFC 2822 format"
3971 .cindex "listing" "message in RFC 2822 format"
3972 This option causes a copy of the complete message (header lines plus body) to
3973 be written to the standard output in RFC 2822 format. This option can be used
3974 only by an admin user.
3975
3976 .vitem &%-Mvh%&&~<&'message&~id'&>
3977 .oindex "&%-Mvh%&"
3978 .cindex "listing" "message headers"
3979 .cindex "header lines" "listing"
3980 .cindex "message" "listing header lines"
3981 This option causes the contents of the message headers (-H) spool file to be
3982 written to the standard output. This option can be used only by an admin user.
3983
3984 .vitem &%-Mvl%&&~<&'message&~id'&>
3985 .oindex "&%-Mvl%&"
3986 .cindex "listing" "message log"
3987 .cindex "message" "listing message log"
3988 This option causes the contents of the message log spool file to be written to
3989 the standard output. This option can be used only by an admin user.
3990
3991 .vitem &%-m%&
3992 .oindex "&%-m%&"
3993 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3994 treats it that way too.
3995
3996 .vitem &%-N%&
3997 .oindex "&%-N%&"
3998 .cindex "debugging" "&%-N%& option"
3999 .cindex "debugging" "suppressing delivery"
4000 This is a debugging option that inhibits delivery of a message at the transport
4001 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4002 it just doesn't actually transport the message, but instead behaves as if it
4003 had successfully done so. However, it does not make any updates to the retry
4004 database, and the log entries for deliveries are flagged with &"*>"& rather
4005 than &"=>"&.
4006
4007 Because &%-N%& discards any message to which it applies, only root or the Exim
4008 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4009 words, an ordinary user can use it only when supplying an incoming message to
4010 which it will apply. Although transportation never fails when &%-N%& is set, an
4011 address may be deferred because of a configuration problem on a transport, or a
4012 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4013 the message, and applies to any subsequent delivery attempts that may happen
4014 for that message.
4015
4016 .vitem &%-n%&
4017 .oindex "&%-n%&"
4018 This option is interpreted by Sendmail to mean &"no aliasing"&.
4019 For normal modes of operation, it is ignored by Exim.
4020 When combined with &%-bP%& it suppresses the name of an option from being output.
4021
4022 .vitem &%-O%&&~<&'data'&>
4023 .oindex "&%-O%&"
4024 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4025 Exim.
4026
4027 .vitem &%-oA%&&~<&'file&~name'&>
4028 .oindex "&%-oA%&"
4029 .cindex "Sendmail compatibility" "&%-oA%& option"
4030 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4031 alternative alias file name. Exim handles &%-bi%& differently; see the
4032 description above.
4033
4034 .vitem &%-oB%&&~<&'n'&>
4035 .oindex "&%-oB%&"
4036 .cindex "SMTP" "passed connection"
4037 .cindex "SMTP" "multiple deliveries"
4038 .cindex "multiple SMTP deliveries"
4039 This is a debugging option which limits the maximum number of messages that can
4040 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4041 transport. If <&'n'&> is omitted, the limit is set to 1.
4042
4043 .vitem &%-odb%&
4044 .oindex "&%-odb%&"
4045 .cindex "background delivery"
4046 .cindex "delivery" "in the background"
4047 This option applies to all modes in which Exim accepts incoming messages,
4048 including the listening daemon. It requests &"background"& delivery of such
4049 messages, which means that the accepting process automatically starts a
4050 delivery process for each message received, but does not wait for the delivery
4051 processes to finish.
4052
4053 When all the messages have been received, the reception process exits,
4054 leaving the delivery processes to finish in their own time. The standard output
4055 and error streams are closed at the start of each delivery process.
4056 This is the default action if none of the &%-od%& options are present.
4057
4058 If one of the queueing options in the configuration file
4059 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4060 overrides it if &%queue_only_override%& is set true, which is the default
4061 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4062
4063 .vitem &%-odf%&
4064 .oindex "&%-odf%&"
4065 .cindex "foreground delivery"
4066 .cindex "delivery" "in the foreground"
4067 This option requests &"foreground"& (synchronous) delivery when Exim has
4068 accepted a locally-generated message. (For the daemon it is exactly the same as
4069 &%-odb%&.) A delivery process is automatically started to deliver the message,
4070 and Exim waits for it to complete before proceeding.
4071
4072 The original Exim reception process does not finish until the delivery
4073 process for the final message has ended. The standard error stream is left open
4074 during deliveries.
4075
4076 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4077 false and one of the queueing options in the configuration file is in effect.
4078
4079 If there is a temporary delivery error during foreground delivery, the
4080 message is left on the queue for later delivery, and the original reception
4081 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4082 restricted configuration that never queues messages.
4083
4084
4085 .vitem &%-odi%&
4086 .oindex "&%-odi%&"
4087 This option is synonymous with &%-odf%&. It is provided for compatibility with
4088 Sendmail.
4089
4090 .vitem &%-odq%&
4091 .oindex "&%-odq%&"
4092 .cindex "non-immediate delivery"
4093 .cindex "delivery" "suppressing immediate"
4094 .cindex "queueing incoming messages"
4095 This option applies to all modes in which Exim accepts incoming messages,
4096 including the listening daemon. It specifies that the accepting process should
4097 not automatically start a delivery process for each message received. Messages
4098 are placed on the queue, and remain there until a subsequent queue runner
4099 process encounters them. There are several configuration options (such as
4100 &%queue_only%&) that can be used to queue incoming messages under certain
4101 conditions. This option overrides all of them and also &%-odqs%&. It always
4102 forces queueing.
4103
4104 .vitem &%-odqs%&
4105 .oindex "&%-odqs%&"
4106 .cindex "SMTP" "delaying delivery"
4107 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4108 However, like &%-odb%& and &%-odi%&, this option has no effect if
4109 &%queue_only_override%& is false and one of the queueing options in the
4110 configuration file is in effect.
4111
4112 When &%-odqs%& does operate, a delivery process is started for each incoming
4113 message, in the background by default, but in the foreground if &%-odi%& is
4114 also present. The recipient addresses are routed, and local deliveries are done
4115 in the normal way. However, if any SMTP deliveries are required, they are not
4116 done at this time, so the message remains on the queue until a subsequent queue
4117 runner process encounters it. Because routing was done, Exim knows which
4118 messages are waiting for which hosts, and so a number of messages for the same
4119 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4120 configuration option has the same effect for specific domains. See also the
4121 &%-qq%& option.
4122
4123 .vitem &%-oee%&
4124 .oindex "&%-oee%&"
4125 .cindex "error" "reporting"
4126 If an error is detected while a non-SMTP message is being received (for
4127 example, a malformed address), the error is reported to the sender in a mail
4128 message.
4129
4130 .cindex "return code" "for &%-oee%&"
4131 Provided
4132 this error message is successfully sent, the Exim receiving process
4133 exits with a return code of zero. If not, the return code is 2 if the problem
4134 is that the original message has no recipients, or 1 for any other error.
4135 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4136
4137 .vitem &%-oem%&
4138 .oindex "&%-oem%&"
4139 .cindex "error" "reporting"
4140 .cindex "return code" "for &%-oem%&"
4141 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4142 return code, whether or not the error message was successfully sent.
4143 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4144
4145 .vitem &%-oep%&
4146 .oindex "&%-oep%&"
4147 .cindex "error" "reporting"
4148 If an error is detected while a non-SMTP message is being received, the
4149 error is reported by writing a message to the standard error file (stderr).
4150 .cindex "return code" "for &%-oep%&"
4151 The return code is 1 for all errors.
4152
4153 .vitem &%-oeq%&
4154 .oindex "&%-oeq%&"
4155 .cindex "error" "reporting"
4156 This option is supported for compatibility with Sendmail, but has the same
4157 effect as &%-oep%&.
4158
4159 .vitem &%-oew%&
4160 .oindex "&%-oew%&"
4161 .cindex "error" "reporting"
4162 This option is supported for compatibility with Sendmail, but has the same
4163 effect as &%-oem%&.
4164
4165 .vitem &%-oi%&
4166 .oindex "&%-oi%&"
4167 .cindex "dot" "in incoming non-SMTP message"
4168 This option, which has the same effect as &%-i%&, specifies that a dot on a
4169 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4170 single dot does terminate, though Exim does no special processing for other
4171 lines that start with a dot. This option is set by default if Exim is called as
4172 &'rmail'&. See also &%-ti%&.
4173
4174 .vitem &%-oitrue%&
4175 .oindex "&%-oitrue%&"
4176 This option is treated as synonymous with &%-oi%&.
4177
4178 .vitem &%-oMa%&&~<&'host&~address'&>
4179 .oindex "&%-oMa%&"
4180 .cindex "sender" "host address, specifying for local message"
4181 A number of options starting with &%-oM%& can be used to set values associated
4182 with remote hosts on locally-submitted messages (that is, messages not received
4183 over TCP/IP). These options can be used by any caller in conjunction with the
4184 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4185 other circumstances, they are ignored unless the caller is trusted.
4186
4187 The &%-oMa%& option sets the sender host address. This may include a port
4188 number at the end, after a full stop (period). For example:
4189 .code
4190 exim -bs -oMa 10.9.8.7.1234
4191 .endd
4192 An alternative syntax is to enclose the IP address in square brackets,
4193 followed by a colon and the port number:
4194 .code
4195 exim -bs -oMa [10.9.8.7]:1234
4196 .endd
4197 The IP address is placed in the &$sender_host_address$& variable, and the
4198 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4199 are present on the command line, the sender host IP address is taken from
4200 whichever one is last.
4201
4202 .vitem &%-oMaa%&&~<&'name'&>
4203 .oindex "&%-oMaa%&"
4204 .cindex "authentication" "name, specifying for local message"
4205 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4206 option sets the value of &$sender_host_authenticated$& (the authenticator
4207 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4208 This option can be used with &%-bh%& and &%-bs%& to set up an
4209 authenticated SMTP session without actually using the SMTP AUTH command.
4210
4211 .vitem &%-oMai%&&~<&'string'&>
4212 .oindex "&%-oMai%&"
4213 .cindex "authentication" "id, specifying for local message"
4214 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4215 option sets the value of &$authenticated_id$& (the id that was authenticated).
4216 This overrides the default value (the caller's login id, except with &%-bh%&,
4217 where there is no default) for messages from local sources. See chapter
4218 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4219
4220 .vitem &%-oMas%&&~<&'address'&>
4221 .oindex "&%-oMas%&"
4222 .cindex "authentication" "sender, specifying for local message"
4223 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4224 option sets the authenticated sender value in &$authenticated_sender$&. It
4225 overrides the sender address that is created from the caller's login id for
4226 messages from local sources, except when &%-bh%& is used, when there is no
4227 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4228 specified on a MAIL command overrides this value. See chapter
4229 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4230
4231 .vitem &%-oMi%&&~<&'interface&~address'&>
4232 .oindex "&%-oMi%&"
4233 .cindex "interface" "address, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4235 option sets the IP interface address value. A port number may be included,
4236 using the same syntax as for &%-oMa%&. The interface address is placed in
4237 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4238
4239 .vitem &%-oMm%&&~<&'message&~reference'&>
4240 .oindex "&%-oMm%&"
4241 .cindex "message reference" "message reference, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4243 option sets the message reference, e.g. message-id, and is logged during
4244 delivery. This is useful when some kind of audit trail is required to tie
4245 messages together. The format of the message reference is checked and will
4246 abort if the format is invalid. The option will only be accepted if exim is
4247 running in trusted mode, not as any regular user.
4248
4249 The best example of a message reference is when Exim sends a bounce message.
4250 The message reference is the message-id of the original message for which Exim
4251 is sending the bounce.
4252
4253 .vitem &%-oMr%&&~<&'protocol&~name'&>
4254 .oindex "&%-oMr%&"
4255 .cindex "protocol, specifying for local message"
4256 .vindex "&$received_protocol$&"
4257 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4258 option sets the received protocol value that is stored in
4259 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4260 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4261 SMTP protocol names (see the description of &$received_protocol$& in section
4262 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4263 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4264 be set by &%-oMr%&.
4265
4266 .vitem &%-oMs%&&~<&'host&~name'&>
4267 .oindex "&%-oMs%&"
4268 .cindex "sender" "host name, specifying for local message"
4269 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4270 option sets the sender host name in &$sender_host_name$&. When this option is
4271 present, Exim does not attempt to look up a host name from an IP address; it
4272 uses the name it is given.
4273
4274 .vitem &%-oMt%&&~<&'ident&~string'&>
4275 .oindex "&%-oMt%&"
4276 .cindex "sender" "ident string, specifying for local message"
4277 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4278 option sets the sender ident value in &$sender_ident$&. The default setting for
4279 local callers is the login id of the calling process, except when &%-bh%& is
4280 used, when there is no default.
4281
4282 .vitem &%-om%&
4283 .oindex "&%-om%&"
4284 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4285 In Sendmail, this option means &"me too"&, indicating that the sender of a
4286 message should receive a copy of the message if the sender appears in an alias
4287 expansion. Exim always does this, so the option does nothing.
4288
4289 .vitem &%-oo%&
4290 .oindex "&%-oo%&"
4291 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4292 This option is ignored. In Sendmail it specifies &"old style headers"&,
4293 whatever that means.
4294
4295 .vitem &%-oP%&&~<&'path'&>
4296 .oindex "&%-oP%&"
4297 .cindex "pid (process id)" "of daemon"
4298 .cindex "daemon" "process id (pid)"
4299 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4300 value. The option specifies the file to which the process id of the daemon is
4301 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4302 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4303 because in those cases, the normal pid file is not used.
4304
4305 .vitem &%-or%&&~<&'time'&>
4306 .oindex "&%-or%&"
4307 .cindex "timeout" "for non-SMTP input"
4308 This option sets a timeout value for incoming non-SMTP messages. If it is not
4309 set, Exim will wait forever for the standard input. The value can also be set
4310 by the &%receive_timeout%& option. The format used for specifying times is
4311 described in section &<<SECTtimeformat>>&.
4312
4313 .vitem &%-os%&&~<&'time'&>
4314 .oindex "&%-os%&"
4315 .cindex "timeout" "for SMTP input"
4316 .cindex "SMTP" "input timeout"
4317 This option sets a timeout value for incoming SMTP messages. The timeout
4318 applies to each SMTP command and block of data. The value can also be set by
4319 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4320 for specifying times is described in section &<<SECTtimeformat>>&.
4321
4322 .vitem &%-ov%&
4323 .oindex "&%-ov%&"
4324 This option has exactly the same effect as &%-v%&.
4325
4326 .vitem &%-oX%&&~<&'number&~or&~string'&>
4327 .oindex "&%-oX%&"
4328 .cindex "TCP/IP" "setting listening ports"
4329 .cindex "TCP/IP" "setting listening interfaces"
4330 .cindex "port" "receiving TCP/IP"
4331 This option is relevant only when the &%-bd%& (start listening daemon) option
4332 is also given. It controls which ports and interfaces the daemon uses. Details
4333 of the syntax, and how it interacts with configuration file options, are given
4334 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4335 file is written unless &%-oP%& is also present to specify a pid file name.
4336
4337 .vitem &%-pd%&
4338 .oindex "&%-pd%&"
4339 .cindex "Perl" "starting the interpreter"
4340 This option applies when an embedded Perl interpreter is linked with Exim (see
4341 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4342 option, forcing the starting of the interpreter to be delayed until it is
4343 needed.
4344
4345 .vitem &%-ps%&
4346 .oindex "&%-ps%&"
4347 .cindex "Perl" "starting the interpreter"
4348 This option applies when an embedded Perl interpreter is linked with Exim (see
4349 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4350 option, forcing the starting of the interpreter to occur as soon as Exim is
4351 started.
4352
4353 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4354 .oindex "&%-p%&"
4355 For compatibility with Sendmail, this option is equivalent to
4356 .display
4357 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4358 .endd
4359 It sets the incoming protocol and host name (for trusted callers). The
4360 host name and its colon can be omitted when only the protocol is to be set.
4361 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4362 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4363 or &`s`& using this option (but that does not seem a real limitation).
4364
4365 .vitem &%-q%&
4366 .oindex "&%-q%&"
4367 .cindex "queue runner" "starting manually"
4368 This option is normally restricted to admin users. However, there is a
4369 configuration option called &%prod_requires_admin%& which can be set false to
4370 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4371 and &%-S%& options).
4372
4373 .cindex "queue runner" "description of operation"
4374 The &%-q%& option starts one queue runner process. This scans the queue of
4375 waiting messages, and runs a delivery process for each one in turn. It waits
4376 for each delivery process to finish before starting the next one. A delivery
4377 process may not actually do any deliveries if the retry times for the addresses
4378 have not been reached. Use &%-qf%& (see below) if you want to override this.
4379
4380 If
4381 .cindex "SMTP" "passed connection"
4382 .cindex "SMTP" "multiple deliveries"
4383 .cindex "multiple SMTP deliveries"
4384 the delivery process spawns other processes to deliver other messages down
4385 passed SMTP connections, the queue runner waits for these to finish before
4386 proceeding.
4387
4388 When all the queued messages have been considered, the original queue runner
4389 process terminates. In other words, a single pass is made over the waiting
4390 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4391 this to be repeated periodically.
4392
4393 Exim processes the waiting messages in an unpredictable order. It isn't very
4394 random, but it is likely to be different each time, which is all that matters.
4395 If one particular message screws up a remote MTA, other messages to the same
4396 MTA have a chance of getting through if they get tried first.
4397
4398 It is possible to cause the messages to be processed in lexical message id
4399 order, which is essentially the order in which they arrived, by setting the
4400 &%queue_run_in_order%& option, but this is not recommended for normal use.
4401
4402 .vitem &%-q%&<&'qflags'&>
4403 The &%-q%& option may be followed by one or more flag letters that change its
4404 behaviour. They are all optional, but if more than one is present, they must
4405 appear in the correct order. Each flag is described in a separate item below.
4406
4407 .vitem &%-qq...%&
4408 .oindex "&%-qq%&"
4409 .cindex "queue" "double scanning"
4410 .cindex "queue" "routing"
4411 .cindex "routing" "whole queue before delivery"
4412 An option starting with &%-qq%& requests a two-stage queue run. In the first
4413 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4414 every domain. Addresses are routed, local deliveries happen, but no remote
4415 transports are run.
4416
4417 .cindex "hints database" "remembering routing"
4418 The hints database that remembers which messages are waiting for specific hosts
4419 is updated, as if delivery to those hosts had been deferred. After this is
4420 complete, a second, normal queue scan happens, with routing and delivery taking
4421 place as normal. Messages that are routed to the same host should mostly be
4422 delivered down a single SMTP
4423 .cindex "SMTP" "passed connection"
4424 .cindex "SMTP" "multiple deliveries"
4425 .cindex "multiple SMTP deliveries"
4426 connection because of the hints that were set up during the first queue scan.
4427 This option may be useful for hosts that are connected to the Internet
4428 intermittently.
4429
4430 .vitem &%-q[q]i...%&
4431 .oindex "&%-qi%&"
4432 .cindex "queue" "initial delivery"
4433 If the &'i'& flag is present, the queue runner runs delivery processes only for
4434 those messages that haven't previously been tried. (&'i'& stands for &"initial
4435 delivery"&.) This can be helpful if you are putting messages on the queue using
4436 &%-odq%& and want a queue runner just to process the new messages.
4437
4438 .vitem &%-q[q][i]f...%&
4439 .oindex "&%-qf%&"
4440 .cindex "queue" "forcing delivery"
4441 .cindex "delivery" "forcing in queue run"
4442 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4443 message, whereas without &'f'& only those non-frozen addresses that have passed
4444 their retry times are tried.
4445
4446 .vitem &%-q[q][i]ff...%&
4447 .oindex "&%-qff%&"
4448 .cindex "frozen messages" "forcing delivery"
4449 If &'ff'& is present, a delivery attempt is forced for every message, whether
4450 frozen or not.
4451
4452 .vitem &%-q[q][i][f[f]]l%&
4453 .oindex "&%-ql%&"
4454 .cindex "queue" "local deliveries only"
4455 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4456 be done. If a message requires any remote deliveries, it remains on the queue
4457 for later delivery.
4458
4459 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4460 .cindex "queue" "delivering specific messages"
4461 When scanning the queue, Exim can be made to skip over messages whose ids are
4462 lexically less than a given value by following the &%-q%& option with a
4463 starting message id. For example:
4464 .code
4465 exim -q 0t5C6f-0000c8-00
4466 .endd
4467 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4468 second message id is given, messages whose ids are lexically greater than it
4469 are also skipped. If the same id is given twice, for example,
4470 .code
4471 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4472 .endd
4473 just one delivery process is started, for that message. This differs from
4474 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4475 that it counts as a delivery from a queue run. Note that the selection
4476 mechanism does not affect the order in which the messages are scanned. There
4477 are also other ways of selecting specific sets of messages for delivery in a
4478 queue run &-- see &%-R%& and &%-S%&.
4479
4480 .vitem &%-q%&<&'qflags'&><&'time'&>
4481 .cindex "queue runner" "starting periodically"
4482 .cindex "periodic queue running"
4483 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4484 starting a queue runner process at intervals specified by the given time value
4485 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4486 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4487 single daemon process handles both functions. A common way of starting up a
4488 combined daemon at system boot time is to use a command such as
4489 .code
4490 /usr/exim/bin/exim -bd -q30m
4491 .endd
4492 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4493 process every 30 minutes.
4494
4495 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4496 pid file is written unless one is explicitly requested by the &%-oP%& option.
4497
4498 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-qR%&"
4500 This option is synonymous with &%-R%&. It is provided for Sendmail
4501 compatibility.
4502
4503 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4504 .oindex "&%-qS%&"
4505 This option is synonymous with &%-S%&.
4506
4507 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4508 .oindex "&%-R%&"
4509 .cindex "queue runner" "for specific recipients"
4510 .cindex "delivery" "to given domain"
4511 .cindex "domain" "delivery to"
4512 The <&'rsflags'&> may be empty, in which case the white space before the string
4513 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4514 which are the possible values for <&'rsflags'&>. White space is required if
4515 <&'rsflags'&> is not empty.
4516
4517 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4518 perform a single queue run, except that, when scanning the messages on the
4519 queue, Exim processes only those that have at least one undelivered recipient
4520 address containing the given string, which is checked in a case-independent
4521 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4522 regular expression; otherwise it is a literal string.
4523
4524 If you want to do periodic queue runs for messages with specific recipients,
4525 you can combine &%-R%& with &%-q%& and a time value. For example:
4526 .code
4527 exim -q25m -R @special.domain.example
4528 .endd
4529 This example does a queue run for messages with recipients in the given domain
4530 every 25 minutes. Any additional flags that are specified with &%-q%& are
4531 applied to each queue run.
4532
4533 Once a message is selected for delivery by this mechanism, all its addresses
4534 are processed. For the first selected message, Exim overrides any retry
4535 information and forces a delivery attempt for each undelivered address. This
4536 means that if delivery of any address in the first message is successful, any
4537 existing retry information is deleted, and so delivery attempts for that
4538 address in subsequently selected messages (which are processed without forcing)
4539 will run. However, if delivery of any address does not succeed, the retry
4540 information is updated, and in subsequently selected messages, the failing
4541 address will be skipped.
4542
4543 .cindex "frozen messages" "forcing delivery"
4544 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4545 all selected messages, not just the first; frozen messages are included when
4546 &'ff'& is present.
4547
4548 The &%-R%& option makes it straightforward to initiate delivery of all messages
4549 to a given domain after a host has been down for some time. When the SMTP
4550 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4551 effect is to run Exim with the &%-R%& option, but it can be configured to run
4552 an arbitrary command instead.
4553
4554 .vitem &%-r%&
4555 .oindex "&%-r%&"
4556 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4557
4558 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4559 .oindex "&%-S%&"
4560 .cindex "delivery" "from given sender"
4561 .cindex "queue runner" "for specific senders"
4562 This option acts like &%-R%& except that it checks the string against each
4563 message's sender instead of against the recipients. If &%-R%& is also set, both
4564 conditions must be met for a message to be selected. If either of the options
4565 has &'f'& or &'ff'& in its flags, the associated action is taken.
4566
4567 .vitem &%-Tqt%&&~<&'times'&>
4568 .oindex "&%-Tqt%&"
4569 This is an option that is exclusively for use by the Exim testing suite. It is not
4570 recognized when Exim is run normally. It allows for the setting up of explicit
4571 &"queue times"& so that various warning/retry features can be tested.
4572
4573 .vitem &%-t%&
4574 .oindex "&%-t%&"
4575 .cindex "recipient" "extracting from header lines"
4576 .cindex "&'Bcc:'& header line"
4577 .cindex "&'Cc:'& header line"
4578 .cindex "&'To:'& header line"
4579 When Exim is receiving a locally-generated, non-SMTP message on its standard
4580 input, the &%-t%& option causes the recipients of the message to be obtained
4581 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4582 from the command arguments. The addresses are extracted before any rewriting
4583 takes place and the &'Bcc:'& header line, if present, is then removed.
4584
4585 .cindex "Sendmail compatibility" "&%-t%& option"
4586 If the command has any arguments, they specify addresses to which the message
4587 is &'not'& to be delivered. That is, the argument addresses are removed from
4588 the recipients list obtained from the headers. This is compatible with Smail 3
4589 and in accordance with the documented behaviour of several versions of
4590 Sendmail, as described in man pages on a number of operating systems (e.g.
4591 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4592 argument addresses to those obtained from the headers, and the O'Reilly
4593 Sendmail book documents it that way. Exim can be made to add argument addresses
4594 instead of subtracting them by setting the option
4595 &%extract_addresses_remove_arguments%& false.
4596
4597 .cindex "&%Resent-%& header lines" "with &%-t%&"
4598 If there are any &%Resent-%& header lines in the message, Exim extracts
4599 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4600 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4601 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4602 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4603
4604 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4605 message is resent several times). The RFC also specifies that they should be
4606 added at the front of the message, and separated by &'Received:'& lines. It is
4607 not at all clear how &%-t%& should operate in the present of multiple sets,
4608 nor indeed exactly what constitutes a &"set"&.
4609 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4610 are often added at the end of the header, and if a message is resent more than
4611 once, it is common for the original set of &%Resent-%& headers to be renamed as
4612 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4613
4614 .vitem &%-ti%&
4615 .oindex "&%-ti%&"
4616 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4617 compatibility with Sendmail.
4618
4619 .vitem &%-tls-on-connect%&
4620 .oindex "&%-tls-on-connect%&"
4621 .cindex "TLS" "use without STARTTLS"
4622 .cindex "TLS" "automatic start"
4623 This option is available when Exim is compiled with TLS support. It forces all
4624 incoming SMTP connections to behave as if the incoming port is listed in the
4625 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4626 &<<CHAPTLS>>& for further details.
4627
4628
4629 .vitem &%-U%&
4630 .oindex "&%-U%&"
4631 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4632 Sendmail uses this option for &"initial message submission"&, and its
4633 documentation states that in future releases, it may complain about
4634 syntactically invalid messages rather than fixing them when this flag is not
4635 set. Exim ignores this option.
4636
4637 .vitem &%-v%&
4638 .oindex "&%-v%&"
4639 This option causes Exim to write information to the standard error stream,
4640 describing what it is doing. In particular, it shows the log lines for
4641 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4642 dialogue is shown. Some of the log lines shown may not actually be written to
4643 the log if the setting of &%log_selector%& discards them. Any relevant
4644 selectors are shown with each log line. If none are shown, the logging is
4645 unconditional.
4646
4647 .vitem &%-x%&
4648 .oindex "&%-x%&"
4649 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4650 National Language Support extended characters in the body of the mail item"&).
4651 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4652 this option.
4653
4654 .vitem &%-X%&&~<&'logfile'&>
4655 .oindex "&%-X%&"
4656 This option is interpreted by Sendmail to cause debug information to be sent
4657 to the named file.  It is ignored by Exim.
4658
4659 .vitem &%-z%&&~<&'log-line'&>
4660 .oindex "&%-z%&"
4661 This option writes its argument to Exim's logfile.
4662 Use is restricted to administrators; the intent is for operational notes.
4663 Quotes should be used to maintain a multi-word item as a single argument,
4664 under most shells.
4665 .endlist
4666
4667 .ecindex IIDclo1
4668 .ecindex IIDclo2
4669
4670
4671 . ////////////////////////////////////////////////////////////////////////////
4672 . Insert a stylized DocBook comment here, to identify the end of the command
4673 . line options. This is for the benefit of the Perl script that automatically
4674 . creates a man page for the options.
4675 . ////////////////////////////////////////////////////////////////////////////
4676
4677 .literal xml
4678 <!-- === End of command line options === -->
4679 .literal off
4680
4681
4682
4683
4684
4685 . ////////////////////////////////////////////////////////////////////////////
4686 . ////////////////////////////////////////////////////////////////////////////
4687
4688
4689 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4690          "The runtime configuration file"
4691
4692 .cindex "run time configuration"
4693 .cindex "configuration file" "general description"
4694 .cindex "CONFIGURE_FILE"
4695 .cindex "configuration file" "errors in"
4696 .cindex "error" "in configuration file"
4697 .cindex "return code" "for bad configuration"
4698 Exim uses a single run time configuration file that is read whenever an Exim
4699 binary is executed. Note that in normal operation, this happens frequently,
4700 because Exim is designed to operate in a distributed manner, without central
4701 control.
4702
4703 If a syntax error is detected while reading the configuration file, Exim
4704 writes a message on the standard error, and exits with a non-zero return code.
4705 The message is also written to the panic log. &*Note*&: Only simple syntax
4706 errors can be detected at this time. The values of any expanded options are
4707 not checked until the expansion happens, even when the expansion does not
4708 actually alter the string.
4709
4710 The name of the configuration file is compiled into the binary for security
4711 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4712 most configurations, this specifies a single file. However, it is permitted to
4713 give a colon-separated list of file names, in which case Exim uses the first
4714 existing file in the list.
4715
4716 .cindex "EXIM_USER"
4717 .cindex "EXIM_GROUP"
4718 .cindex "CONFIGURE_OWNER"
4719 .cindex "CONFIGURE_GROUP"
4720 .cindex "configuration file" "ownership"
4721 .cindex "ownership" "configuration file"
4722 The run time configuration file must be owned by root or by the user that is
4723 specified at compile time by the CONFIGURE_OWNER option (if set). The
4724 configuration file must not be world-writeable, or group-writeable unless its
4725 group is the root group or the one specified at compile time by the
4726 CONFIGURE_GROUP option.
4727
4728 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4729 to root, anybody who is able to edit the run time configuration file has an
4730 easy way to run commands as root. If you specify a user or group in the
4731 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4732 who are members of that group will trivially be able to obtain root privileges.
4733
4734 Up to Exim version 4.72, the run time configuration file was also permitted to
4735 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4736 since it offered a simple privilege escalation for any attacker who managed to
4737 compromise the Exim user account.
4738
4739 A default configuration file, which will work correctly in simple situations,
4740 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4741 defines just one file name, the installation process copies the default
4742 configuration to a new file of that name if it did not previously exist. If
4743 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4744 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4745 configuration.
4746
4747
4748
4749 .section "Using a different configuration file" "SECID40"
4750 .cindex "configuration file" "alternate"
4751 A one-off alternate configuration can be specified by the &%-C%& command line
4752 option, which may specify a single file or a list of files. However, when
4753 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4754 unless the argument for &%-C%& is identical to the built-in value from
4755 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4756 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4757 is useful mainly for checking the syntax of configuration files before
4758 installing them. No owner or group checks are done on a configuration file
4759 specified by &%-C%&, if root privilege has been dropped.
4760
4761 Even the Exim user is not trusted to specify an arbitrary configuration file
4762 with the &%-C%& option to be used with root privileges, unless that file is
4763 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4764 testing a configuration using &%-C%& right through message reception and
4765 delivery, even if the caller is root. The reception works, but by that time,
4766 Exim is running as the Exim user, so when it re-execs to regain privilege for
4767 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4768 can test reception and delivery using two separate commands (one to put a
4769 message on the queue, using &%-odq%&, and another to do the delivery, using
4770 &%-M%&).
4771
4772 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4773 prefix string with which any file named in a &%-C%& command line option must
4774 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4775 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4776 name can be used with &%-C%&.
4777
4778 One-off changes to a configuration can be specified by the &%-D%& command line
4779 option, which defines and overrides values for macros used inside the
4780 configuration file. However, like &%-C%&, the use of this option by a
4781 non-privileged user causes Exim to discard its root privilege.
4782 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4783 completely disabled, and its use causes an immediate error exit.
4784
4785 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4786 to declare certain macro names trusted, such that root privilege will not
4787 necessarily be discarded.
4788 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4789 considered safe and, if &%-D%& only supplies macros from this list, and the
4790 values are acceptable, then Exim will not give up root privilege if the caller
4791 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4792 transition mechanism and is expected to be removed in the future.  Acceptable
4793 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4794
4795 Some sites may wish to use the same Exim binary on different machines that
4796 share a file system, but to use different configuration files on each machine.
4797 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4798 looks for a file whose name is the configuration file name followed by a dot
4799 and the machine's node name, as obtained from the &[uname()]& function. If this
4800 file does not exist, the standard name is tried. This processing occurs for
4801 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4802
4803 In some esoteric situations different versions of Exim may be run under
4804 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4805 help with this. See the comments in &_src/EDITME_& for details.
4806
4807
4808
4809 .section "Configuration file format" "SECTconffilfor"
4810 .cindex "configuration file" "format of"
4811 .cindex "format" "configuration file"
4812 Exim's configuration file is divided into a number of different parts. General
4813 option settings must always appear at the start of the file. The other parts
4814 are all optional, and may appear in any order. Each part other than the first
4815 is introduced by the word &"begin"& followed by at least one literal
4816 space, and the name of the part. The optional parts are:
4817
4818 .ilist
4819 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4820 &<<CHAPACL>>&).
4821 .next
4822 .cindex "AUTH" "configuration"
4823 &'authenticators'&: Configuration settings for the authenticator drivers. These
4824 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4825 .next
4826 &'routers'&: Configuration settings for the router drivers. Routers process
4827 addresses and determine how the message is to be delivered (see chapters
4828 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4829 .next
4830 &'transports'&: Configuration settings for the transport drivers. Transports
4831 define mechanisms for copying messages to destinations (see chapters
4832 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4833 .next
4834 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4835 If there is no retry section, or if it is empty (that is, no retry rules are
4836 defined), Exim will not retry deliveries. In this situation, temporary errors
4837 are treated the same as permanent errors. Retry rules are discussed in chapter
4838 &<<CHAPretry>>&.
4839 .next
4840 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4841 when new addresses are generated during delivery. Rewriting is discussed in
4842 chapter &<<CHAPrewrite>>&.
4843 .next
4844 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4845 want to use this feature, you must set
4846 .code
4847 LOCAL_SCAN_HAS_OPTIONS=yes
4848 .endd
4849 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4850 facility are given in chapter &<<CHAPlocalscan>>&.
4851 .endlist
4852
4853 .cindex "configuration file" "leading white space in"
4854 .cindex "configuration file" "trailing white space in"
4855 .cindex "white space" "in configuration file"
4856 Leading and trailing white space in configuration lines is always ignored.
4857
4858 Blank lines in the file, and lines starting with a # character (ignoring
4859 leading white space) are treated as comments and are ignored. &*Note*&: A
4860 # character other than at the beginning of a line is not treated specially,
4861 and does not introduce a comment.
4862
4863 Any non-comment line can be continued by ending it with a backslash. Note that
4864 the general rule for white space means that trailing white space after the
4865 backslash and leading white space at the start of continuation
4866 lines is ignored. Comment lines beginning with # (but not empty lines) may
4867 appear in the middle of a sequence of continuation lines.
4868
4869 A convenient way to create a configuration file is to start from the
4870 default, which is supplied in &_src/configure.default_&, and add, delete, or
4871 change settings as required.
4872
4873 The ACLs, retry rules, and rewriting rules have their own syntax which is
4874 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4875 respectively. The other parts of the configuration file have some syntactic
4876 items in common, and these are described below, from section &<<SECTcos>>&
4877 onwards. Before that, the inclusion, macro, and conditional facilities are
4878 described.
4879
4880
4881
4882 .section "File inclusions in the configuration file" "SECID41"
4883 .cindex "inclusions in configuration file"
4884 .cindex "configuration file" "including other files"
4885 .cindex "&`.include`& in configuration file"
4886 .cindex "&`.include_if_exists`& in configuration file"
4887 You can include other files inside Exim's run time configuration file by
4888 using this syntax:
4889 .display
4890 &`.include`& <&'file name'&>
4891 &`.include_if_exists`& <&'file name'&>
4892 .endd
4893 on a line by itself. Double quotes round the file name are optional. If you use
4894 the first form, a configuration error occurs if the file does not exist; the
4895 second form does nothing for non-existent files. In all cases, an absolute file
4896 name is required.
4897
4898 Includes may be nested to any depth, but remember that Exim reads its
4899 configuration file often, so it is a good idea to keep them to a minimum.
4900 If you change the contents of an included file, you must HUP the daemon,
4901 because an included file is read only when the configuration itself is read.
4902
4903 The processing of inclusions happens early, at a physical line level, so, like
4904 comment lines, an inclusion can be used in the middle of an option setting,
4905 for example:
4906 .code
4907 hosts_lookup = a.b.c \
4908                .include /some/file
4909 .endd
4910 Include processing happens after macro processing (see below). Its effect is to
4911 process the lines of the included file as if they occurred inline where the
4912 inclusion appears.
4913
4914
4915
4916 .section "Macros in the configuration file" "SECTmacrodefs"
4917 .cindex "macro" "description of"
4918 .cindex "configuration file" "macros"
4919 If a line in the main part of the configuration (that is, before the first
4920 &"begin"& line) begins with an upper case letter, it is taken as a macro
4921 definition, and must be of the form
4922 .display
4923 <&'name'&> = <&'rest of line'&>
4924 .endd
4925 The name must consist of letters, digits, and underscores, and need not all be
4926 in upper case, though that is recommended. The rest of the line, including any
4927 continuations, is the replacement text, and has leading and trailing white
4928 space removed. Quotes are not removed. The replacement text can never end with
4929 a backslash character, but this doesn't seem to be a serious limitation.
4930
4931 Macros may also be defined between router, transport, authenticator, or ACL
4932 definitions. They may not, however, be defined within an individual driver or
4933 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4934
4935 .section "Macro substitution" "SECID42"
4936 Once a macro is defined, all subsequent lines in the file (and any included
4937 files) are scanned for the macro name; if there are several macros, the line is
4938 scanned for each in turn, in the order in which the macros are defined. The
4939 replacement text is not re-scanned for the current macro, though it is scanned
4940 for subsequently defined macros. For this reason, a macro name may not contain
4941 the name of a previously defined macro as a substring. You could, for example,
4942 define
4943 .display
4944 &`ABCD_XYZ = `&<&'something'&>
4945 &`ABCD = `&<&'something else'&>
4946 .endd
4947 but putting the definitions in the opposite order would provoke a configuration
4948 error. Macro expansion is applied to individual physical lines from the file,
4949 before checking for line continuation or file inclusion (see above). If a line
4950 consists solely of a macro name, and the expansion of the macro is empty, the
4951 line is ignored. A macro at the start of a line may turn the line into a
4952 comment line or a &`.include`& line.
4953
4954
4955 .section "Redefining macros" "SECID43"
4956 Once defined, the value of a macro can be redefined later in the configuration
4957 (or in an included file). Redefinition is specified by using &'=='& instead of
4958 &'='&. For example:
4959 .code
4960 MAC =  initial value
4961 ...
4962 MAC == updated value
4963 .endd
4964 Redefinition does not alter the order in which the macros are applied to the
4965 subsequent lines of the configuration file. It is still the same order in which
4966 the macros were originally defined. All that changes is the macro's value.
4967 Redefinition makes it possible to accumulate values. For example:
4968 .code
4969 MAC =  initial value
4970 ...
4971 MAC == MAC and something added
4972 .endd
4973 This can be helpful in situations where the configuration file is built
4974 from a number of other files.
4975
4976 .section "Overriding macro values" "SECID44"
4977 The values set for macros in the configuration file can be overridden by the
4978 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4979 used, unless called by root or the Exim user. A definition on the command line
4980 using the &%-D%& option causes all definitions and redefinitions within the
4981 file to be ignored.
4982
4983
4984
4985 .section "Example of macro usage" "SECID45"
4986 As an example of macro usage, consider a configuration where aliases are looked
4987 up in a MySQL database. It helps to keep the file less cluttered if long
4988 strings such as SQL statements are defined separately as macros, for example:
4989 .code
4990 ALIAS_QUERY = select mailbox from user where \
4991               login='${quote_mysql:$local_part}';
4992 .endd
4993 This can then be used in a &(redirect)& router setting like this:
4994 .code
4995 data = ${lookup mysql{ALIAS_QUERY}}
4996 .endd
4997 In earlier versions of Exim macros were sometimes used for domain, host, or
4998 address lists. In Exim 4 these are handled better by named lists &-- see
4999 section &<<SECTnamedlists>>&.
5000
5001
5002 .section "Conditional skips in the configuration file" "SECID46"
5003 .cindex "configuration file" "conditional skips"
5004 .cindex "&`.ifdef`&"
5005 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5006 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5007 portions of the configuration file. The processing happens whenever the file is
5008 read (that is, when an Exim binary starts to run).
5009
5010 The implementation is very simple. Instances of the first four directives must
5011 be followed by text that includes the names of one or macros. The condition
5012 that is tested is whether or not any macro substitution has taken place in the
5013 line. Thus:
5014 .code
5015 .ifdef AAA
5016 message_size_limit = 50M
5017 .else
5018 message_size_limit = 100M
5019 .endif
5020 .endd
5021 sets a message size limit of 50M if the macro &`AAA`& is defined
5022 (or &`A`& or &`AA`&), and 100M
5023 otherwise. If there is more than one macro named on the line, the condition
5024 is true if any of them are defined. That is, it is an &"or"& condition. To
5025 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5026
5027 Although you can use a macro expansion to generate one of these directives,
5028 it is not very useful, because the condition &"there was a macro substitution
5029 in this line"& will always be true.
5030
5031 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5032 to clarify complicated nestings.
5033
5034
5035
5036 .section "Common option syntax" "SECTcos"
5037 .cindex "common option syntax"
5038 .cindex "syntax of common options"
5039 .cindex "configuration file" "common option syntax"
5040 For the main set of options, driver options, and &[local_scan()]& options,
5041 each setting is on a line by itself, and starts with a name consisting of
5042 lower-case letters and underscores. Many options require a data value, and in
5043 these cases the name must be followed by an equals sign (with optional white
5044 space) and then the value. For example:
5045 .code
5046 qualify_domain = mydomain.example.com
5047 .endd
5048 .cindex "hiding configuration option values"
5049 .cindex "configuration options" "hiding value of"
5050 .cindex "options" "hiding value of"
5051 Some option settings may contain sensitive data, for example, passwords for
5052 accessing databases. To stop non-admin users from using the &%-bP%& command
5053 line option to read these values, you can precede the option settings with the
5054 word &"hide"&. For example:
5055 .code
5056 hide mysql_servers = localhost/users/admin/secret-password
5057 .endd
5058 For non-admin users, such options are displayed like this:
5059 .code
5060 mysql_servers = <value not displayable>
5061 .endd
5062 If &"hide"& is used on a driver option, it hides the value of that option on
5063 all instances of the same driver.
5064
5065 The following sections describe the syntax used for the different data types
5066 that are found in option settings.
5067
5068
5069 .section "Boolean options" "SECID47"
5070 .cindex "format" "boolean"
5071 .cindex "boolean configuration values"
5072 .oindex "&%no_%&&'xxx'&"
5073 .oindex "&%not_%&&'xxx'&"
5074 Options whose type is given as boolean are on/off switches. There are two
5075 different ways of specifying such options: with and without a data value. If
5076 the option name is specified on its own without data, the switch is turned on;
5077 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5078 boolean options may be followed by an equals sign and one of the words
5079 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5080 the following two settings have exactly the same effect:
5081 .code
5082 queue_only
5083 queue_only = true
5084 .endd
5085 The following two lines also have the same (opposite) effect:
5086 .code
5087 no_queue_only
5088 queue_only = false
5089 .endd
5090 You can use whichever syntax you prefer.
5091
5092
5093
5094
5095 .section "Integer values" "SECID48"
5096 .cindex "integer configuration values"
5097 .cindex "format" "integer"
5098 If an option's type is given as &"integer"&, the value can be given in decimal,
5099 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5100 number is assumed. Otherwise, it is treated as an octal number unless it starts
5101 with the characters &"0x"&, in which case the remainder is interpreted as a
5102 hexadecimal number.
5103
5104 If an integer value is followed by the letter K, it is multiplied by 1024; if
5105 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5106 of integer option settings are output, values which are an exact multiple of
5107 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5108 and M. The printing style is independent of the actual input format that was
5109 used.
5110
5111
5112 .section "Octal integer values" "SECID49"
5113 .cindex "integer format"
5114 .cindex "format" "octal integer"
5115 If an option's type is given as &"octal integer"&, its value is always
5116 interpreted as an octal number, whether or not it starts with the digit zero.
5117 Such options are always output in octal.
5118
5119
5120 .section "Fixed point numbers" "SECID50"
5121 .cindex "fixed point configuration values"
5122 .cindex "format" "fixed point"
5123 If an option's type is given as &"fixed-point"&, its value must be a decimal
5124 integer, optionally followed by a decimal point and up to three further digits.
5125
5126
5127
5128 .section "Time intervals" "SECTtimeformat"
5129 .cindex "time interval" "specifying in configuration"
5130 .cindex "format" "time interval"
5131 A time interval is specified as a sequence of numbers, each followed by one of
5132 the following letters, with no intervening white space:
5133
5134 .table2 30pt
5135 .irow &%s%& seconds
5136 .irow &%m%& minutes
5137 .irow &%h%& hours
5138 .irow &%d%& days
5139 .irow &%w%& weeks
5140 .endtable
5141
5142 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5143 intervals are output in the same format. Exim does not restrict the values; it
5144 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5145
5146
5147
5148 .section "String values" "SECTstrings"
5149 .cindex "string" "format of configuration values"
5150 .cindex "format" "string"
5151 If an option's type is specified as &"string"&, the value can be specified with
5152 or without double-quotes. If it does not start with a double-quote, the value
5153 consists of the remainder of the line plus any continuation lines, starting at
5154 the first character after any leading white space, with trailing white space
5155 removed, and with no interpretation of the characters in the string. Because
5156 Exim removes comment lines (those beginning with #) at an early stage, they can
5157 appear in the middle of a multi-line string. The following two settings are
5158 therefore equivalent:
5159 .code
5160 trusted_users = uucp:mail
5161 trusted_users = uucp:\
5162                 # This comment line is ignored
5163                 mail
5164 .endd
5165 .cindex "string" "quoted"
5166 .cindex "escape characters in quoted strings"
5167 If a string does start with a double-quote, it must end with a closing
5168 double-quote, and any backslash characters other than those used for line
5169 continuation are interpreted as escape characters, as follows:
5170
5171 .table2 100pt
5172 .irow &`\\`&                     "single backslash"
5173 .irow &`\n`&                     "newline"
5174 .irow &`\r`&                     "carriage return"
5175 .irow &`\t`&                     "tab"
5176 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5177 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5178                                    character"
5179 .endtable
5180
5181 If a backslash is followed by some other character, including a double-quote
5182 character, that character replaces the pair.
5183
5184 Quoting is necessary only if you want to make use of the backslash escapes to
5185 insert special characters, or if you need to specify a value with leading or
5186 trailing spaces. These cases are rare, so quoting is almost never needed in
5187 current versions of Exim. In versions of Exim before 3.14, quoting was required
5188 in order to continue lines, so you may come across older configuration files
5189 and examples that apparently quote unnecessarily.
5190
5191
5192 .section "Expanded strings" "SECID51"
5193 .cindex "expansion" "definition of"
5194 Some strings in the configuration file are subjected to &'string expansion'&,
5195 by which means various parts of the string may be changed according to the
5196 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5197 is as just described; in particular, the handling of backslashes in quoted
5198 strings is done as part of the input process, before expansion takes place.
5199 However, backslash is also an escape character for the expander, so any
5200 backslashes that are required for that reason must be doubled if they are
5201 within a quoted configuration string.
5202
5203
5204 .section "User and group names" "SECID52"
5205 .cindex "user name" "format of"
5206 .cindex "format" "user name"
5207 .cindex "groups" "name format"
5208 .cindex "format" "group name"
5209 User and group names are specified as strings, using the syntax described
5210 above, but the strings are interpreted specially. A user or group name must
5211 either consist entirely of digits, or be a name that can be looked up using the
5212 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5213
5214
5215 .section "List construction" "SECTlistconstruct"
5216 .cindex "list" "syntax of in configuration"
5217 .cindex "format" "list item in configuration"
5218 .cindex "string" "list, definition of"
5219 The data for some configuration options is a list of items, with colon as the
5220 default separator. Many of these options are shown with type &"string list"& in
5221 the descriptions later in this document. Others are listed as &"domain list"&,
5222 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5223 are all the same; however, those other than &"string list"& are subject to
5224 particular kinds of interpretation, as described in chapter
5225 &<<CHAPdomhosaddlists>>&.
5226
5227 In all these cases, the entire list is treated as a single string as far as the
5228 input syntax is concerned. The &%trusted_users%& setting in section
5229 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5230 in a list, it must be entered as two colons. Leading and trailing white space
5231 on each item in a list is ignored. This makes it possible to include items that
5232 start with a colon, and in particular, certain forms of IPv6 address. For
5233 example, the list
5234 .code
5235 local_interfaces = 127.0.0.1 : ::::1
5236 .endd
5237 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5238
5239 &*Note*&: Although leading and trailing white space is ignored in individual
5240 list items, it is not ignored when parsing the list. The space after the first
5241 colon in the example above is necessary. If it were not there, the list would
5242 be interpreted as the two items 127.0.0.1:: and 1.
5243
5244 .section "Changing list separators" "SECTlistsepchange"
5245 .cindex "list separator" "changing"
5246 .cindex "IPv6" "addresses in lists"
5247 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5248 introduced to allow the separator character to be changed. If a list begins
5249 with a left angle bracket, followed by any punctuation character, that
5250 character is used instead of colon as the list separator. For example, the list
5251 above can be rewritten to use a semicolon separator like this:
5252 .code
5253 local_interfaces = <; 127.0.0.1 ; ::1
5254 .endd
5255 This facility applies to all lists, with the exception of the list in
5256 &%log_file_path%&. It is recommended that the use of non-colon separators be
5257 confined to circumstances where they really are needed.
5258
5259 .cindex "list separator" "newline as"
5260 .cindex "newline" "as list separator"
5261 It is also possible to use newline and other control characters (those with
5262 code values less than 32, plus DEL) as separators in lists. Such separators
5263 must be provided literally at the time the list is processed. For options that
5264 are string-expanded, you can write the separator using a normal escape
5265 sequence. This will be processed by the expander before the string is
5266 interpreted as a list. For example, if a newline-separated list of domains is
5267 generated by a lookup, you can process it directly by a line such as this:
5268 .code
5269 domains = <\n ${lookup mysql{.....}}
5270 .endd
5271 This avoids having to change the list separator in such data. You are unlikely
5272 to want to use a control character as a separator in an option that is not
5273 expanded, because the value is literal text. However, it can be done by giving
5274 the value in quotes. For example:
5275 .code
5276 local_interfaces = "<\n 127.0.0.1 \n ::1"
5277 .endd
5278 Unlike printing character separators, which can be included in list items by
5279 doubling, it is not possible to include a control character as data when it is
5280 set as the separator. Two such characters in succession are interpreted as
5281 enclosing an empty list item.
5282
5283
5284
5285 .section "Empty items in lists" "SECTempitelis"
5286 .cindex "list" "empty item in"
5287 An empty item at the end of a list is always ignored. In other words, trailing
5288 separator characters are ignored. Thus, the list in
5289 .code
5290 senders = user@domain :
5291 .endd
5292 contains only a single item. If you want to include an empty string as one item
5293 in a list, it must not be the last item. For example, this list contains three
5294 items, the second of which is empty:
5295 .code
5296 senders = user1@domain : : user2@domain
5297 .endd
5298 &*Note*&: There must be white space between the two colons, as otherwise they
5299 are interpreted as representing a single colon data character (and the list
5300 would then contain just one item). If you want to specify a list that contains
5301 just one, empty item, you can do it as in this example:
5302 .code
5303 senders = :
5304 .endd
5305 In this case, the first item is empty, and the second is discarded because it
5306 is at the end of the list.
5307
5308
5309
5310
5311 .section "Format of driver configurations" "SECTfordricon"
5312 .cindex "drivers" "configuration format"
5313 There are separate parts in the configuration for defining routers, transports,
5314 and authenticators. In each part, you are defining a number of driver
5315 instances, each with its own set of options. Each driver instance is defined by
5316 a sequence of lines like this:
5317 .display
5318 <&'instance name'&>:
5319   <&'option'&>
5320   ...
5321   <&'option'&>
5322 .endd
5323 In the following example, the instance name is &(localuser)&, and it is
5324 followed by three options settings:
5325 .code
5326 localuser:
5327   driver = accept
5328   check_local_user
5329   transport = local_delivery
5330 .endd
5331 For each driver instance, you specify which Exim code module it uses &-- by the
5332 setting of the &%driver%& option &-- and (optionally) some configuration
5333 settings. For example, in the case of transports, if you want a transport to
5334 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5335 a local file you would use the &(appendfile)& driver. Each of the drivers is
5336 described in detail in its own separate chapter later in this manual.
5337
5338 You can have several routers, transports, or authenticators that are based on
5339 the same underlying driver (each must have a different instance name).
5340
5341 The order in which routers are defined is important, because addresses are
5342 passed to individual routers one by one, in order. The order in which
5343 transports are defined does not matter at all. The order in which
5344 authenticators are defined is used only when Exim, as a client, is searching
5345 them to find one that matches an authentication mechanism offered by the
5346 server.
5347
5348 .cindex "generic options"
5349 .cindex "options" "generic &-- definition of"
5350 Within a driver instance definition, there are two kinds of option: &'generic'&
5351 and &'private'&. The generic options are those that apply to all drivers of the
5352 same type (that is, all routers, all transports or all authenticators). The
5353 &%driver%& option is a generic option that must appear in every definition.
5354 .cindex "private options"
5355 The private options are special for each driver, and none need appear, because
5356 they all have default values.
5357
5358 The options may appear in any order, except that the &%driver%& option must
5359 precede any private options, since these depend on the particular driver. For
5360 this reason, it is recommended that &%driver%& always be the first option.
5361
5362 Driver instance names, which are used for reference in log entries and
5363 elsewhere, can be any sequence of letters, digits, and underscores (starting
5364 with a letter) and must be unique among drivers of the same type. A router and
5365 a transport (for example) can each have the same name, but no two router
5366 instances can have the same name. The name of a driver instance should not be
5367 confused with the name of the underlying driver module. For example, the
5368 configuration lines:
5369 .code
5370 remote_smtp:
5371   driver = smtp
5372 .endd
5373 create an instance of the &(smtp)& transport driver whose name is
5374 &(remote_smtp)&. The same driver code can be used more than once, with
5375 different instance names and different option settings each time. A second
5376 instance of the &(smtp)& transport, with different options, might be defined
5377 thus:
5378 .code
5379 special_smtp:
5380   driver = smtp
5381   port = 1234
5382   command_timeout = 10s
5383 .endd
5384 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5385 these transport instances from routers, and these names would appear in log
5386 lines.
5387
5388 Comment lines may be present in the middle of driver specifications. The full
5389 list of option settings for any particular driver instance, including all the
5390 defaulted values, can be extracted by making use of the &%-bP%& command line
5391 option.
5392
5393
5394
5395
5396
5397
5398 . ////////////////////////////////////////////////////////////////////////////
5399 . ////////////////////////////////////////////////////////////////////////////
5400
5401 .chapter "The default configuration file" "CHAPdefconfil"
5402 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5403 .cindex "default" "configuration file &""walk through""&"
5404 The default configuration file supplied with Exim as &_src/configure.default_&
5405 is sufficient for a host with simple mail requirements. As an introduction to
5406 the way Exim is configured, this chapter &"walks through"& the default
5407 configuration, giving brief explanations of the settings. Detailed descriptions
5408 of the options are given in subsequent chapters. The default configuration file
5409 itself contains extensive comments about ways you might want to modify the
5410 initial settings. However, note that there are many options that are not
5411 mentioned at all in the default configuration.
5412
5413
5414
5415 .section "Main configuration settings" "SECTdefconfmain"
5416 The main (global) configuration option settings must always come first in the
5417 file. The first thing you'll see in the file, after some initial comments, is
5418 the line
5419 .code
5420 # primary_hostname =
5421 .endd
5422 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5423 to know the official, fully qualified name of your host, and this is where you
5424 can specify it. However, in most cases you do not need to set this option. When
5425 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5426
5427 The first three non-comment configuration lines are as follows:
5428 .code
5429 domainlist local_domains    = @
5430 domainlist relay_to_domains =
5431 hostlist   relay_from_hosts = 127.0.0.1
5432 .endd
5433 These are not, in fact, option settings. They are definitions of two named
5434 domain lists and one named host list. Exim allows you to give names to lists of
5435 domains, hosts, and email addresses, in order to make it easier to manage the
5436 configuration file (see section &<<SECTnamedlists>>&).
5437
5438 The first line defines a domain list called &'local_domains'&; this is used
5439 later in the configuration to identify domains that are to be delivered
5440 on the local host.
5441
5442 .cindex "@ in a domain list"
5443 There is just one item in this list, the string &"@"&. This is a special form
5444 of entry which means &"the name of the local host"&. Thus, if the local host is
5445 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5446 be delivered locally. Because the local host's name is referenced indirectly,
5447 the same configuration file can be used on different hosts.
5448
5449 The second line defines a domain list called &'relay_to_domains'&, but the
5450 list itself is empty. Later in the configuration we will come to the part that
5451 controls mail relaying through the local host; it allows relaying to any
5452 domains in this list. By default, therefore, no relaying on the basis of a mail
5453 domain is permitted.
5454
5455 The third line defines a host list called &'relay_from_hosts'&. This list is
5456 used later in the configuration to permit relaying from any host or IP address
5457 that matches the list. The default contains just the IP address of the IPv4
5458 loopback interface, which means that processes on the local host are able to
5459 submit mail for relaying by sending it over TCP/IP to that interface. No other
5460 hosts are permitted to submit messages for relaying.
5461
5462 Just to be sure there's no misunderstanding: at this point in the configuration
5463 we aren't actually setting up any controls. We are just defining some domains
5464 and hosts that will be used in the controls that are specified later.
5465
5466 The next two configuration lines are genuine option settings:
5467 .code
5468 acl_smtp_rcpt = acl_check_rcpt
5469 acl_smtp_data = acl_check_data
5470 .endd
5471 These options specify &'Access Control Lists'& (ACLs) that are to be used
5472 during an incoming SMTP session for every recipient of a message (every RCPT
5473 command), and after the contents of the message have been received,
5474 respectively. The names of the lists are &'acl_check_rcpt'& and
5475 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5476 section of the configuration. The RCPT ACL controls which recipients are
5477 accepted for an incoming message &-- if a configuration does not provide an ACL
5478 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5479 contents of a message to be checked.
5480
5481 Two commented-out option settings are next:
5482 .code
5483 # av_scanner = clamd:/tmp/clamd
5484 # spamd_address = 127.0.0.1 783
5485 .endd
5486 These are example settings that can be used when Exim is compiled with the
5487 content-scanning extension. The first specifies the interface to the virus
5488 scanner, and the second specifies the interface to SpamAssassin. Further
5489 details are given in chapter &<<CHAPexiscan>>&.
5490
5491 Three more commented-out option settings follow:
5492 .code
5493 # tls_advertise_hosts = *
5494 # tls_certificate = /etc/ssl/exim.crt
5495 # tls_privatekey = /etc/ssl/exim.pem
5496 .endd
5497 These are example settings that can be used when Exim is compiled with
5498 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5499 first one specifies the list of clients that are allowed to use TLS when
5500 connecting to this server; in this case the wildcard means all clients. The
5501 other options specify where Exim should find its TLS certificate and private
5502 key, which together prove the server's identity to any clients that connect.
5503 More details are given in chapter &<<CHAPTLS>>&.
5504
5505 Another two commented-out option settings follow:
5506 .code
5507 # daemon_smtp_ports = 25 : 465 : 587
5508 # tls_on_connect_ports = 465
5509 .endd
5510 .cindex "port" "465 and 587"
5511 .cindex "port" "for message submission"
5512 .cindex "message" "submission, ports for"
5513 .cindex "ssmtp protocol"
5514 .cindex "smtps protocol"
5515 .cindex "SMTP" "ssmtp protocol"
5516 .cindex "SMTP" "smtps protocol"
5517 These options provide better support for roaming users who wish to use this
5518 server for message submission. They are not much use unless you have turned on
5519 TLS (as described in the previous paragraph) and authentication (about which
5520 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5521 on end-user networks, so RFC 4409 specifies that message submission should use
5522 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5523 configured to use port 587 correctly, so these settings also enable the
5524 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5525 &<<SECTsupobssmt>>&).
5526
5527 Two more commented-out options settings follow:
5528 .code
5529 # qualify_domain =
5530 # qualify_recipient =
5531 .endd
5532 The first of these specifies a domain that Exim uses when it constructs a
5533 complete email address from a local login name. This is often needed when Exim
5534 receives a message from a local process. If you do not set &%qualify_domain%&,
5535 the value of &%primary_hostname%& is used. If you set both of these options,
5536 you can have different qualification domains for sender and recipient
5537 addresses. If you set only the first one, its value is used in both cases.
5538
5539 .cindex "domain literal" "recognizing format"
5540 The following line must be uncommented if you want Exim to recognize
5541 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5542 (an IP address within square brackets) instead of a named domain.
5543 .code
5544 # allow_domain_literals
5545 .endd
5546 The RFCs still require this form, but many people think that in the modern
5547 Internet it makes little sense to permit mail to be sent to specific hosts by
5548 quoting their IP addresses. This ancient format has been used by people who
5549 try to abuse hosts by using them for unwanted relaying. However, some
5550 people believe there are circumstances (for example, messages addressed to
5551 &'postmaster'&) where domain literals are still useful.
5552
5553 The next configuration line is a kind of trigger guard:
5554 .code
5555 never_users = root
5556 .endd
5557 It specifies that no delivery must ever be run as the root user. The normal
5558 convention is to set up &'root'& as an alias for the system administrator. This
5559 setting is a guard against slips in the configuration.
5560 The list of users specified by &%never_users%& is not, however, the complete
5561 list; the build-time configuration in &_Local/Makefile_& has an option called
5562 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5563 contents of &%never_users%& are added to this list. By default
5564 FIXED_NEVER_USERS also specifies root.
5565
5566 When a remote host connects to Exim in order to send mail, the only information
5567 Exim has about the host's identity is its IP address. The next configuration
5568 line,
5569 .code
5570 host_lookup = *
5571 .endd
5572 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5573 in order to get a host name. This improves the quality of the logging
5574 information, but if you feel it is too expensive, you can remove it entirely,
5575 or restrict the lookup to hosts on &"nearby"& networks.
5576 Note that it is not always possible to find a host name from an IP address,
5577 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5578 unreachable.
5579
5580 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5581 1413 (hence their names):
5582 .code
5583 rfc1413_hosts = *
5584 rfc1413_query_timeout = 0s
5585 .endd
5586 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5587 Few hosts offer RFC1413 service these days; calls have to be
5588 terminated by a timeout and this needlessly delays the startup
5589 of an incoming SMTP connection.
5590 If you have hosts for which you trust RFC1413 and need this
5591 information, you can change this.
5592
5593 This line enables an efficiency SMTP option.  It is negotiated by clients
5594 and not expected to cause problems but can be disabled if needed.
5595 .code
5596 prdr_enable = true
5597 .endd
5598
5599 When Exim receives messages over SMTP connections, it expects all addresses to
5600 be fully qualified with a domain, as required by the SMTP definition. However,
5601 if you are running a server to which simple clients submit messages, you may
5602 find that they send unqualified addresses. The two commented-out options:
5603 .code
5604 # sender_unqualified_hosts =
5605 # recipient_unqualified_hosts =
5606 .endd
5607 show how you can specify hosts that are permitted to send unqualified sender
5608 and recipient addresses, respectively.
5609
5610 The &%log_selector%& option is used to increase the detail of logging
5611 over the default:
5612 .code
5613 log_selector = +smtp_protocol_error +smtp_syntax_error \
5614                +tls_certificate_verified
5615 .endd
5616
5617 The &%percent_hack_domains%& option is also commented out:
5618 .code
5619 # percent_hack_domains =
5620 .endd
5621 It provides a list of domains for which the &"percent hack"& is to operate.
5622 This is an almost obsolete form of explicit email routing. If you do not know
5623 anything about it, you can safely ignore this topic.
5624
5625 The next two settings in the main part of the default configuration are
5626 concerned with messages that have been &"frozen"& on Exim's queue. When a
5627 message is frozen, Exim no longer continues to try to deliver it. Freezing
5628 occurs when a bounce message encounters a permanent failure because the sender
5629 address of the original message that caused the bounce is invalid, so the
5630 bounce cannot be delivered. This is probably the most common case, but there
5631 are also other conditions that cause freezing, and frozen messages are not
5632 always bounce messages.
5633 .code
5634 ignore_bounce_errors_after = 2d
5635 timeout_frozen_after = 7d
5636 .endd
5637 The first of these options specifies that failing bounce messages are to be
5638 discarded after 2 days on the queue. The second specifies that any frozen
5639 message (whether a bounce message or not) is to be timed out (and discarded)
5640 after a week. In this configuration, the first setting ensures that no failing
5641 bounce message ever lasts a week.
5642
5643 Exim queues it's messages in a spool directory. If you expect to have
5644 large queues, you may consider using this option. It splits the spool
5645 directory into subdirectories to avoid file system degradation from
5646 many files in a single directory, resulting in better performance.
5647 Manual manipulation of queued messages becomes more complex (though fortunately 
5648 not often needed).
5649 .code
5650 # split_spool_directory = true
5651 .endd
5652
5653 In an ideal world everybody follows the standards. For non-ASCII
5654 messages RFC 2047 is a standard, allowing a maximum line length of 76
5655 characters. Exim adheres that standard and won't process messages which
5656 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5657 In particular, the Exim maintainers have had multiple reports of
5658 problems from Russian administrators of issues until they disable this
5659 check, because of some popular, yet buggy, mail composition software.
5660 .code
5661 # check_rfc2047_length = false
5662 .endd
5663
5664 If you need to be strictly RFC compliant you may wish to disable the
5665 8BITMIME advertisement. Use this, if you exchange mails with systems
5666 that are not 8-bit clean.
5667 .code
5668 # accept_8bitmime = false
5669 .endd
5670
5671 Libraries you use may depend on specific environment settings.  This
5672 imposes a security risk (e.g. PATH). There are two lists:
5673 &%keep_environment%& for the variables to import as they are, and
5674 &%add_environment%& for variables we want to set to a fixed value.
5675 Note that TZ is handled separately, by the $%timezone%$ runtime
5676 option and by the TIMEZONE_DEFAULT buildtime option.
5677 .code
5678 # keep_environment = ^LDAP
5679 # add_environment = PATH=/usr/bin::/bin
5680 .endd
5681
5682
5683 .section "ACL configuration" "SECID54"
5684 .cindex "default" "ACLs"
5685 .cindex "&ACL;" "default configuration"
5686 In the default configuration, the ACL section follows the main configuration.
5687 It starts with the line
5688 .code
5689 begin acl
5690 .endd
5691 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5692 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5693 and &%acl_smtp_data%& above.
5694
5695 .cindex "RCPT" "ACL for"
5696 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5697 RCPT command specifies one of the message's recipients. The ACL statements
5698 are considered in order, until the recipient address is either accepted or
5699 rejected. The RCPT command is then accepted or rejected, according to the
5700 result of the ACL processing.
5701 .code
5702 acl_check_rcpt:
5703 .endd
5704 This line, consisting of a name terminated by a colon, marks the start of the
5705 ACL, and names it.
5706 .code
5707 accept  hosts = :
5708 .endd
5709 This ACL statement accepts the recipient if the sending host matches the list.
5710 But what does that strange list mean? It doesn't actually contain any host
5711 names or IP addresses. The presence of the colon puts an empty item in the
5712 list; Exim matches this only if the incoming message did not come from a remote
5713 host, because in that case, the remote hostname is empty. The colon is
5714 important. Without it, the list itself is empty, and can never match anything.
5715
5716 What this statement is doing is to accept unconditionally all recipients in
5717 messages that are submitted by SMTP from local processes using the standard
5718 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5719 manner.
5720 .code
5721 deny    message       = Restricted characters in address
5722         domains       = +local_domains
5723         local_parts   = ^[.] : ^.*[@%!/|]
5724
5725 deny    message       = Restricted characters in address
5726         domains       = !+local_domains
5727         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5728 .endd
5729 These statements are concerned with local parts that contain any of the
5730 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5731 Although these characters are entirely legal in local parts (in the case of
5732 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5733 in Internet mail addresses.
5734
5735 The first three have in the past been associated with explicitly routed
5736 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5737 option). Addresses containing these characters are regularly tried by spammers
5738 in an attempt to bypass relaying restrictions, and also by open relay testing
5739 programs. Unless you really need them it is safest to reject these characters
5740 at this early stage. This configuration is heavy-handed in rejecting these
5741 characters for all messages it accepts from remote hosts. This is a deliberate
5742 policy of being as safe as possible.
5743
5744 The first rule above is stricter, and is applied to messages that are addressed
5745 to one of the local domains handled by this host. This is implemented by the
5746 first condition, which restricts it to domains that are listed in the
5747 &'local_domains'& domain list. The &"+"& character is used to indicate a
5748 reference to a named list. In this configuration, there is just one domain in
5749 &'local_domains'&, but in general there may be many.
5750
5751 The second condition on the first statement uses two regular expressions to
5752 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5753 or &"|"&. If you have local accounts that include these characters, you will
5754 have to modify this rule.
5755
5756 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5757 allows them because they have been encountered in practice. (Consider the
5758 common convention of local parts constructed as
5759 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5760 the author of Exim, who has no second initial.) However, a local part starting
5761 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5762 file name (for example, for a mailing list). This is also true for local parts
5763 that contain slashes. A pipe symbol can also be troublesome if the local part
5764 is incorporated unthinkingly into a shell command line.
5765
5766 The second rule above applies to all other domains, and is less strict. This
5767 allows your own users to send outgoing messages to sites that use slashes
5768 and vertical bars in their local parts. It blocks local parts that begin
5769 with a dot, slash, or vertical bar, but allows these characters within the
5770 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5771 and &"!"& is blocked, as before. The motivation here is to prevent your users
5772 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5773 .code
5774 accept  local_parts   = postmaster
5775         domains       = +local_domains
5776 .endd
5777 This statement, which has two conditions, accepts an incoming address if the
5778 local part is &'postmaster'& and the domain is one of those listed in the
5779 &'local_domains'& domain list. The &"+"& character is used to indicate a
5780 reference to a named list. In this configuration, there is just one domain in
5781 &'local_domains'&, but in general there may be many.
5782
5783 The presence of this statement means that mail to postmaster is never blocked
5784 by any of the subsequent tests. This can be helpful while sorting out problems
5785 in cases where the subsequent tests are incorrectly denying access.
5786 .code
5787 require verify        = sender
5788 .endd
5789 This statement requires the sender address to be verified before any subsequent
5790 ACL statement can be used. If verification fails, the incoming recipient
5791 address is refused. Verification consists of trying to route the address, to
5792 see if a bounce message could be delivered to it. In the case of remote
5793 addresses, basic verification checks only the domain, but &'callouts'& can be
5794 used for more verification if required. Section &<<SECTaddressverification>>&
5795 discusses the details of address verification.
5796 .code
5797 accept  hosts         = +relay_from_hosts
5798         control       = submission
5799 .endd
5800 This statement accepts the address if the message is coming from one of the
5801 hosts that are defined as being allowed to relay through this host. Recipient
5802 verification is omitted here, because in many cases the clients are dumb MUAs
5803 that do not cope well with SMTP error responses. For the same reason, the
5804 second line specifies &"submission mode"& for messages that are accepted. This
5805 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5806 messages that are deficient in some way, for example, because they lack a
5807 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5808 probably add recipient verification here, and disable submission mode.
5809 .code
5810 accept  authenticated = *
5811         control       = submission
5812 .endd
5813 This statement accepts the address if the client host has authenticated itself.
5814 Submission mode is again specified, on the grounds that such messages are most
5815 likely to come from MUAs. The default configuration does not define any
5816 authenticators, though it does include some nearly complete commented-out
5817 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5818 fact authenticate until you complete the authenticator definitions.
5819 .code
5820 require message = relay not permitted
5821         domains = +local_domains : +relay_to_domains
5822 .endd
5823 This statement rejects the address if its domain is neither a local domain nor
5824 one of the domains for which this host is a relay.
5825 .code
5826 require verify = recipient
5827 .endd
5828 This statement requires the recipient address to be verified; if verification
5829 fails, the address is rejected.
5830 .code
5831 # deny    message     = rejected because $sender_host_address \
5832 #                       is in a black list at $dnslist_domain\n\
5833 #                       $dnslist_text
5834 #         dnslists    = black.list.example
5835 #
5836 # warn    dnslists    = black.list.example
5837 #         add_header  = X-Warning: $sender_host_address is in \
5838 #                       a black list at $dnslist_domain
5839 #         log_message = found in $dnslist_domain
5840 .endd
5841 These commented-out lines are examples of how you could configure Exim to check
5842 sending hosts against a DNS black list. The first statement rejects messages
5843 from blacklisted hosts, whereas the second just inserts a warning header
5844 line.
5845 .code
5846 # require verify = csa
5847 .endd
5848 This commented-out line is an example of how you could turn on client SMTP
5849 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5850 records.
5851 .code
5852 accept
5853 .endd
5854 The final statement in the first ACL unconditionally accepts any recipient
5855 address that has successfully passed all the previous tests.
5856 .code
5857 acl_check_data:
5858 .endd
5859 This line marks the start of the second ACL, and names it. Most of the contents
5860 of this ACL are commented out:
5861 .code
5862 # deny    malware   = *
5863 #         message   = This message contains a virus \
5864 #                     ($malware_name).
5865 .endd
5866 These lines are examples of how to arrange for messages to be scanned for
5867 viruses when Exim has been compiled with the content-scanning extension, and a
5868 suitable virus scanner is installed. If the message is found to contain a
5869 virus, it is rejected with the given custom error message.
5870 .code
5871 # warn    spam      = nobody
5872 #         message   = X-Spam_score: $spam_score\n\
5873 #                     X-Spam_score_int: $spam_score_int\n\
5874 #                     X-Spam_bar: $spam_bar\n\
5875 #                     X-Spam_report: $spam_report
5876 .endd
5877 These lines are an example of how to arrange for messages to be scanned by
5878 SpamAssassin when Exim has been compiled with the content-scanning extension,
5879 and SpamAssassin has been installed. The SpamAssassin check is run with
5880 &`nobody`& as its user parameter, and the results are added to the message as a
5881 series of extra header line. In this case, the message is not rejected,
5882 whatever the spam score.
5883 .code
5884 accept
5885 .endd
5886 This final line in the DATA ACL accepts the message unconditionally.
5887
5888
5889 .section "Router configuration" "SECID55"
5890 .cindex "default" "routers"
5891 .cindex "routers" "default"
5892 The router configuration comes next in the default configuration, introduced
5893 by the line
5894 .code
5895 begin routers
5896 .endd
5897 Routers are the modules in Exim that make decisions about where to send
5898 messages. An address is passed to each router in turn, until it is either
5899 accepted, or failed. This means that the order in which you define the routers
5900 matters. Each router is fully described in its own chapter later in this
5901 manual. Here we give only brief overviews.
5902 .code
5903 # domain_literal:
5904 #   driver = ipliteral
5905 #   domains = !+local_domains
5906 #   transport = remote_smtp
5907 .endd
5908 .cindex "domain literal" "default router"
5909 This router is commented out because the majority of sites do not want to
5910 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5911 you uncomment this router, you also need to uncomment the setting of
5912 &%allow_domain_literals%& in the main part of the configuration.
5913 .code
5914 dnslookup:
5915   driver = dnslookup
5916   domains = ! +local_domains
5917   transport = remote_smtp
5918   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5919   no_more
5920 .endd
5921 The first uncommented router handles addresses that do not involve any local
5922 domains. This is specified by the line
5923 .code
5924 domains = ! +local_domains
5925 .endd
5926 The &%domains%& option lists the domains to which this router applies, but the
5927 exclamation mark is a negation sign, so the router is used only for domains
5928 that are not in the domain list called &'local_domains'& (which was defined at
5929 the start of the configuration). The plus sign before &'local_domains'&
5930 indicates that it is referring to a named list. Addresses in other domains are
5931 passed on to the following routers.
5932
5933 The name of the router driver is &(dnslookup)&,
5934 and is specified by the &%driver%& option. Do not be confused by the fact that
5935 the name of this router instance is the same as the name of the driver. The
5936 instance name is arbitrary, but the name set in the &%driver%& option must be
5937 one of the driver modules that is in the Exim binary.
5938
5939 The &(dnslookup)& router routes addresses by looking up their domains in the
5940 DNS in order to obtain a list of hosts to which the address is routed. If the
5941 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5942 specified by the &%transport%& option. If the router does not find the domain
5943 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5944 the address fails and is bounced.
5945
5946 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5947 be entirely ignored. This option is present because a number of cases have been
5948 encountered where MX records in the DNS point to host names
5949 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5950 Completely ignoring these IP addresses causes Exim to fail to route the
5951 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5952 continue to try to deliver the message periodically until the address timed
5953 out.
5954 .code
5955 system_aliases:
5956   driver = redirect
5957   allow_fail
5958   allow_defer
5959   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5960 # user = exim
5961   file_transport = address_file
5962   pipe_transport = address_pipe
5963 .endd
5964 Control reaches this and subsequent routers only for addresses in the local
5965 domains. This router checks to see whether the local part is defined as an
5966 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5967 data that it looks up from that file. If no data is found for the local part,
5968 the value of the &%data%& option is empty, causing the address to be passed to
5969 the next router.
5970
5971 &_/etc/aliases_& is a conventional name for the system aliases file that is
5972 often used. That is why it is referenced by from the default configuration
5973 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5974 &_Local/Makefile_& before building Exim.
5975 .code
5976 userforward:
5977   driver = redirect
5978   check_local_user
5979 # local_part_suffix = +* : -*
5980 # local_part_suffix_optional
5981   file = $home/.forward
5982 # allow_filter
5983   no_verify
5984   no_expn
5985   check_ancestor
5986   file_transport = address_file
5987   pipe_transport = address_pipe
5988   reply_transport = address_reply
5989 .endd
5990 This is the most complicated router in the default configuration. It is another
5991 redirection router, but this time it is looking for forwarding data set up by
5992 individual users. The &%check_local_user%& setting specifies a check that the
5993 local part of the address is the login name of a local user. If it is not, the
5994 router is skipped. The two commented options that follow &%check_local_user%&,
5995 namely:
5996 .code
5997 # local_part_suffix = +* : -*
5998 # local_part_suffix_optional
5999 .endd
6000 .vindex "&$local_part_suffix$&"
6001 show how you can specify the recognition of local part suffixes. If the first
6002 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6003 by any sequence of characters, is removed from the local part and placed in the
6004 variable &$local_part_suffix$&. The second suffix option specifies that the
6005 presence of a suffix in the local part is optional. When a suffix is present,
6006 the check for a local login uses the local part with the suffix removed.
6007
6008 When a local user account is found, the file called &_.forward_& in the user's
6009 home directory is consulted. If it does not exist, or is empty, the router
6010 declines. Otherwise, the contents of &_.forward_& are interpreted as
6011 redirection data (see chapter &<<CHAPredirect>>& for more details).
6012
6013 .cindex "Sieve filter" "enabling in default router"
6014 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6015 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6016 is commented out by default), the contents of the file are interpreted as a set
6017 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6018 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6019 separate document entitled &'Exim's interfaces to mail filtering'&.
6020
6021 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6022 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6023 There are two reasons for doing this:
6024
6025 .olist
6026 Whether or not a local user has a &_.forward_& file is not really relevant when
6027 checking an address for validity; it makes sense not to waste resources doing
6028 unnecessary work.
6029 .next
6030 More importantly, when Exim is verifying addresses or handling an EXPN
6031 command during an SMTP session, it is running as the Exim user, not as root.
6032 The group is the Exim group, and no additional groups are set up.
6033 It may therefore not be possible for Exim to read users' &_.forward_& files at
6034 this time.
6035 .endlist
6036
6037 The setting of &%check_ancestor%& prevents the router from generating a new
6038 address that is the same as any previous address that was redirected. (This
6039 works round a problem concerning a bad interaction between aliasing and
6040 forwarding &-- see section &<<SECTredlocmai>>&).
6041
6042 The final three option settings specify the transports that are to be used when
6043 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6044 auto-reply, respectively. For example, if a &_.forward_& file contains
6045 .code
6046 a.nother@elsewhere.example, /home/spqr/archive
6047 .endd
6048 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6049 transport.
6050 .code
6051 localuser:
6052   driver = accept
6053   check_local_user
6054 # local_part_suffix = +* : -*
6055 # local_part_suffix_optional
6056   transport = local_delivery
6057 .endd
6058 The final router sets up delivery into local mailboxes, provided that the local
6059 part is the name of a local login, by accepting the address and assigning it to
6060 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6061 routers, so the address is bounced. The commented suffix settings fulfil the
6062 same purpose as they do for the &(userforward)& router.
6063
6064
6065 .section "Transport configuration" "SECID56"
6066 .cindex "default" "transports"
6067 .cindex "transports" "default"
6068 Transports define mechanisms for actually delivering messages. They operate
6069 only when referenced from routers, so the order in which they are defined does
6070 not matter. The transports section of the configuration starts with
6071 .code
6072 begin transports
6073 .endd
6074 One remote transport and four local transports are defined.
6075 .code
6076 remote_smtp:
6077   driver = smtp
6078   hosts_try_prdr = *
6079 .endd
6080 This transport is used for delivering messages over SMTP connections.
6081 The list of remote hosts comes from the router.
6082 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6083 It is negotiated between client and server
6084 and not expected to cause problems but can be disabled if needed.
6085 All other options are defaulted.
6086 .code
6087 local_delivery:
6088   driver = appendfile
6089   file = /var/mail/$local_part
6090   delivery_date_add
6091   envelope_to_add
6092   return_path_add
6093 # group = mail
6094 # mode = 0660
6095 .endd
6096 This &(appendfile)& transport is used for local delivery to user mailboxes in
6097 traditional BSD mailbox format. By default it runs under the uid and gid of the
6098 local user, which requires the sticky bit to be set on the &_/var/mail_&
6099 directory. Some systems use the alternative approach of running mail deliveries
6100 under a particular group instead of using the sticky bit. The commented options
6101 show how this can be done.
6102
6103 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6104 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6105 similarly-named options above.
6106 .code
6107 address_pipe:
6108   driver = pipe
6109   return_output
6110 .endd
6111 This transport is used for handling deliveries to pipes that are generated by
6112 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6113 option specifies that any output on stdout or stderr generated by the pipe is to
6114 be returned to the sender.
6115 .code
6116 address_file:
6117   driver = appendfile
6118   delivery_date_add
6119   envelope_to_add
6120   return_path_add
6121 .endd
6122 This transport is used for handling deliveries to files that are generated by
6123 redirection. The name of the file is not specified in this instance of
6124 &(appendfile)&, because it comes from the &(redirect)& router.
6125 .code
6126 address_reply:
6127   driver = autoreply
6128 .endd
6129 This transport is used for handling automatic replies generated by users'
6130 filter files.
6131
6132
6133
6134 .section "Default retry rule" "SECID57"
6135 .cindex "retry" "default rule"
6136 .cindex "default" "retry rule"
6137 The retry section of the configuration file contains rules which affect the way
6138 Exim retries deliveries that cannot be completed at the first attempt. It is
6139 introduced by the line
6140 .code
6141 begin retry
6142 .endd
6143 In the default configuration, there is just one rule, which applies to all
6144 errors:
6145 .code
6146 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6147 .endd
6148 This causes any temporarily failing address to be retried every 15 minutes for
6149 2 hours, then at intervals starting at one hour and increasing by a factor of
6150 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6151 is not delivered after 4 days of temporary failure, it is bounced.
6152
6153 If the retry section is removed from the configuration, or is empty (that is,
6154 if no retry rules are defined), Exim will not retry deliveries. This turns
6155 temporary errors into permanent errors.
6156
6157
6158 .section "Rewriting configuration" "SECID58"
6159 The rewriting section of the configuration, introduced by
6160 .code
6161 begin rewrite
6162 .endd
6163 contains rules for rewriting addresses in messages as they arrive. There are no
6164 rewriting rules in the default configuration file.
6165
6166
6167
6168 .section "Authenticators configuration" "SECTdefconfauth"
6169 .cindex "AUTH" "configuration"
6170 The authenticators section of the configuration, introduced by
6171 .code
6172 begin authenticators
6173 .endd
6174 defines mechanisms for the use of the SMTP AUTH command. The default
6175 configuration file contains two commented-out example authenticators
6176 which support plaintext username/password authentication using the
6177 standard PLAIN mechanism and the traditional but non-standard LOGIN
6178 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6179 to support most MUA software.
6180
6181 The example PLAIN authenticator looks like this:
6182 .code
6183 #PLAIN:
6184 #  driver                  = plaintext
6185 #  server_set_id           = $auth2
6186 #  server_prompts          = :
6187 #  server_condition        = Authentication is not yet configured
6188 #  server_advertise_condition = ${if def:tls_in_cipher }
6189 .endd
6190 And the example LOGIN authenticator looks like this:
6191 .code
6192 #LOGIN:
6193 #  driver                  = plaintext
6194 #  server_set_id           = $auth1
6195 #  server_prompts          = <| Username: | Password:
6196 #  server_condition        = Authentication is not yet configured
6197 #  server_advertise_condition = ${if def:tls_in_cipher }
6198 .endd
6199
6200 The &%server_set_id%& option makes Exim remember the authenticated username
6201 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6202 &%server_prompts%& option configures the &(plaintext)& authenticator so
6203 that it implements the details of the specific authentication mechanism,
6204 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6205 when Exim offers authentication to clients; in the examples, this is only
6206 when TLS or SSL has been started, so to enable the authenticators you also
6207 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6208
6209 The &%server_condition%& setting defines how to verify that the username and
6210 password are correct. In the examples it just produces an error message.
6211 To make the authenticators work, you can use a string expansion
6212 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6213
6214 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6215 usercode and password are in different positions.
6216 Chapter &<<CHAPplaintext>>& covers both.
6217
6218 .ecindex IIDconfiwal
6219
6220
6221
6222 . ////////////////////////////////////////////////////////////////////////////
6223 . ////////////////////////////////////////////////////////////////////////////
6224
6225 .chapter "Regular expressions" "CHAPregexp"
6226
6227 .cindex "regular expressions" "library"
6228 .cindex "PCRE"
6229 Exim supports the use of regular expressions in many of its options. It
6230 uses the PCRE regular expression library; this provides regular expression
6231 matching that is compatible with Perl 5. The syntax and semantics of
6232 regular expressions is discussed in many Perl reference books, and also in
6233 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6234 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6235
6236 The documentation for the syntax and semantics of the regular expressions that
6237 are supported by PCRE is included in the PCRE distribution, and no further
6238 description is included here. The PCRE functions are called from Exim using
6239 the default option settings (that is, with no PCRE options set), except that
6240 the PCRE_CASELESS option is set when the matching is required to be
6241 case-insensitive.
6242
6243 In most cases, when a regular expression is required in an Exim configuration,
6244 it has to start with a circumflex, in order to distinguish it from plain text
6245 or an &"ends with"& wildcard. In this example of a configuration setting, the
6246 second item in the colon-separated list is a regular expression.
6247 .code
6248 domains = a.b.c : ^\\d{3} : *.y.z : ...
6249 .endd
6250 The doubling of the backslash is required because of string expansion that
6251 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6252 of this issue, and a way of avoiding the need for doubling backslashes. The
6253 regular expression that is eventually used in this example contains just one
6254 backslash. The circumflex is included in the regular expression, and has the
6255 normal effect of &"anchoring"& it to the start of the string that is being
6256 matched.
6257
6258 There are, however, two cases where a circumflex is not required for the
6259 recognition of a regular expression: these are the &%match%& condition in a
6260 string expansion, and the &%matches%& condition in an Exim filter file. In
6261 these cases, the relevant string is always treated as a regular expression; if
6262 it does not start with a circumflex, the expression is not anchored, and can
6263 match anywhere in the subject string.
6264
6265 In all cases, if you want a regular expression to match at the end of a string,
6266 you must code the $ metacharacter to indicate this. For example:
6267 .code
6268 domains = ^\\d{3}\\.example
6269 .endd
6270 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6271 You need to use:
6272 .code
6273 domains = ^\\d{3}\\.example\$
6274 .endd
6275 if you want &'example'& to be the top-level domain. The backslash before the
6276 $ is needed because string expansion also interprets dollar characters.
6277
6278
6279
6280 . ////////////////////////////////////////////////////////////////////////////
6281 . ////////////////////////////////////////////////////////////////////////////
6282
6283 .chapter "File and database lookups" "CHAPfdlookup"
6284 .scindex IIDfidalo1 "file" "lookups"
6285 .scindex IIDfidalo2 "database" "lookups"
6286 .cindex "lookup" "description of"
6287 Exim can be configured to look up data in files or databases as it processes
6288 messages. Two different kinds of syntax are used:
6289
6290 .olist
6291 A string that is to be expanded may contain explicit lookup requests. These
6292 cause parts of the string to be replaced by data that is obtained from the
6293 lookup. Lookups of this type are conditional expansion items. Different results
6294 can be defined for the cases of lookup success and failure. See chapter
6295 &<<CHAPexpand>>&, where string expansions are described in detail.
6296 The key for the lookup is specified as part of the string expansion.
6297 .next
6298 Lists of domains, hosts, and email addresses can contain lookup requests as a
6299 way of avoiding excessively long linear lists. In this case, the data that is
6300 returned by the lookup is often (but not always) discarded; whether the lookup
6301 succeeds or fails is what really counts. These kinds of list are described in
6302 chapter &<<CHAPdomhosaddlists>>&.
6303 The key for the lookup is given by the context in which the list is expanded.
6304 .endlist
6305
6306 String expansions, lists, and lookups interact with each other in such a way
6307 that there is no order in which to describe any one of them that does not
6308 involve references to the others. Each of these three chapters makes more sense
6309 if you have read the other two first. If you are reading this for the first
6310 time, be aware that some of it will make a lot more sense after you have read
6311 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6312
6313 .section "Examples of different lookup syntax" "SECID60"
6314 It is easy to confuse the two different kinds of lookup, especially as the
6315 lists that may contain the second kind are always expanded before being
6316 processed as lists. Therefore, they may also contain lookups of the first kind.
6317 Be careful to distinguish between the following two examples:
6318 .code
6319 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6320 domains = lsearch;/some/file
6321 .endd
6322 The first uses a string expansion, the result of which must be a domain list.
6323 No strings have been specified for a successful or a failing lookup; the
6324 defaults in this case are the looked-up data and an empty string, respectively.
6325 The expansion takes place before the string is processed as a list, and the
6326 file that is searched could contain lines like this:
6327 .code
6328 192.168.3.4: domain1:domain2:...
6329 192.168.1.9: domain3:domain4:...
6330 .endd
6331 When the lookup succeeds, the result of the expansion is a list of domains (and
6332 possibly other types of item that are allowed in domain lists).
6333
6334 In the second example, the lookup is a single item in a domain list. It causes
6335 Exim to use a lookup to see if the domain that is being processed can be found
6336 in the file. The file could contains lines like this:
6337 .code
6338 domain1:
6339 domain2:
6340 .endd
6341 Any data that follows the keys is not relevant when checking that the domain
6342 matches the list item.
6343
6344 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6345 Consider a file containing lines like this:
6346 .code
6347 192.168.5.6: lsearch;/another/file
6348 .endd
6349 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6350 first &%domains%& setting above generates the second setting, which therefore
6351 causes a second lookup to occur.
6352
6353 The rest of this chapter describes the different lookup types that are
6354 available. Any of them can be used in any part of the configuration where a
6355 lookup is permitted.
6356
6357
6358 .section "Lookup types" "SECID61"
6359 .cindex "lookup" "types of"
6360 .cindex "single-key lookup" "definition of"
6361 Two different types of data lookup are implemented:
6362
6363 .ilist
6364 The &'single-key'& type requires the specification of a file in which to look,
6365 and a single key to search for. The key must be a non-empty string for the
6366 lookup to succeed. The lookup type determines how the file is searched.
6367 .next
6368 .cindex "query-style lookup" "definition of"
6369 The &'query-style'& type accepts a generalized database query. No particular
6370 key value is assumed by Exim for query-style lookups. You can use whichever
6371 Exim variables you need to construct the database query.
6372 .endlist
6373
6374 The code for each lookup type is in a separate source file that is included in
6375 the binary of Exim only if the corresponding compile-time option is set. The
6376 default settings in &_src/EDITME_& are:
6377 .code
6378 LOOKUP_DBM=yes
6379 LOOKUP_LSEARCH=yes
6380 .endd
6381 which means that only linear searching and DBM lookups are included by default.
6382 For some types of lookup (e.g. SQL databases), you need to install appropriate
6383 libraries and header files before building Exim.
6384
6385
6386
6387
6388 .section "Single-key lookup types" "SECTsinglekeylookups"
6389 .cindex "lookup" "single-key types"
6390 .cindex "single-key lookup" "list of types"
6391 The following single-key lookup types are implemented:
6392
6393 .ilist
6394 .cindex "cdb" "description of"
6395 .cindex "lookup" "cdb"
6396 .cindex "binary zero" "in lookup key"
6397 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6398 string without a terminating binary zero. The cdb format is designed for
6399 indexed files that are read frequently and never updated, except by total
6400 re-creation. As such, it is particularly suitable for large files containing
6401 aliases or other indexed data referenced by an MTA. Information about cdb can
6402 be found in several places:
6403 .display
6404 &url(http://www.pobox.com/~djb/cdb.html)
6405 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6406 &url(http://packages.debian.org/stable/utils/freecdb.html)
6407 .endd
6408 A cdb distribution is not needed in order to build Exim with cdb support,
6409 because the code for reading cdb files is included directly in Exim itself.
6410 However, no means of building or testing cdb files is provided with Exim, so
6411 you need to obtain a cdb distribution in order to do this.
6412 .next
6413 .cindex "DBM" "lookup type"
6414 .cindex "lookup" "dbm"
6415 .cindex "binary zero" "in lookup key"
6416 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6417 DBM file by looking up the record with the given key. A terminating binary
6418 zero is included in the key that is passed to the DBM library. See section
6419 &<<SECTdb>>& for a discussion of DBM libraries.
6420
6421 .cindex "Berkeley DB library" "file format"
6422 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6423 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6424 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6425 the DB_UNKNOWN option. This enables it to handle any of the types of database
6426 that the library supports, and can be useful for accessing DBM files created by
6427 other applications. (For earlier DB versions, DB_HASH is always used.)
6428 .next
6429 .cindex "lookup" "dbmjz"
6430 .cindex "lookup" "dbm &-- embedded NULs"
6431 .cindex "sasldb2"
6432 .cindex "dbmjz lookup type"
6433 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6434 interpreted as an Exim list; the elements of the list are joined together with
6435 ASCII NUL characters to form the lookup key.  An example usage would be to
6436 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6437 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6438 &(cram_md5)& authenticator.
6439 .next
6440 .cindex "lookup" "dbmnz"
6441 .cindex "lookup" "dbm &-- terminating zero"
6442 .cindex "binary zero" "in lookup key"
6443 .cindex "Courier"
6444 .cindex "&_/etc/userdbshadow.dat_&"
6445 .cindex "dbmnz lookup type"
6446 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6447 is not included in the key that is passed to the DBM library. You may need this
6448 if you want to look up data in files that are created by or shared with some
6449 other application that does not use terminating zeros. For example, you need to
6450 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6451 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6452 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6453 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6454 .next
6455 .cindex "lookup" "dsearch"
6456 .cindex "dsearch lookup type"
6457 &(dsearch)&: The given file must be a directory; this is searched for an entry
6458 whose name is the key by calling the &[lstat()]& function. The key may not
6459 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6460 the lookup is the name of the entry, which may be a file, directory,
6461 symbolic link, or any other kind of directory entry. An example of how this
6462 lookup can be used to support virtual domains is given in section
6463 &<<SECTvirtualdomains>>&.
6464 .next
6465 .cindex "lookup" "iplsearch"
6466 .cindex "iplsearch lookup type"
6467 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6468 terminated by a colon or white space or the end of the line. The keys in the
6469 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6470 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6471 being interpreted as a key terminator. For example:
6472 .code
6473 1.2.3.4:           data for 1.2.3.4
6474 192.168.0.0/16:    data for 192.168.0.0/16
6475 "abcd::cdab":      data for abcd::cdab
6476 "abcd:abcd::/32"   data for abcd:abcd::/32
6477 .endd
6478 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6479 file is searched linearly, using the CIDR masks where present, until a matching
6480 key is found. The first key that matches is used; there is no attempt to find a
6481 &"best"& match. Apart from the way the keys are matched, the processing for
6482 &(iplsearch)& is the same as for &(lsearch)&.
6483
6484 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6485 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6486 lookup types support only literal keys.
6487
6488 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6489 the implicit key is the host's IP address rather than its name (see section
6490 &<<SECThoslispatsikey>>&).
6491 .next
6492 .cindex "linear search"
6493 .cindex "lookup" "lsearch"
6494 .cindex "lsearch lookup type"
6495 .cindex "case sensitivity" "in lsearch lookup"
6496 &(lsearch)&: The given file is a text file that is searched linearly for a
6497 line beginning with the search key, terminated by a colon or white space or the
6498 end of the line. The search is case-insensitive; that is, upper and lower case
6499 letters are treated as the same. The first occurrence of the key that is found
6500 in the file is used.
6501
6502 White space between the key and the colon is permitted. The remainder of the
6503 line, with leading and trailing white space removed, is the data. This can be
6504 continued onto subsequent lines by starting them with any amount of white
6505 space, but only a single space character is included in the data at such a
6506 junction. If the data begins with a colon, the key must be terminated by a
6507 colon, for example:
6508 .code
6509 baduser:  :fail:
6510 .endd
6511 Empty lines and lines beginning with # are ignored, even if they occur in the
6512 middle of an item. This is the traditional textual format of alias files. Note
6513 that the keys in an &(lsearch)& file are literal strings. There is no
6514 wildcarding of any kind.
6515
6516 .cindex "lookup" "lsearch &-- colons in keys"
6517 .cindex "white space" "in lsearch key"
6518 In most &(lsearch)& files, keys are not required to contain colons or #
6519 characters, or white space. However, if you need this feature, it is available.
6520 If a key begins with a doublequote character, it is terminated only by a
6521 matching quote (or end of line), and the normal escaping rules apply to its
6522 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6523 quoted keys (exactly as for unquoted keys). There is no special handling of
6524 quotes for the data part of an &(lsearch)& line.
6525
6526 .next
6527 .cindex "NIS lookup type"
6528 .cindex "lookup" "NIS"
6529 .cindex "binary zero" "in lookup key"
6530 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6531 the given key, without a terminating binary zero. There is a variant called
6532 &(nis0)& which does include the terminating binary zero in the key. This is
6533 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6534 aliases; the full map names must be used.
6535
6536 .next
6537 .cindex "wildlsearch lookup type"
6538 .cindex "lookup" "wildlsearch"
6539 .cindex "nwildlsearch lookup type"
6540 .cindex "lookup" "nwildlsearch"
6541 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6542 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6543 the file may be wildcarded. The difference between these two lookup types is
6544 that for &(wildlsearch)&, each key in the file is string-expanded before being
6545 used, whereas for &(nwildlsearch)&, no expansion takes place.
6546
6547 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6548 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6549 file that are regular expressions can be made case-sensitive by the use of
6550 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6551
6552 . ==== As this is a nested list, any displays it contains must be indented
6553 . ==== as otherwise they are too far to the left.
6554
6555 .olist
6556 The string may begin with an asterisk to mean &"ends with"&. For example:
6557 .code
6558     *.a.b.c       data for anything.a.b.c
6559     *fish         data for anythingfish
6560 .endd
6561 .next
6562 The string may begin with a circumflex to indicate a regular expression. For
6563 example, for &(wildlsearch)&:
6564 .code
6565     ^\N\d+\.a\.b\N    data for <digits>.a.b
6566 .endd
6567 Note the use of &`\N`& to disable expansion of the contents of the regular
6568 expression. If you are using &(nwildlsearch)&, where the keys are not
6569 string-expanded, the equivalent entry is:
6570 .code
6571     ^\d+\.a\.b        data for <digits>.a.b
6572 .endd
6573 The case-insensitive flag is set at the start of compiling the regular
6574 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6575 For example, to make the entire pattern case-sensitive:
6576 .code
6577     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6578 .endd
6579
6580 If the regular expression contains white space or colon characters, you must
6581 either quote it (see &(lsearch)& above), or represent these characters in other
6582 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6583 colon. This may be easier than quoting, because if you quote, you have to
6584 escape all the backslashes inside the quotes.
6585
6586 &*Note*&: It is not possible to capture substrings in a regular expression
6587 match for later use, because the results of all lookups are cached. If a lookup
6588 is repeated, the result is taken from the cache, and no actual pattern matching
6589 takes place. The values of all the numeric variables are unset after a
6590 &((n)wildlsearch)& match.
6591
6592 .next
6593 Although I cannot see it being of much use, the general matching function that
6594 is used to implement &((n)wildlsearch)& means that the string may begin with a
6595 lookup name terminated by a semicolon, and followed by lookup data. For
6596 example:
6597 .code
6598     cdb;/some/file  data for keys that match the file
6599 .endd
6600 The data that is obtained from the nested lookup is discarded.
6601 .endlist olist
6602
6603 Keys that do not match any of these patterns are interpreted literally. The
6604 continuation rules for the data are the same as for &(lsearch)&, and keys may
6605 be followed by optional colons.
6606
6607 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6608 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6609 lookup types support only literal keys.
6610 .endlist ilist
6611
6612
6613 .section "Query-style lookup types" "SECID62"
6614 .cindex "lookup" "query-style types"
6615 .cindex "query-style lookup" "list of types"
6616 The supported query-style lookup types are listed below. Further details about
6617 many of them are given in later sections.
6618
6619 .ilist
6620 .cindex "DNS" "as a lookup type"
6621 .cindex "lookup" "DNS"
6622 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6623 are given in the supplied query. The resulting data is the contents of the
6624 records. See section &<<SECTdnsdb>>&.
6625 .next
6626 .cindex "InterBase lookup type"
6627 .cindex "lookup" "InterBase"
6628 &(ibase)&: This does a lookup in an InterBase database.
6629 .next
6630 .cindex "LDAP" "lookup type"
6631 .cindex "lookup" "LDAP"
6632 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6633 returns attributes from a single entry. There is a variant called &(ldapm)&
6634 that permits values from multiple entries to be returned. A third variant
6635 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6636 any attribute values. See section &<<SECTldap>>&.
6637 .next
6638 .cindex "MySQL" "lookup type"
6639 .cindex "lookup" "MySQL"
6640 &(mysql)&: The format of the query is an SQL statement that is passed to a
6641 MySQL database. See section &<<SECTsql>>&.
6642 .next
6643 .cindex "NIS+ lookup type"
6644 .cindex "lookup" "NIS+"
6645 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6646 the field to be returned. See section &<<SECTnisplus>>&.
6647 .next
6648 .cindex "Oracle" "lookup type"
6649 .cindex "lookup" "Oracle"
6650 &(oracle)&: The format of the query is an SQL statement that is passed to an
6651 Oracle database. See section &<<SECTsql>>&.
6652 .next
6653 .cindex "lookup" "passwd"
6654 .cindex "passwd lookup type"
6655 .cindex "&_/etc/passwd_&"
6656 &(passwd)& is a query-style lookup with queries that are just user names. The
6657 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6658 success, the result string is the same as you would get from an &(lsearch)&
6659 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6660 password value. For example:
6661 .code
6662 *:42:42:King Rat:/home/kr:/bin/bash
6663 .endd
6664 .next
6665 .cindex "PostgreSQL lookup type"
6666 .cindex "lookup" "PostgreSQL"
6667 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6668 PostgreSQL database. See section &<<SECTsql>>&.
6669
6670 .next
6671 .new
6672 .cindex "Redis lookup type"
6673 .cindex lookup Redis
6674 &(redis)&: The format of the query is an SQL statement that is passed to a
6675 Redis database. See section &<<SECTsql>>&.
6676 .wen
6677
6678 .next
6679 .cindex "sqlite lookup type"
6680 .cindex "lookup" "sqlite"
6681 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6682 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6683
6684 .next
6685 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6686 not likely to be useful in normal operation.
6687 .next
6688 .cindex "whoson lookup type"
6689 .cindex "lookup" "whoson"
6690 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6691 allows a server to check whether a particular (dynamically allocated) IP
6692 address is currently allocated to a known (trusted) user and, optionally, to
6693 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6694 at one time for &"POP before SMTP"& authentication, but that approach has been
6695 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6696 &"POP before SMTP"& checking using ACL statements such as
6697 .code
6698 require condition = \
6699   ${lookup whoson {$sender_host_address}{yes}{no}}
6700 .endd
6701 The query consists of a single IP address. The value returned is the name of
6702 the authenticated user, which is stored in the variable &$value$&. However, in
6703 this example, the data in &$value$& is not used; the result of the lookup is
6704 one of the fixed strings &"yes"& or &"no"&.
6705 .endlist
6706
6707
6708
6709 .section "Temporary errors in lookups" "SECID63"
6710 .cindex "lookup" "temporary error in"
6711 Lookup functions can return temporary error codes if the lookup cannot be
6712 completed. For example, an SQL or LDAP database might be unavailable. For this
6713 reason, it is not advisable to use a lookup that might do this for critical
6714 options such as a list of local domains.
6715
6716 When a lookup cannot be completed in a router or transport, delivery
6717 of the message (to the relevant address) is deferred, as for any other
6718 temporary error. In other circumstances Exim may assume the lookup has failed,
6719 or may give up altogether.
6720
6721
6722
6723 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6724 .cindex "wildcard lookups"
6725 .cindex "lookup" "default values"
6726 .cindex "lookup" "wildcard"
6727 .cindex "lookup" "* added to type"
6728 .cindex "default" "in single-key lookups"
6729 In this context, a &"default value"& is a value specified by the administrator
6730 that is to be used if a lookup fails.
6731
6732 &*Note:*& This section applies only to single-key lookups. For query-style
6733 lookups, the facilities of the query language must be used. An attempt to
6734 specify a default for a query-style lookup provokes an error.
6735
6736 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6737 and the initial lookup fails, the key &"*"& is looked up in the file to
6738 provide a default value. See also the section on partial matching below.
6739
6740 .cindex "*@ with single-key lookup"
6741 .cindex "lookup" "*@ added to type"
6742 .cindex "alias file" "per-domain default"
6743 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6744 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6745 character, a second lookup is done with everything before the last @ replaced
6746 by *. This makes it possible to provide per-domain defaults in alias files
6747 that include the domains in the keys. If the second lookup fails (or doesn't
6748 take place because there is no @ in the key), &"*"& is looked up.
6749 For example, a &(redirect)& router might contain:
6750 .code
6751 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6752 .endd
6753 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6754 looks up these keys, in this order:
6755 .code
6756 jane@eyre.example
6757 *@eyre.example
6758 *
6759 .endd
6760 The data is taken from whichever key it finds first. &*Note*&: In an
6761 &(lsearch)& file, this does not mean the first of these keys in the file. A
6762 complete scan is done for each key, and only if it is not found at all does
6763 Exim move on to try the next key.
6764
6765
6766
6767 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6768 .cindex "partial matching"
6769 .cindex "wildcard lookups"
6770 .cindex "lookup" "partial matching"
6771 .cindex "lookup" "wildcard"
6772 .cindex "asterisk" "in search type"
6773 The normal operation of a single-key lookup is to search the file for an exact
6774 match with the given key. However, in a number of situations where domains are
6775 being looked up, it is useful to be able to do partial matching. In this case,
6776 information in the file that has a key starting with &"*."& is matched by any
6777 domain that ends with the components that follow the full stop. For example, if
6778 a key in a DBM file is
6779 .code
6780 *.dates.fict.example
6781 .endd
6782 then when partial matching is enabled this is matched by (amongst others)
6783 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6784 by &'dates.fict.example'&, if that does not appear as a separate key in the
6785 file.
6786
6787 &*Note*&: Partial matching is not available for query-style lookups. It is
6788 also not available for any lookup items in address lists (see section
6789 &<<SECTaddresslist>>&).
6790
6791 Partial matching is implemented by doing a series of separate lookups using
6792 keys constructed by modifying the original subject key. This means that it can
6793 be used with any of the single-key lookup types, provided that
6794 partial matching keys
6795 beginning with a special prefix (default &"*."&) are included in the data file.
6796 Keys in the file that do not begin with the prefix are matched only by
6797 unmodified subject keys when partial matching is in use.
6798
6799 Partial matching is requested by adding the string &"partial-"& to the front of
6800 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6801 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6802 is added at the start of the subject key, and it is looked up again. If that
6803 fails, further lookups are tried with dot-separated components removed from the
6804 start of the subject key, one-by-one, and &"*."& added on the front of what
6805 remains.
6806
6807 A minimum number of two non-* components are required. This can be adjusted
6808 by including a number before the hyphen in the search type. For example,
6809 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6810 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6811 subject key is &'2250.dates.fict.example'& then the following keys are looked
6812 up when the minimum number of non-* components is two:
6813 .code
6814 2250.dates.fict.example
6815 *.2250.dates.fict.example
6816 *.dates.fict.example
6817 *.fict.example
6818 .endd
6819 As soon as one key in the sequence is successfully looked up, the lookup
6820 finishes.
6821
6822 .cindex "lookup" "partial matching &-- changing prefix"
6823 .cindex "prefix" "for partial matching"
6824 The use of &"*."& as the partial matching prefix is a default that can be
6825 changed. The motivation for this feature is to allow Exim to operate with file
6826 formats that are used by other MTAs. A different prefix can be supplied in
6827 parentheses instead of the hyphen after &"partial"&. For example:
6828 .code
6829 domains = partial(.)lsearch;/some/file
6830 .endd
6831 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6832 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6833 components is unchanged). The prefix may consist of any punctuation characters
6834 other than a closing parenthesis. It may be empty, for example:
6835 .code
6836 domains = partial1()cdb;/some/file
6837 .endd
6838 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6839 &`a.b.c`&, &`b.c`&, and &`c`&.
6840
6841 If &"partial0"& is specified, what happens at the end (when the lookup with
6842 just one non-wild component has failed, and the original key is shortened right
6843 down to the null string) depends on the prefix:
6844
6845 .ilist
6846 If the prefix has zero length, the whole lookup fails.
6847 .next
6848 If the prefix has length 1, a lookup for just the prefix is done. For
6849 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6850 .next
6851 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6852 remainder is looked up. With the default prefix, therefore, the final lookup is
6853 for &"*"& on its own.
6854 .next
6855 Otherwise, the whole prefix is looked up.
6856 .endlist
6857
6858
6859 If the search type ends in &"*"& or &"*@"& (see section
6860 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6861 this implies happens after all partial lookups have failed. If &"partial0"& is
6862 specified, adding &"*"& to the search type has no effect with the default
6863 prefix, because the &"*"& key is already included in the sequence of partial
6864 lookups. However, there might be a use for lookup types such as
6865 &"partial0(.)lsearch*"&.
6866
6867 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6868 in domain lists and the like. Partial matching works only in terms of
6869 dot-separated components; a key such as &`*fict.example`&
6870 in a database file is useless, because the asterisk in a partial matching
6871 subject key is always followed by a dot.
6872
6873
6874
6875
6876 .section "Lookup caching" "SECID64"
6877 .cindex "lookup" "caching"
6878 .cindex "caching" "lookup data"
6879 Exim caches all lookup results in order to avoid needless repetition of
6880 lookups. However, because (apart from the daemon) Exim operates as a collection
6881 of independent, short-lived processes, this caching applies only within a
6882 single Exim process. There is no inter-process lookup caching facility.
6883
6884 For single-key lookups, Exim keeps the relevant files open in case there is
6885 another lookup that needs them. In some types of configuration this can lead to
6886 many files being kept open for messages with many recipients. To avoid hitting
6887 the operating system limit on the number of simultaneously open files, Exim
6888 closes the least recently used file when it needs to open more files than its
6889 own internal limit, which can be changed via the &%lookup_open_max%& option.
6890
6891 The single-key lookup files are closed and the lookup caches are flushed at
6892 strategic points during delivery &-- for example, after all routing is
6893 complete.
6894
6895
6896
6897
6898 .section "Quoting lookup data" "SECID65"
6899 .cindex "lookup" "quoting"
6900 .cindex "quoting" "in lookups"
6901 When data from an incoming message is included in a query-style lookup, there
6902 is the possibility of special characters in the data messing up the syntax of
6903 the query. For example, a NIS+ query that contains
6904 .code
6905 [name=$local_part]
6906 .endd
6907 will be broken if the local part happens to contain a closing square bracket.
6908 For NIS+, data can be enclosed in double quotes like this:
6909 .code
6910 [name="$local_part"]
6911 .endd
6912 but this still leaves the problem of a double quote in the data. The rule for
6913 NIS+ is that double quotes must be doubled. Other lookup types have different
6914 rules, and to cope with the differing requirements, an expansion operator
6915 of the following form is provided:
6916 .code
6917 ${quote_<lookup-type>:<string>}
6918 .endd
6919 For example, the safest way to write the NIS+ query is
6920 .code
6921 [name="${quote_nisplus:$local_part}"]
6922 .endd
6923 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6924 operator can be used for all lookup types, but has no effect for single-key
6925 lookups, since no quoting is ever needed in their key strings.
6926
6927
6928
6929
6930 .section "More about dnsdb" "SECTdnsdb"
6931 .cindex "dnsdb lookup"
6932 .cindex "lookup" "dnsdb"
6933 .cindex "DNS" "as a lookup type"
6934 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6935 of a record type and a domain name, separated by an equals sign. For example,
6936 an expansion string could contain:
6937 .code
6938 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6939 .endd
6940 If the lookup succeeds, the result is placed in &$value$&, which in this case
6941 is used on its own as the result. If the lookup does not succeed, the
6942 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6943 &<<SECTforexpfai>>& for an explanation of what this means.
6944
6945 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6946 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6947 If no type is given, TXT is assumed.
6948
6949 For any record type, if multiple records are found, the data is returned as a
6950 concatenation, with newline as the default separator. The order, of course,
6951 depends on the DNS resolver. You can specify a different separator character
6952 between multiple records by putting a right angle-bracket followed immediately
6953 by the new separator at the start of the query. For example:
6954 .code
6955 ${lookup dnsdb{>: a=host1.example}}
6956 .endd
6957 It is permitted to specify a space as the separator character. Further
6958 white space is ignored.
6959 For lookup types that return multiple fields per record,
6960 an alternate field separator can be specified using a comma after the main
6961 separator character, followed immediately by the field separator.
6962
6963 .cindex "PTR record" "in &(dnsdb)& lookup"
6964 When the type is PTR,
6965 the data can be an IP address, written as normal; inversion and the addition of
6966 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6967 .code
6968 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6969 .endd
6970 If the data for a PTR record is not a syntactically valid IP address, it is not
6971 altered and nothing is added.
6972
6973 .cindex "MX record" "in &(dnsdb)& lookup"
6974 .cindex "SRV record" "in &(dnsdb)& lookup"
6975 For an MX lookup, both the preference value and the host name are returned for
6976 each record, separated by a space. For an SRV lookup, the priority, weight,
6977 port, and host name are returned for each record, separated by spaces.
6978 The field separator can be modified as above.
6979
6980 .cindex "TXT record" "in &(dnsdb)& lookup"
6981 .cindex "SPF record" "in &(dnsdb)& lookup"
6982 For TXT records with multiple items of data, only the first item is returned,
6983 unless a field separator is specified.
6984 To concatenate items without a separator, use a semicolon instead.
6985 For SPF records the
6986 default behaviour is to concatenate multiple items without using a separator.
6987 .code
6988 ${lookup dnsdb{>\n,: txt=a.b.example}}
6989 ${lookup dnsdb{>\n; txt=a.b.example}}
6990 ${lookup dnsdb{spf=example.org}}
6991 .endd
6992 It is permitted to specify a space as the separator character. Further
6993 white space is ignored.
6994
6995 .cindex "SOA record" "in &(dnsdb)& lookup"
6996 For an SOA lookup, while no result is obtained the lookup is redone with
6997 successively more leading components dropped from the given domain.
6998 Only the primary-nameserver field is returned unless a field separator is
6999 specified.
7000 .code
7001 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7002 .endd
7003
7004 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7005 .cindex "dnsdb modifiers"
7006 .cindex "modifiers" "dnsdb"
7007 .cindex "options" "dnsdb"
7008 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7009 each followed by a comma,
7010 that may appear before the record type.
7011
7012 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7013 temporary DNS error for any of them, the behaviour is controlled by
7014 a defer-option modifier.
7015 The possible keywords are
7016 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7017 With &"strict"& behaviour, any temporary DNS error causes the
7018 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7019 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7020 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7021 error causes the whole lookup to defer only if none of the other lookups
7022 succeed. The default is &"lax"&, so the following lookups are equivalent:
7023 .code
7024 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7025 ${lookup dnsdb{a=one.host.com:two.host.com}}
7026 .endd
7027 Thus, in the default case, as long as at least one of the DNS lookups
7028 yields some data, the lookup succeeds.
7029
7030 .cindex "DNSSEC" "dns lookup"
7031 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7032 The possible keywords are
7033 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7034 With &"strict"& or &"lax"& DNSSEC information is requested
7035 with the lookup.
7036 With &"strict"& a response from the DNS resolver that
7037 is not labelled as authenticated data
7038 is treated as equivalent to a temporary DNS error.
7039 The default is &"never"&.
7040
7041 See also the &$lookup_dnssec_authenticated$& variable.
7042
7043 .cindex timeout "dns lookup"
7044 .cindex "DNS" timeout
7045 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7046 The form is &"retrans_VAL"& where VAL is an Exim time specification
7047 (e.g. &"5s"&).
7048 The default value is set by the main configuration option &%dns_retrans%&.
7049
7050 Retries for the dnsdb lookup can be controlled by a retry modifier.
7051 The form if &"retry_VAL"& where VAL is an integer.
7052 The default count is set by the main configuration option &%dns_retry%&.
7053
7054 .new
7055 .cindex cacheing "of dns lookup"
7056 .cindex TTL "of dns lookup"
7057 .cindex DNS TTL
7058 Dnsdb lookup results are cached within a single process (and its children).
7059 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7060 value of the set of returned DNS records.
7061 .wen
7062
7063
7064 .section "Pseudo dnsdb record types" "SECID66"
7065 .cindex "MX record" "in &(dnsdb)& lookup"
7066 By default, both the preference value and the host name are returned for
7067 each MX record, separated by a space. If you want only host names, you can use
7068 the pseudo-type MXH:
7069 .code
7070 ${lookup dnsdb{mxh=a.b.example}}
7071 .endd
7072 In this case, the preference values are omitted, and just the host names are
7073 returned.
7074
7075 .cindex "name server for enclosing domain"
7076 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7077 records on the given domain, but if none are found, it removes the first
7078 component of the domain name, and tries again. This process continues until NS
7079 records are found or there are no more components left (or there is a DNS
7080 error). In other words, it may return the name servers for a top-level domain,
7081 but it never returns the root name servers. If there are no NS records for the
7082 top-level domain, the lookup fails. Consider these examples:
7083 .code
7084 ${lookup dnsdb{zns=xxx.quercite.com}}
7085 ${lookup dnsdb{zns=xxx.edu}}
7086 .endd
7087 Assuming that in each case there are no NS records for the full domain name,
7088 the first returns the name servers for &%quercite.com%&, and the second returns
7089 the name servers for &%edu%&.
7090
7091 You should be careful about how you use this lookup because, unless the
7092 top-level domain does not exist, the lookup always returns some host names. The
7093 sort of use to which this might be put is for seeing if the name servers for a
7094 given domain are on a blacklist. You can probably assume that the name servers
7095 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7096 such a list.
7097
7098 .cindex "CSA" "in &(dnsdb)& lookup"
7099 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7100 records according to the CSA rules, which are described in section
7101 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7102 not sufficient because of the extra parent domain search behaviour of CSA. The
7103 result of a successful lookup such as:
7104 .code
7105 ${lookup dnsdb {csa=$sender_helo_name}}
7106 .endd
7107 has two space-separated fields: an authorization code and a target host name.
7108 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7109 authorization required but absent, or &"?"& for unknown.
7110
7111 .cindex "A+" "in &(dnsdb)& lookup"
7112 The pseudo-type A+ performs an AAAA
7113 and then an A lookup.  All results are returned; defer processing
7114 (see below) is handled separately for each lookup.  Example:
7115 .code
7116 ${lookup dnsdb {>; a+=$sender_helo_name}}
7117 .endd
7118
7119
7120 .section "Multiple dnsdb lookups" "SECID67"
7121 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7122 However, you can specify a list of domains or IP addresses in a single
7123 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7124 the default separator, but with the ability to change this. For example:
7125 .code
7126 ${lookup dnsdb{one.domain.com:two.domain.com}}
7127 ${lookup dnsdb{a=one.host.com:two.host.com}}
7128 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7129 .endd
7130 In order to retain backwards compatibility, there is one special case: if
7131 the lookup type is PTR and no change of separator is specified, Exim looks
7132 to see if the rest of the string is precisely one IPv6 address. In this
7133 case, it does not treat it as a list.
7134
7135 The data from each lookup is concatenated, with newline separators by default,
7136 in the same way that multiple DNS records for a single item are handled. A
7137 different separator can be specified, as described above.
7138
7139
7140
7141
7142 .section "More about LDAP" "SECTldap"
7143 .cindex "LDAP" "lookup, more about"
7144 .cindex "lookup" "LDAP"
7145 .cindex "Solaris" "LDAP"
7146 The original LDAP implementation came from the University of Michigan; this has
7147 become &"Open LDAP"&, and there are now two different releases. Another
7148 implementation comes from Netscape, and Solaris 7 and subsequent releases
7149 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7150 the lookup function level, their error handling is different. For this reason
7151 it is necessary to set a compile-time variable when building Exim with LDAP, to
7152 indicate which LDAP library is in use. One of the following should appear in
7153 your &_Local/Makefile_&:
7154 .code
7155 LDAP_LIB_TYPE=UMICHIGAN
7156 LDAP_LIB_TYPE=OPENLDAP1
7157 LDAP_LIB_TYPE=OPENLDAP2
7158 LDAP_LIB_TYPE=NETSCAPE
7159 LDAP_LIB_TYPE=SOLARIS
7160 .endd
7161 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7162 same interface as the University of Michigan version.
7163
7164 There are three LDAP lookup types in Exim. These behave slightly differently in
7165 the way they handle the results of a query:
7166
7167 .ilist
7168 &(ldap)& requires the result to contain just one entry; if there are more, it
7169 gives an error.
7170 .next
7171 &(ldapdn)& also requires the result to contain just one entry, but it is the
7172 Distinguished Name that is returned rather than any attribute values.
7173 .next
7174 &(ldapm)& permits the result to contain more than one entry; the attributes
7175 from all of them are returned.
7176 .endlist
7177
7178
7179 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7180 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7181 the data returned by a successful lookup is described in the next section.
7182 First we explain how LDAP queries are coded.
7183
7184
7185 .section "Format of LDAP queries" "SECTforldaque"
7186 .cindex "LDAP" "query format"
7187 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7188 the configuration of a &(redirect)& router one might have this setting:
7189 .code
7190 data = ${lookup ldap \
7191   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7192   c=UK?mailbox?base?}}
7193 .endd
7194 .cindex "LDAP" "with TLS"
7195 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7196 secure (encrypted) LDAP connections. The second of these ensures that an
7197 encrypted TLS connection is used.
7198
7199 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7200 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7201 See the &%ldap_start_tls%& option.
7202
7203 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7204 controlled. Every part of the TLS configuration can be configured by settings in
7205 &_exim.conf_&. Depending on the version of the client libraries installed on
7206 your system, some of the initialization may have required setting options in
7207 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7208 certificates. This revealed a nuance where the current UID that exim was
7209 running as could affect which config files it read. With Exim 4.83, these
7210 methods become optional, only taking effect if not specifically set in
7211 &_exim.conf_&.
7212
7213
7214 .section "LDAP quoting" "SECID68"
7215 .cindex "LDAP" "quoting"
7216 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7217 and the second because the LDAP query is represented as a URL. Furthermore,
7218 within an LDAP query, two different kinds of quoting are required. For this
7219 reason, there are two different LDAP-specific quoting operators.
7220
7221 The &%quote_ldap%& operator is designed for use on strings that are part of
7222 filter specifications. Conceptually, it first does the following conversions on
7223 the string:
7224 .code
7225 *   =>   \2A
7226 (   =>   \28
7227 )   =>   \29
7228 \   =>   \5C
7229 .endd
7230 in accordance with RFC 2254. The resulting string is then quoted according
7231 to the rules for URLs, that is, all non-alphanumeric characters except
7232 .code
7233 ! $ ' - . _ ( ) * +
7234 .endd
7235 are converted to their hex values, preceded by a percent sign. For example:
7236 .code
7237 ${quote_ldap: a(bc)*, a<yz>; }
7238 .endd
7239 yields
7240 .code
7241 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7242 .endd
7243 Removing the URL quoting, this is (with a leading and a trailing space):
7244 .code
7245 a\28bc\29\2A, a<yz>;
7246 .endd
7247 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7248 base DN specifications in queries. Conceptually, it first converts the string
7249 by inserting a backslash in front of any of the following characters:
7250 .code
7251 , + " \ < > ;
7252 .endd
7253 It also inserts a backslash before any leading spaces or # characters, and
7254 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7255 is then quoted according to the rules for URLs. For example:
7256 .code
7257 ${quote_ldap_dn: a(bc)*, a<yz>; }
7258 .endd
7259 yields
7260 .code
7261 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7262 .endd
7263 Removing the URL quoting, this is (with a trailing space):
7264 .code
7265 \ a(bc)*\, a\<yz\>\;\
7266 .endd
7267 There are some further comments about quoting in the section on LDAP
7268 authentication below.
7269
7270
7271 .section "LDAP connections" "SECID69"
7272 .cindex "LDAP" "connections"
7273 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7274 is in use, via a Unix domain socket. The example given above does not specify
7275 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7276 by starting it with
7277 .code
7278 ldap://<hostname>:<port>/...
7279 .endd
7280 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7281 used. When no server is specified in a query, a list of default servers is
7282 taken from the &%ldap_default_servers%& configuration option. This supplies a
7283 colon-separated list of servers which are tried in turn until one successfully
7284 handles a query, or there is a serious error. Successful handling either
7285 returns the requested data, or indicates that it does not exist. Serious errors
7286 are syntactical, or multiple values when only a single value is expected.
7287 Errors which cause the next server to be tried are connection failures, bind
7288 failures, and timeouts.
7289
7290 For each server name in the list, a port number can be given. The standard way
7291 of specifying a host and port is to use a colon separator (RFC 1738). Because
7292 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7293 doubled. For example
7294 .code
7295 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7296 .endd
7297 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7298 to the LDAP library with no server name, and the library's default (normally
7299 the local host) is used.
7300
7301 If you are using the OpenLDAP library, you can connect to an LDAP server using
7302 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7303 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7304 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7305 not available.
7306
7307 For this type of connection, instead of a host name for the server, a pathname
7308 for the socket is required, and the port number is not relevant. The pathname
7309 can be specified either as an item in &%ldap_default_servers%&, or inline in
7310 the query. In the former case, you can have settings such as
7311 .code
7312 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7313 .endd
7314 When the pathname is given in the query, you have to escape the slashes as
7315 &`%2F`& to fit in with the LDAP URL syntax. For example:
7316 .code
7317 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7318 .endd
7319 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7320 a pathname, it uses the Unix domain socket code, even if the query actually
7321 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7322 socket connection. This behaviour means that you can use a setting of
7323 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7324 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7325 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7326 backup host.
7327
7328 If an explicit &`ldapi`& type is given in a query when a host name is
7329 specified, an error is diagnosed. However, if there are more items in
7330 &%ldap_default_servers%&, they are tried. In other words:
7331
7332 .ilist
7333 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7334 interface.
7335 .next
7336 Using &`ldapi`& with a host name causes an error.
7337 .endlist
7338
7339
7340 Using &`ldapi`& with no host or path in the query, and no setting of
7341 &%ldap_default_servers%&, does whatever the library does by default.
7342
7343
7344
7345 .section "LDAP authentication and control information" "SECID70"
7346 .cindex "LDAP" "authentication"
7347 The LDAP URL syntax provides no way of passing authentication and other control
7348 information to the server. To make this possible, the URL in an LDAP query may
7349 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7350 spaces. If a value contains spaces it must be enclosed in double quotes, and
7351 when double quotes are used, backslash is interpreted in the usual way inside
7352 them. The following names are recognized:
7353 .display
7354 &`DEREFERENCE`&  set the dereferencing parameter
7355 &`NETTIME    `&  set a timeout for a network operation
7356 &`USER       `&  set the DN, for authenticating the LDAP bind
7357 &`PASS       `&  set the password, likewise
7358 &`REFERRALS  `&  set the referrals parameter
7359 &`SERVERS    `&  set alternate server list for this query only
7360 &`SIZE       `&  set the limit for the number of entries returned
7361 &`TIME       `&  set the maximum waiting time for a query
7362 .endd
7363 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7364 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7365 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7366 library from trying to follow referrals issued by the LDAP server.
7367
7368 .cindex LDAP timeout
7369 .cindex timeout "LDAP lookup"
7370 The name CONNECT is an obsolete name for NETTIME, retained for
7371 backwards compatibility. This timeout (specified as a number of seconds) is
7372 enforced from the client end for operations that can be carried out over a
7373 network. Specifically, it applies to network connections and calls to the
7374 &'ldap_result()'& function. If the value is greater than zero, it is used if
7375 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7376 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7377 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7378 Netscape SDK; for OpenLDAP no action is taken.
7379
7380 The TIME parameter (also a number of seconds) is passed to the server to
7381 set a server-side limit on the time taken to complete a search.
7382
7383 The SERVERS parameter allows you to specify an alternate list of ldap servers
7384 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7385 default list of ldap servers, and a single lookup can specify a single ldap
7386 server to use.  But when you need to do a lookup with a list of servers that is
7387 different than the default list (maybe different order, maybe a completely
7388 different set of servers), the SERVERS parameter allows you to specify this
7389 alternate list (colon-separated).
7390
7391 Here is an example of an LDAP query in an Exim lookup that uses some of these
7392 values. This is a single line, folded to fit on the page:
7393 .code
7394 ${lookup ldap
7395   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7396   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7397   {$value}fail}
7398 .endd
7399 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7400 any of the auxiliary data. Exim configuration settings that include lookups
7401 which contain password information should be preceded by &"hide"& to prevent
7402 non-admin users from using the &%-bP%& option to see their values.
7403
7404 The auxiliary data items may be given in any order. The default is no
7405 connection timeout (the system timeout is used), no user or password, no limit
7406 on the number of entries returned, and no time limit on queries.
7407
7408 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7409 removes any URL quoting that it may contain before passing it LDAP. Apparently
7410 some libraries do this for themselves, but some do not. Removing the URL
7411 quoting has two advantages:
7412
7413 .ilist
7414 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7415 DNs as with DNs inside actual queries.
7416 .next
7417 It permits spaces inside USER= DNs.
7418 .endlist
7419
7420 For example, a setting such as
7421 .code
7422 USER=cn=${quote_ldap_dn:$1}
7423 .endd
7424 should work even if &$1$& contains spaces.
7425
7426 Expanded data for the PASS= value should be quoted using the &%quote%&
7427 expansion operator, rather than the LDAP quote operators. The only reason this
7428 field needs quoting is to ensure that it conforms to the Exim syntax, which
7429 does not allow unquoted spaces. For example:
7430 .code
7431 PASS=${quote:$3}
7432 .endd
7433 The LDAP authentication mechanism can be used to check passwords as part of
7434 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7435 &<<CHAPexpand>>&.
7436
7437
7438
7439 .section "Format of data returned by LDAP" "SECID71"
7440 .cindex "LDAP" "returned data formats"
7441 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7442 as a sequence of values, for example
7443 .code
7444 cn=manager,o=University of Cambridge,c=UK
7445 .endd
7446 The &(ldap)& lookup type generates an error if more than one entry matches the
7447 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7448 the result between the data from different entries. It is possible for multiple
7449 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7450 you know that whatever values are returned all came from a single entry in the
7451 directory.
7452
7453 In the common case where you specify a single attribute in your LDAP query, the
7454 result is not quoted, and does not contain the attribute name. If the attribute
7455 has multiple values, they are separated by commas. Any comma that is
7456 part of an attribute's value is doubled.
7457
7458 If you specify multiple attributes, the result contains space-separated, quoted
7459 strings, each preceded by the attribute name and an equals sign. Within the
7460 quotes, the quote character, backslash, and newline are escaped with
7461 backslashes, and commas are used to separate multiple values for the attribute.
7462 Any commas in attribute values are doubled
7463 (permitting treatment of the values as a comma-separated list).
7464 Apart from the escaping, the string within quotes takes the same form as the
7465 output when a single attribute is requested. Specifying no attributes is the
7466 same as specifying all of an entry's attributes.
7467
7468 Here are some examples of the output format. The first line of each pair is an
7469 LDAP query, and the second is the data that is returned. The attribute called
7470 &%attr1%& has two values, one of them with an embedded comma, whereas
7471 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7472 (they have SUP &%attr%& in their schema definitions).
7473
7474 .code
7475 ldap:///o=base?attr1?sub?(uid=fred)
7476 value1.1,value1,,2
7477
7478 ldap:///o=base?attr2?sub?(uid=fred)
7479 value two
7480
7481 ldap:///o=base?attr?sub?(uid=fred)
7482 value1.1,value1,,2,value two
7483
7484 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7485 attr1="value1.1,value1,,2" attr2="value two"
7486
7487 ldap:///o=base??sub?(uid=fred)
7488 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7489 .endd
7490 You can
7491 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7492 results of LDAP lookups.
7493 The &%extract%& operator in string expansions can be used to pick out
7494 individual fields from data that consists of &'key'&=&'value'& pairs.
7495 The &%listextract%& operator should be used to pick out individual values
7496 of attributes, even when only a single value is expected.
7497 The doubling of embedded commas allows you to use the returned data as a
7498 comma separated list (using the "<," syntax for changing the input list separator).
7499
7500
7501
7502
7503 .section "More about NIS+" "SECTnisplus"
7504 .cindex "NIS+ lookup type"
7505 .cindex "lookup" "NIS+"
7506 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7507 and field name. If this is given, the result of a successful query is the
7508 contents of the named field; otherwise the result consists of a concatenation
7509 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7510 values containing spaces are quoted. For example, the query
7511 .code
7512 [name=mg1456],passwd.org_dir
7513 .endd
7514 might return the string
7515 .code
7516 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7517 home=/home/mg1456 shell=/bin/bash shadow=""
7518 .endd
7519 (split over two lines here to fit on the page), whereas
7520 .code
7521 [name=mg1456],passwd.org_dir:gcos
7522 .endd
7523 would just return
7524 .code
7525 Martin Guerre
7526 .endd
7527 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7528 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7529 operator is to double any quote characters within the text.
7530
7531
7532
7533 .section "SQL lookups" "SECTsql"
7534 .cindex "SQL lookup types"
7535 .cindex "MySQL" "lookup type"
7536 .cindex "PostgreSQL lookup type"
7537 .cindex "lookup" "MySQL"
7538 .cindex "lookup" "PostgreSQL"
7539 .cindex "Oracle" "lookup type"
7540 .cindex "lookup" "Oracle"
7541 .cindex "InterBase lookup type"
7542 .cindex "lookup" "InterBase"
7543 .cindex "Redis lookup type"
7544 .cindex lookup Redis
7545 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7546 and SQLite
7547 databases. Queries for these databases contain SQL statements, so an example
7548 might be
7549 .code
7550 ${lookup mysql{select mailbox from users where id='userx'}\
7551   {$value}fail}
7552 .endd
7553 If the result of the query contains more than one field, the data for each
7554 field in the row is returned, preceded by its name, so the result of
7555 .code
7556 ${lookup pgsql{select home,name from users where id='userx'}\
7557   {$value}}
7558 .endd
7559 might be
7560 .code
7561 home=/home/userx name="Mister X"
7562 .endd
7563 Empty values and values containing spaces are double quoted, with embedded
7564 quotes escaped by a backslash. If the result of the query contains just one
7565 field, the value is passed back verbatim, without a field name, for example:
7566 .code
7567 Mister X
7568 .endd
7569 If the result of the query yields more than one row, it is all concatenated,
7570 with a newline between the data for each row.
7571
7572
7573 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7574 .cindex "MySQL" "lookup type"
7575 .cindex "PostgreSQL lookup type"
7576 .cindex "lookup" "MySQL"
7577 .cindex "lookup" "PostgreSQL"
7578 .cindex "Oracle" "lookup type"
7579 .cindex "lookup" "Oracle"
7580 .cindex "InterBase lookup type"
7581 .cindex "lookup" "InterBase"
7582 .cindex "Redis lookup type"
7583 .cindex lookup Redis
7584 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7585 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7586 or &%redis_servers%&
7587 option (as appropriate) must be set to a colon-separated list of server
7588 information.
7589 (For MySQL and PostgreSQL, the global option need not be set if all
7590 queries contain their own server information &-- see section
7591 &<<SECTspeserque>>&.)
7592 For all but Redis
7593 each item in the list is a slash-separated list of four
7594 items: host name, database name, user name, and password. In the case of
7595 Oracle, the host name field is used for the &"service name"&, and the database
7596 name field is not used and should be empty. For example:
7597 .code
7598 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7599 .endd
7600 Because password data is sensitive, you should always precede the setting with
7601 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7602 option. Here is an example where two MySQL servers are listed:
7603 .code
7604 hide mysql_servers = localhost/users/root/secret:\
7605                      otherhost/users/root/othersecret
7606 .endd
7607 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7608 because this is a colon-separated list, the colon has to be doubled. For each
7609 query, these parameter groups are tried in order until a connection is made and
7610 a query is successfully processed. The result of a query may be that no data is
7611 found, but that is still a successful query. In other words, the list of
7612 servers provides a backup facility, not a list of different places to look.
7613
7614 .new
7615 For Redis the global option need not be specified if all queries contain their
7616 own server information &-- see section &<<SECTspeserque>>&.
7617 If specified, the option must be set to a colon-separated list of server
7618 information.
7619 Each item in the list is a slash-separated list of three items:
7620 host, database number, and password.
7621 .olist
7622 The host is required and may be either an IPv4 address and optional
7623 port number (separated by a colon, which needs doubling due to the
7624 higher-level list), or a Unix socket pathname enclosed in parentheses
7625 .next
7626 The database number is optional; if present that number is selected in the backend
7627 .next
7628 The password is optional; if present it is used to authenticate to the backend
7629 .endlist
7630 .wen
7631
7632 .new
7633 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7634 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7635 respectively, and the characters single-quote, double-quote, and backslash
7636 itself are escaped with backslashes.
7637
7638 The &%quote_redis%& expansion operator
7639 escapes whitespace and backslash characters with a backslash.
7640 .wen
7641
7642 .section "Specifying the server in the query" "SECTspeserque"
7643 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7644 it is possible to specify a list of servers with an individual query. This is
7645 done by starting the query with
7646 .display
7647 &`servers=`&&'server1:server2:server3:...'&&`;`&
7648 .endd
7649 Each item in the list may take one of two forms:
7650 .olist
7651 If it contains no slashes it is assumed to be just a host name. The appropriate
7652 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7653 of the same name, and the remaining parameters (database, user, password) are
7654 taken from there.
7655 .next
7656 If it contains any slashes, it is taken as a complete parameter set.
7657 .endlist
7658 The list of servers is used in exactly the same way as the global list.
7659 Once a connection to a server has happened and a query has been
7660 successfully executed, processing of the lookup ceases.
7661
7662 This feature is intended for use in master/slave situations where updates
7663 are occurring and you want to update the master rather than a slave. If the
7664 master is in the list as a backup for reading, you might have a global setting
7665 like this:
7666 .code
7667 mysql_servers = slave1/db/name/pw:\
7668                 slave2/db/name/pw:\
7669                 master/db/name/pw
7670 .endd
7671 In an updating lookup, you could then write:
7672 .code
7673 ${lookup mysql{servers=master; UPDATE ...} }
7674 .endd
7675 That query would then be sent only to the master server. If, on the other hand,
7676 the master is not to be used for reading, and so is not present in the global
7677 option, you can still update it by a query of this form:
7678 .code
7679 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7680 .endd
7681
7682
7683 .section "Special MySQL features" "SECID73"
7684 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7685 causes a connection to the server on the local host by means of a Unix domain
7686 socket. An alternate socket can be specified in parentheses.
7687 .new
7688 An option group name for MySQL option files can be specified in square brackets;
7689 the default value is &"exim"&.
7690 .wen
7691 The full syntax of each item in &%mysql_servers%& is:
7692 .display
7693 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7694   <&'database'&>/<&'user'&>/<&'password'&>
7695 .endd
7696 Any of the four sub-parts of the first field can be omitted. For normal use on
7697 the local host it can be left blank or set to just &"localhost"&.
7698
7699 No database need be supplied &-- but if it is absent here, it must be given in
7700 the queries.
7701
7702 If a MySQL query is issued that does not request any data (an insert, update,
7703 or delete command), the result of the lookup is the number of rows affected.
7704
7705 &*Warning*&: This can be misleading. If an update does not actually change
7706 anything (for example, setting a field to the value it already has), the result
7707 is zero because no rows are affected.
7708
7709
7710 .section "Special PostgreSQL features" "SECID74"
7711 PostgreSQL lookups can also use Unix domain socket connections to the database.
7712 This is usually faster and costs less CPU time than a TCP/IP connection.
7713 However it can be used only if the mail server runs on the same machine as the
7714 database server. A configuration line for PostgreSQL via Unix domain sockets
7715 looks like this:
7716 .code
7717 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7718 .endd
7719 In other words, instead of supplying a host name, a path to the socket is
7720 given. The path name is enclosed in parentheses so that its slashes aren't
7721 visually confused with the delimiters for the other server parameters.
7722
7723 If a PostgreSQL query is issued that does not request any data (an insert,
7724 update, or delete command), the result of the lookup is the number of rows
7725 affected.
7726
7727 .section "More about SQLite" "SECTsqlite"
7728 .cindex "lookup" "SQLite"
7729 .cindex "sqlite lookup type"
7730 SQLite is different to the other SQL lookups because a file name is required in
7731 addition to the SQL query. An SQLite database is a single file, and there is no
7732 daemon as in the other SQL databases. The interface to Exim requires the name
7733 of the file, as an absolute path, to be given at the start of the query. It is
7734 separated from the query by white space. This means that the path name cannot
7735 contain white space. Here is a lookup expansion example:
7736 .code
7737 ${lookup sqlite {/some/thing/sqlitedb \
7738   select name from aliases where id='userx';}}
7739 .endd
7740 In a list, the syntax is similar. For example:
7741 .code
7742 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7743    select * from relays where ip='$sender_host_address';
7744 .endd
7745 The only character affected by the &%quote_sqlite%& operator is a single
7746 quote, which it doubles.
7747
7748 .cindex timeout SQLite
7749 .cindex sqlite "lookup timeout"
7750 The SQLite library handles multiple simultaneous accesses to the database
7751 internally. Multiple readers are permitted, but only one process can
7752 update at once. Attempts to access the database while it is being updated
7753 are rejected after a timeout period, during which the SQLite library
7754 waits for the lock to be released. In Exim, the default timeout is set
7755 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7756 option.
7757 .ecindex IIDfidalo1
7758 .ecindex IIDfidalo2
7759
7760
7761 . ////////////////////////////////////////////////////////////////////////////
7762 . ////////////////////////////////////////////////////////////////////////////
7763
7764 .chapter "Domain, host, address, and local part lists" &&&
7765          "CHAPdomhosaddlists" &&&
7766          "Domain, host, and address lists"
7767 .scindex IIDdohoadli "lists of domains; hosts; etc."
7768 A number of Exim configuration options contain lists of domains, hosts,
7769 email addresses, or local parts. For example, the &%hold_domains%& option
7770 contains a list of domains whose delivery is currently suspended. These lists
7771 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7772 arguments to expansion conditions such as &%match_domain%&.
7773
7774 Each item in one of these lists is a pattern to be matched against a domain,
7775 host, email address, or local part, respectively. In the sections below, the
7776 different types of pattern for each case are described, but first we cover some
7777 general facilities that apply to all four kinds of list.
7778
7779 Note that other parts of Exim use a &'string list'& which does not
7780 support all the complexity available in
7781 domain, host, address and local part lists.
7782
7783
7784
7785 .section "Expansion of lists" "SECTlistexpand"
7786 .cindex "expansion" "of lists"
7787 Each list is expanded as a single string before it is used. The result of
7788 expansion must be a list, possibly containing empty items, which is split up
7789 into separate items for matching. By default, colon is the separator character,
7790 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7791 &<<SECTempitelis>>& for details of the list syntax; the second of these
7792 discusses the way to specify empty list items.
7793
7794
7795 If the string expansion is forced to fail, Exim behaves as if the item it is
7796 testing (domain, host, address, or local part) is not in the list. Other
7797 expansion failures cause temporary errors.
7798
7799 If an item in a list is a regular expression, backslashes, dollars and possibly
7800 other special characters in the expression must be protected against
7801 misinterpretation by the string expander. The easiest way to do this is to use
7802 the &`\N`& expansion feature to indicate that the contents of the regular
7803 expression should not be expanded. For example, in an ACL you might have:
7804 .code
7805 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7806                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7807 .endd
7808 The first item is a regular expression that is protected from expansion by
7809 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7810 senders based on the receiving domain.
7811
7812
7813
7814
7815 .section "Negated items in lists" "SECID76"
7816 .cindex "list" "negation"
7817 .cindex "negation" "in lists"
7818 Items in a list may be positive or negative. Negative items are indicated by a
7819 leading exclamation mark, which may be followed by optional white space. A list
7820 defines a set of items (domains, etc). When Exim processes one of these lists,
7821 it is trying to find out whether a domain, host, address, or local part
7822 (respectively) is in the set that is defined by the list. It works like this:
7823
7824 The list is scanned from left to right. If a positive item is matched, the
7825 subject that is being checked is in the set; if a negative item is matched, the
7826 subject is not in the set. If the end of the list is reached without the
7827 subject having matched any of the patterns, it is in the set if the last item
7828 was a negative one, but not if it was a positive one. For example, the list in
7829 .code
7830 domainlist relay_to_domains = !a.b.c : *.b.c
7831 .endd
7832 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7833 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7834 list is positive. However, if the setting were
7835 .code
7836 domainlist relay_to_domains = !a.b.c
7837 .endd
7838 then all domains other than &'a.b.c'& would match because the last item in the
7839 list is negative. In other words, a list that ends with a negative item behaves
7840 as if it had an extra item &`:*`& on the end.
7841
7842 Another way of thinking about positive and negative items in lists is to read
7843 the connector as &"or"& after a positive item and as &"and"& after a negative
7844 item.
7845
7846
7847
7848 .section "File names in lists" "SECTfilnamlis"
7849 .cindex "list" "file name in"
7850 If an item in a domain, host, address, or local part list is an absolute file
7851 name (beginning with a slash character), each line of the file is read and
7852 processed as if it were an independent item in the list, except that further
7853 file names are not allowed,
7854 and no expansion of the data from the file takes place.
7855 Empty lines in the file are ignored, and the file may also contain comment
7856 lines:
7857
7858 .ilist
7859 For domain and host lists, if a # character appears anywhere in a line of the
7860 file, it and all following characters are ignored.
7861 .next
7862 Because local parts may legitimately contain # characters, a comment in an
7863 address list or local part list file is recognized only if # is preceded by
7864 white space or the start of the line. For example:
7865 .code
7866 not#comment@x.y.z   # but this is a comment
7867 .endd
7868 .endlist
7869
7870 Putting a file name in a list has the same effect as inserting each line of the
7871 file as an item in the list (blank lines and comments excepted). However, there
7872 is one important difference: the file is read each time the list is processed,
7873 so if its contents vary over time, Exim's behaviour changes.
7874
7875 If a file name is preceded by an exclamation mark, the sense of any match
7876 within the file is inverted. For example, if
7877 .code
7878 hold_domains = !/etc/nohold-domains
7879 .endd
7880 and the file contains the lines
7881 .code
7882 !a.b.c
7883 *.b.c
7884 .endd
7885 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7886 any domain matching &`*.b.c`& is not.
7887
7888
7889
7890 .section "An lsearch file is not an out-of-line list" "SECID77"
7891 As will be described in the sections that follow, lookups can be used in lists
7892 to provide indexed methods of checking list membership. There has been some
7893 confusion about the way &(lsearch)& lookups work in lists. Because
7894 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7895 sometimes thought that it is allowed to contain wild cards and other kinds of
7896 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7897 always fixed strings, just as for any other single-key lookup type.
7898
7899 If you want to use a file to contain wild-card patterns that form part of a
7900 list, just give the file name on its own, without a search type, as described
7901 in the previous section. You could also use the &(wildlsearch)& or
7902 &(nwildlsearch)&, but there is no advantage in doing this.
7903
7904
7905
7906
7907 .section "Named lists" "SECTnamedlists"
7908 .cindex "named lists"
7909 .cindex "list" "named"
7910 A list of domains, hosts, email addresses, or local parts can be given a name
7911 which is then used to refer to the list elsewhere in the configuration. This is
7912 particularly convenient if the same list is required in several different
7913 places. It also allows lists to be given meaningful names, which can improve
7914 the readability of the configuration. For example, it is conventional to define
7915 a domain list called &'local_domains'& for all the domains that are handled
7916 locally on a host, using a configuration line such as
7917 .code
7918 domainlist local_domains = localhost:my.dom.example
7919 .endd
7920 Named lists are referenced by giving their name preceded by a plus sign, so,
7921 for example, a router that is intended to handle local domains would be
7922 configured with the line
7923 .code
7924 domains = +local_domains
7925 .endd
7926 The first router in a configuration is often one that handles all domains
7927 except the local ones, using a configuration with a negated item like this:
7928 .code
7929 dnslookup:
7930   driver = dnslookup
7931   domains = ! +local_domains
7932   transport = remote_smtp
7933   no_more
7934 .endd
7935 The four kinds of named list are created by configuration lines starting with
7936 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7937 respectively. Then there follows the name that you are defining, followed by an
7938 equals sign and the list itself. For example:
7939 .code
7940 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7941 addresslist bad_senders = cdb;/etc/badsenders
7942 .endd
7943 A named list may refer to other named lists:
7944 .code
7945 domainlist  dom1 = first.example : second.example
7946 domainlist  dom2 = +dom1 : third.example
7947 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7948 .endd
7949 &*Warning*&: If the last item in a referenced list is a negative one, the
7950 effect may not be what you intended, because the negation does not propagate
7951 out to the higher level. For example, consider:
7952 .code
7953 domainlist  dom1 = !a.b
7954 domainlist  dom2 = +dom1 : *.b
7955 .endd
7956 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7957 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7958 means it matches the second list as well. The effect is not the same as
7959 .code
7960 domainlist  dom2 = !a.b : *.b
7961 .endd
7962 where &'x.y'& does not match. It's best to avoid negation altogether in
7963 referenced lists if you can.
7964
7965 Named lists may have a performance advantage. When Exim is routing an
7966 address or checking an incoming message, it caches the result of tests on named
7967 lists. So, if you have a setting such as
7968 .code
7969 domains = +local_domains
7970 .endd
7971 on several of your routers
7972 or in several ACL statements,
7973 the actual test is done only for the first one. However, the caching works only
7974 if there are no expansions within the list itself or any sublists that it
7975 references. In other words, caching happens only for lists that are known to be
7976 the same each time they are referenced.
7977
7978 By default, there may be up to 16 named lists of each type. This limit can be
7979 extended by changing a compile-time variable. The use of domain and host lists
7980 is recommended for concepts such as local domains, relay domains, and relay
7981 hosts. The default configuration is set up like this.
7982
7983
7984
7985 .section "Named lists compared with macros" "SECID78"
7986 .cindex "list" "named compared with macro"
7987 .cindex "macro" "compared with named list"
7988 At first sight, named lists might seem to be no different from macros in the
7989 configuration file. However, macros are just textual substitutions. If you
7990 write
7991 .code
7992 ALIST = host1 : host2
7993 auth_advertise_hosts = !ALIST
7994 .endd
7995 it probably won't do what you want, because that is exactly the same as
7996 .code
7997 auth_advertise_hosts = !host1 : host2
7998 .endd
7999 Notice that the second host name is not negated. However, if you use a host
8000 list, and write
8001 .code
8002 hostlist alist = host1 : host2
8003 auth_advertise_hosts = ! +alist
8004 .endd
8005 the negation applies to the whole list, and so that is equivalent to
8006 .code
8007 auth_advertise_hosts = !host1 : !host2
8008 .endd
8009
8010
8011 .section "Named list caching" "SECID79"
8012 .cindex "list" "caching of named"
8013 .cindex "caching" "named lists"
8014 While processing a message, Exim caches the result of checking a named list if
8015 it is sure that the list is the same each time. In practice, this means that
8016 the cache operates only if the list contains no $ characters, which guarantees
8017 that it will not change when it is expanded. Sometimes, however, you may have
8018 an expanded list that you know will be the same each time within a given
8019 message. For example:
8020 .code
8021 domainlist special_domains = \
8022            ${lookup{$sender_host_address}cdb{/some/file}}
8023 .endd
8024 This provides a list of domains that depends only on the sending host's IP
8025 address. If this domain list is referenced a number of times (for example,
8026 in several ACL lines, or in several routers) the result of the check is not
8027 cached by default, because Exim does not know that it is going to be the
8028 same list each time.
8029
8030 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8031 cache the result anyway. For example:
8032 .code
8033 domainlist_cache special_domains = ${lookup{...
8034 .endd
8035 If you do this, you should be absolutely sure that caching is going to do
8036 the right thing in all cases. When in doubt, leave it out.
8037
8038
8039
8040 .section "Domain lists" "SECTdomainlist"
8041 .cindex "domain list" "patterns for"
8042 .cindex "list" "domain list"
8043 Domain lists contain patterns that are to be matched against a mail domain.
8044 The following types of item may appear in domain lists:
8045
8046 .ilist
8047 .cindex "primary host name"
8048 .cindex "host name" "matched in domain list"
8049 .oindex "&%primary_hostname%&"
8050 .cindex "domain list" "matching primary host name"
8051 .cindex "@ in a domain list"
8052 If a pattern consists of a single @ character, it matches the local host name,
8053 as set by the &%primary_hostname%& option (or defaulted). This makes it
8054 possible to use the same configuration file on several different hosts that
8055 differ only in their names.
8056 .next
8057 .cindex "@[] in a domain list"
8058 .cindex "domain list" "matching local IP interfaces"
8059 .cindex "domain literal"
8060 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8061 in square brackets (as in an email address that contains a domain literal), but
8062 only if that IP address is recognized as local for email routing purposes. The
8063 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8064 control which of a host's several IP addresses are treated as local.
8065 In today's Internet, the use of domain literals is controversial.
8066 .next
8067 .cindex "@mx_any"
8068 .cindex "@mx_primary"
8069 .cindex "@mx_secondary"
8070 .cindex "domain list" "matching MX pointers to local host"
8071 If a pattern consists of the string &`@mx_any`& it matches any domain that
8072 has an MX record pointing to the local host or to any host that is listed in
8073 .oindex "&%hosts_treat_as_local%&"
8074 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8075 are similar, except that the first matches only when a primary MX target is the
8076 local host, and the second only when no primary MX target is the local host,
8077 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8078 preference value &-- there may of course be more than one of them.
8079
8080 The MX lookup that takes place when matching a pattern of this type is
8081 performed with the resolver options for widening names turned off. Thus, for
8082 example, a single-component domain will &'not'& be expanded by adding the
8083 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8084 options of the &(dnslookup)& router for a discussion of domain widening.
8085
8086 Sometimes you may want to ignore certain IP addresses when using one of these
8087 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8088 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8089 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8090 on a router). For example:
8091 .code
8092 domains = @mx_any/ignore=127.0.0.1
8093 .endd
8094 This example matches any domain that has an MX record pointing to one of
8095 the local host's IP addresses other than 127.0.0.1.
8096
8097 The list of IP addresses is in fact processed by the same code that processes
8098 host lists, so it may contain CIDR-coded network specifications and it may also
8099 contain negative items.
8100
8101 Because the list of IP addresses is a sublist within a domain list, you have to
8102 be careful about delimiters if there is more than one address. Like any other
8103 list, the default delimiter can be changed. Thus, you might have:
8104 .code
8105 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8106           an.other.domain : ...
8107 .endd
8108 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8109 involved, it is easiest to change the delimiter for the main list as well:
8110 .code
8111 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8112           an.other.domain ? ...
8113 .endd
8114 .next
8115 .cindex "asterisk" "in domain list"
8116 .cindex "domain list" "asterisk in"
8117 .cindex "domain list" "matching &""ends with""&"
8118 If a pattern starts with an asterisk, the remaining characters of the pattern
8119 are compared with the terminating characters of the domain. The use of &"*"& in
8120 domain lists differs from its use in partial matching lookups. In a domain
8121 list, the character following the asterisk need not be a dot, whereas partial
8122 matching works only in terms of dot-separated components. For example, a domain
8123 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8124 &'cipher.key.ex'&.
8125
8126 .next
8127 .cindex "regular expressions" "in domain list"
8128 .cindex "domain list" "matching regular expression"
8129 If a pattern starts with a circumflex character, it is treated as a regular
8130 expression, and matched against the domain using a regular expression matching
8131 function. The circumflex is treated as part of the regular expression.
8132 Email domains are case-independent, so this regular expression match is by
8133 default case-independent, but you can make it case-dependent by starting it
8134 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8135 are given in chapter &<<CHAPregexp>>&.
8136
8137 &*Warning*&: Because domain lists are expanded before being processed, you
8138 must escape any backslash and dollar characters in the regular expression, or
8139 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8140 it is not to be expanded (unless you really do want to build a regular
8141 expression by expansion, of course).
8142 .next
8143 .cindex "lookup" "in domain list"
8144 .cindex "domain list" "matching by lookup"
8145 If a pattern starts with the name of a single-key lookup type followed by a
8146 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8147 must be a file name in a suitable format for the lookup type. For example, for
8148 &"cdb;"& it must be an absolute path:
8149 .code
8150 domains = cdb;/etc/mail/local_domains.cdb
8151 .endd
8152 The appropriate type of lookup is done on the file using the domain name as the
8153 key. In most cases, the data that is looked up is not used; Exim is interested
8154 only in whether or not the key is present in the file. However, when a lookup
8155 is used for the &%domains%& option on a router
8156 or a &%domains%& condition in an ACL statement, the data is preserved in the
8157 &$domain_data$& variable and can be referred to in other router options or
8158 other statements in the same ACL.
8159
8160 .next
8161 Any of the single-key lookup type names may be preceded by
8162 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8163 .code
8164 domains = partial-dbm;/partial/domains
8165 .endd
8166 This causes partial matching logic to be invoked; a description of how this
8167 works is given in section &<<SECTpartiallookup>>&.
8168
8169 .next
8170 .cindex "asterisk" "in lookup type"
8171 Any of the single-key lookup types may be followed by an asterisk. This causes
8172 a default lookup for a key consisting of a single asterisk to be done if the
8173 original lookup fails. This is not a useful feature when using a domain list to
8174 select particular domains (because any domain would match), but it might have
8175 value if the result of the lookup is being used via the &$domain_data$&
8176 expansion variable.
8177 .next
8178 If the pattern starts with the name of a query-style lookup type followed by a
8179 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8180 pattern must be an appropriate query for the lookup type, as described in
8181 chapter &<<CHAPfdlookup>>&. For example:
8182 .code
8183 hold_domains = mysql;select domain from holdlist \
8184   where domain = '${quote_mysql:$domain}';
8185 .endd
8186 In most cases, the data that is looked up is not used (so for an SQL query, for
8187 example, it doesn't matter what field you select). Exim is interested only in
8188 whether or not the query succeeds. However, when a lookup is used for the
8189 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8190 variable and can be referred to in other options.
8191 .next
8192 .cindex "domain list" "matching literal domain name"
8193 If none of the above cases apply, a caseless textual comparison is made
8194 between the pattern and the domain.
8195 .endlist
8196
8197 Here is an example that uses several different kinds of pattern:
8198 .code
8199 domainlist funny_domains = \
8200   @ : \
8201   lib.unseen.edu : \
8202   *.foundation.fict.example : \
8203   \N^[1-2]\d{3}\.fict\.example$\N : \
8204   partial-dbm;/opt/data/penguin/book : \
8205   nis;domains.byname : \
8206   nisplus;[name=$domain,status=local],domains.org_dir
8207 .endd
8208 There are obvious processing trade-offs among the various matching modes. Using
8209 an asterisk is faster than a regular expression, and listing a few names
8210 explicitly probably is too. The use of a file or database lookup is expensive,
8211 but may be the only option if hundreds of names are required. Because the
8212 patterns are tested in order, it makes sense to put the most commonly matched
8213 patterns earlier.
8214
8215
8216
8217 .section "Host lists" "SECThostlist"
8218 .cindex "host list" "patterns in"
8219 .cindex "list" "host list"
8220 Host lists are used to control what remote hosts are allowed to do. For
8221 example, some hosts may be allowed to use the local host as a relay, and some
8222 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8223 two different ways, by name or by IP address. In a host list, some types of
8224 pattern are matched to a host name, and some are matched to an IP address.
8225 You need to be particularly careful with this when single-key lookups are
8226 involved, to ensure that the right value is being used as the key.
8227
8228
8229 .section "Special host list patterns" "SECID80"
8230 .cindex "empty item in hosts list"
8231 .cindex "host list" "empty string in"
8232 If a host list item is the empty string, it matches only when no remote host is
8233 involved. This is the case when a message is being received from a local
8234 process using SMTP on the standard input, that is, when a TCP/IP connection is
8235 not used.
8236
8237 .cindex "asterisk" "in host list"
8238 The special pattern &"*"& in a host list matches any host or no host. Neither
8239 the IP address nor the name is actually inspected.
8240
8241
8242
8243 .section "Host list patterns that match by IP address" "SECThoslispatip"
8244 .cindex "host list" "matching IP addresses"
8245 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8246 the incoming address actually appears in the IPv6 host as
8247 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8248 list, it is converted into a traditional IPv4 address first. (Not all operating
8249 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8250 concerns.)
8251
8252 The following types of pattern in a host list check the remote host by
8253 inspecting its IP address:
8254
8255 .ilist
8256 If the pattern is a plain domain name (not a regular expression, not starting
8257 with *, not a lookup of any kind), Exim calls the operating system function
8258 to find the associated IP address(es). Exim uses the newer
8259 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8260 This typically causes a forward DNS lookup of the name. The result is compared
8261 with the IP address of the subject host.
8262
8263 If there is a temporary problem (such as a DNS timeout) with the host name
8264 lookup, a temporary error occurs. For example, if the list is being used in an
8265 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8266 temporary SMTP error code. If no IP address can be found for the host name,
8267 what happens is described in section &<<SECTbehipnot>>& below.
8268
8269 .next
8270 .cindex "@ in a host list"
8271 If the pattern is &"@"&, the primary host name is substituted and used as a
8272 domain name, as just described.
8273
8274 .next
8275 If the pattern is an IP address, it is matched against the IP address of the
8276 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8277 IPv6 addresses can be given in colon-separated format, but the colons have to
8278 be doubled so as not to be taken as item separators when the default list
8279 separator is used. IPv6 addresses are recognized even when Exim is compiled
8280 without IPv6 support. This means that if they appear in a host list on an
8281 IPv4-only host, Exim will not treat them as host names. They are just addresses
8282 that can never match a client host.
8283
8284 .next
8285 .cindex "@[] in a host list"
8286 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8287 the local host. For example, if the local host is an IPv4 host with one
8288 interface address 10.45.23.56, these two ACL statements have the same effect:
8289 .code
8290 accept hosts = 127.0.0.1 : 10.45.23.56
8291 accept hosts = @[]
8292 .endd
8293 .next
8294 .cindex "CIDR notation"
8295 If the pattern is an IP address followed by a slash and a mask length (for
8296 example 10.11.42.0/24), it is matched against the IP address of the subject
8297 host under the given mask. This allows, an entire network of hosts to be
8298 included (or excluded) by a single item. The mask uses CIDR notation; it
8299 specifies the number of address bits that must match, starting from the most
8300 significant end of the address.
8301
8302 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8303 of a range of addresses. It is the number of bits in the network portion of the
8304 address. The above example specifies a 24-bit netmask, so it matches all 256
8305 addresses in the 10.11.42.0 network. An item such as
8306 .code
8307 192.168.23.236/31
8308 .endd
8309 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8310 32 for an IPv4 address is the same as no mask at all; just a single address
8311 matches.
8312
8313 Here is another example which shows an IPv4 and an IPv6 network:
8314 .code
8315 recipient_unqualified_hosts = 192.168.0.0/16: \
8316                               3ffe::ffff::836f::::/48
8317 .endd
8318 The doubling of list separator characters applies only when these items
8319 appear inline in a host list. It is not required when indirecting via a file.
8320 For example:
8321 .code
8322 recipient_unqualified_hosts = /opt/exim/unqualnets
8323 .endd
8324 could make use of a file containing
8325 .code
8326 172.16.0.0/12
8327 3ffe:ffff:836f::/48
8328 .endd
8329 to have exactly the same effect as the previous example. When listing IPv6
8330 addresses inline, it is usually more convenient to use the facility for
8331 changing separator characters. This list contains the same two networks:
8332 .code
8333 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8334                                  3ffe:ffff:836f::/48
8335 .endd
8336 The separator is changed to semicolon by the leading &"<;"& at the start of the
8337 list.
8338 .endlist
8339
8340
8341
8342 .section "Host list patterns for single-key lookups by host address" &&&
8343          "SECThoslispatsikey"
8344 .cindex "host list" "lookup of IP address"
8345 When a host is to be identified by a single-key lookup of its complete IP
8346 address, the pattern takes this form:
8347 .display
8348 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8349 .endd
8350 For example:
8351 .code
8352 hosts_lookup = net-cdb;/hosts-by-ip.db
8353 .endd
8354 The text form of the IP address of the subject host is used as the lookup key.
8355 IPv6 addresses are converted to an unabbreviated form, using lower case
8356 letters, with dots as separators because colon is the key terminator in
8357 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8358 quoting the keys, but this is a facility that was added later.] The data
8359 returned by the lookup is not used.
8360
8361 .cindex "IP address" "masking"
8362 .cindex "host list" "masked IP address"
8363 Single-key lookups can also be performed using masked IP addresses, using
8364 patterns of this form:
8365 .display
8366 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8367 .endd
8368 For example:
8369 .code
8370 net24-dbm;/networks.db
8371 .endd
8372 The IP address of the subject host is masked using <&'number'&> as the mask
8373 length. A textual string is constructed from the masked value, followed by the
8374 mask, and this is used as the lookup key. For example, if the host's IP address
8375 is 192.168.34.6, the key that is looked up for the above example is
8376 &"192.168.34.0/24"&.
8377
8378 When an IPv6 address is converted to a string, dots are normally used instead
8379 of colons, so that keys in &(lsearch)& files need not contain colons (which
8380 terminate &(lsearch)& keys). This was implemented some time before the ability
8381 to quote keys was made available in &(lsearch)& files. However, the more
8382 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8383 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8384 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8385 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8386 addresses are always used.
8387
8388 Ideally, it would be nice to tidy up this anomalous situation by changing to
8389 colons in all cases, given that quoting is now available for &(lsearch)&.
8390 However, this would be an incompatible change that might break some existing
8391 configurations.
8392
8393 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8394 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8395 the former case the key strings include the mask value, whereas in the latter
8396 case the IP address is used on its own.
8397
8398
8399
8400 .section "Host list patterns that match by host name" "SECThoslispatnam"
8401 .cindex "host" "lookup failures"
8402 .cindex "unknown host name"
8403 .cindex "host list" "matching host name"
8404 There are several types of pattern that require Exim to know the name of the
8405 remote host. These are either wildcard patterns or lookups by name. (If a
8406 complete hostname is given without any wildcarding, it is used to find an IP
8407 address to match against, as described in section &<<SECThoslispatip>>&
8408 above.)
8409
8410 If the remote host name is not already known when Exim encounters one of these
8411 patterns, it has to be found from the IP address.
8412 Although many sites on the Internet are conscientious about maintaining reverse
8413 DNS data for their hosts, there are also many that do not do this.
8414 Consequently, a name cannot always be found, and this may lead to unwanted
8415 effects. Take care when configuring host lists with wildcarded name patterns.
8416 Consider what will happen if a name cannot be found.
8417
8418 Because of the problems of determining host names from IP addresses, matching
8419 against host names is not as common as matching against IP addresses.
8420
8421 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8422 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8423 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8424 are done can be changed by setting the &%host_lookup_order%& option. For
8425 security, once Exim has found one or more names, it looks up the IP addresses
8426 for these names and compares them with the IP address that it started with.
8427 Only those names whose IP addresses match are accepted. Any other names are
8428 discarded. If no names are left, Exim behaves as if the host name cannot be
8429 found. In the most common case there is only one name and one IP address.
8430
8431 There are some options that control what happens if a host name cannot be
8432 found. These are described in section &<<SECTbehipnot>>& below.
8433
8434 .cindex "host" "alias for"
8435 .cindex "alias for host"
8436 As a result of aliasing, hosts may have more than one name. When processing any
8437 of the following types of pattern, all the host's names are checked:
8438
8439 .ilist
8440 .cindex "asterisk" "in host list"
8441 If a pattern starts with &"*"& the remainder of the item must match the end of
8442 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8443 &'.b.c'&. This special simple form is provided because this is a very common
8444 requirement. Other kinds of wildcarding require the use of a regular
8445 expression.
8446 .next
8447 .cindex "regular expressions" "in host list"
8448 .cindex "host list" "regular expression in"
8449 If the item starts with &"^"& it is taken to be a regular expression which is
8450 matched against the host name. Host names are case-independent, so this regular
8451 expression match is by default case-independent, but you can make it
8452 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8453 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8454 example,
8455 .code
8456 ^(a|b)\.c\.d$
8457 .endd
8458 is a regular expression that matches either of the two hosts &'a.c.d'& or
8459 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8460 that backslash and dollar characters are not misinterpreted as part of the
8461 string expansion. The simplest way to do this is to use &`\N`& to mark that
8462 part of the string as non-expandable. For example:
8463 .code
8464 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8465 .endd
8466 &*Warning*&: If you want to match a complete host name, you must include the
8467 &`$`& terminating metacharacter in the regular expression, as in the above
8468 example. Without it, a match at the start of the host name is all that is
8469 required.
8470 .endlist
8471
8472
8473
8474
8475 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8476 .cindex "host" "lookup failures, permanent"
8477 While processing a host list, Exim may need to look up an IP address from a
8478 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8479 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8480 behaviour when it fails to find the information it is seeking is the same.
8481
8482 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8483 apply to temporary DNS errors, whose handling is described in the next section.
8484
8485 .cindex "&`+include_unknown`&"
8486 .cindex "&`+ignore_unknown`&"
8487 Exim parses a host list from left to right. If it encounters a permanent
8488 lookup failure in any item in the host list before it has found a match,
8489 Exim treats it as a failure and the default behavior is as if the host
8490 does not match the list. This may not always be what you want to happen.
8491 To change Exim's behaviour, the special items &`+include_unknown`& or
8492 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8493 not recognized in an indirected file).
8494
8495 .ilist
8496 If any item that follows &`+include_unknown`& requires information that
8497 cannot found, Exim behaves as if the host does match the list. For example,
8498 .code
8499 host_reject_connection = +include_unknown:*.enemy.ex
8500 .endd
8501 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8502 any hosts whose name it cannot find.
8503
8504 .next
8505 If any item that follows &`+ignore_unknown`& requires information that cannot
8506 be found, Exim ignores that item and proceeds to the rest of the list. For
8507 example:
8508 .code
8509 accept hosts = +ignore_unknown : friend.example : \
8510                192.168.4.5
8511 .endd
8512 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8513 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8514 name can be found for 192.168.4.5, it is rejected.
8515 .endlist
8516
8517 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8518 list. The effect of each one lasts until the next, or until the end of the
8519 list.
8520
8521 .section "Mixing wildcarded host names and addresses in host lists" &&&
8522          "SECTmixwilhos"
8523 .cindex "host list" "mixing names and addresses in"
8524
8525 This section explains the host/ip processing logic with the same concepts
8526 as the previous section, but specifically addresses what happens when a
8527 wildcarded hostname is one of the items in the hostlist.
8528
8529 .ilist
8530 If you have name lookups or wildcarded host names and
8531 IP addresses in the same host list, you should normally put the IP
8532 addresses first. For example, in an ACL you could have:
8533 .code
8534 accept hosts = 10.9.8.7 : *.friend.example
8535 .endd
8536 The reason you normally would order it this way lies in the
8537 left-to-right way that Exim processes lists.  It can test IP addresses
8538 without doing any DNS lookups, but when it reaches an item that requires
8539 a host name, it fails if it cannot find a host name to compare with the
8540 pattern. If the above list is given in the opposite order, the
8541 &%accept%& statement fails for a host whose name cannot be found, even
8542 if its IP address is 10.9.8.7.
8543
8544 .next
8545 If you really do want to do the name check first, and still recognize the IP
8546 address, you can rewrite the ACL like this:
8547 .code
8548 accept hosts = *.friend.example
8549 accept hosts = 10.9.8.7
8550 .endd
8551 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8552 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8553 &`+ignore_unknown`&, which was discussed in depth in the first example in
8554 this section.
8555 .endlist
8556
8557
8558 .section "Temporary DNS errors when looking up host information" &&&
8559          "SECTtemdnserr"
8560 .cindex "host" "lookup failures, temporary"
8561 .cindex "&`+include_defer`&"
8562 .cindex "&`+ignore_defer`&"
8563 A temporary DNS lookup failure normally causes a defer action (except when
8564 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8565 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8566 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8567 section. These options should be used with care, probably only in non-critical
8568 host lists such as whitelists.
8569
8570
8571
8572 .section "Host list patterns for single-key lookups by host name" &&&
8573          "SECThoslispatnamsk"
8574 .cindex "unknown host name"
8575 .cindex "host list" "matching host name"
8576 If a pattern is of the form
8577 .display
8578 <&'single-key-search-type'&>;<&'search-data'&>
8579 .endd
8580 for example
8581 .code
8582 dbm;/host/accept/list
8583 .endd
8584 a single-key lookup is performed, using the host name as its key. If the
8585 lookup succeeds, the host matches the item. The actual data that is looked up
8586 is not used.
8587
8588 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8589 keys in the file, not IP addresses. If you want to do lookups based on IP
8590 addresses, you must precede the search type with &"net-"& (see section
8591 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8592 two items in the same list, one doing an address lookup and one doing a name
8593 lookup, both using the same file.
8594
8595
8596
8597 .section "Host list patterns for query-style lookups" "SECID81"
8598 If a pattern is of the form
8599 .display
8600 <&'query-style-search-type'&>;<&'query'&>
8601 .endd
8602 the query is obeyed, and if it succeeds, the host matches the item. The actual
8603 data that is looked up is not used. The variables &$sender_host_address$& and
8604 &$sender_host_name$& can be used in the query. For example:
8605 .code
8606 hosts_lookup = pgsql;\
8607   select ip from hostlist where ip='$sender_host_address'
8608 .endd
8609 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8610 can use the &%sg%& expansion item to change this if you need to. If you want to
8611 use masked IP addresses in database queries, you can use the &%mask%& expansion
8612 operator.
8613
8614 If the query contains a reference to &$sender_host_name$&, Exim automatically
8615 looks up the host name if it has not already done so. (See section
8616 &<<SECThoslispatnam>>& for comments on finding host names.)
8617
8618 Historical note: prior to release 4.30, Exim would always attempt to find a
8619 host name before running the query, unless the search type was preceded by
8620 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8621 still recognized for query-style lookups, but its presence or absence has no
8622 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8623 See section &<<SECThoslispatsikey>>&.)
8624
8625
8626
8627
8628
8629 .section "Address lists" "SECTaddresslist"
8630 .cindex "list" "address list"
8631 .cindex "address list" "empty item"
8632 .cindex "address list" "patterns"
8633 Address lists contain patterns that are matched against mail addresses. There
8634 is one special case to be considered: the sender address of a bounce message is
8635 always empty. You can test for this by providing an empty item in an address
8636 list. For example, you can set up a router to process bounce messages by
8637 using this option setting:
8638 .code
8639 senders = :
8640 .endd
8641 The presence of the colon creates an empty item. If you do not provide any
8642 data, the list is empty and matches nothing. The empty sender can also be
8643 detected by a regular expression that matches an empty string,
8644 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8645
8646 Non-empty items in an address list can be straightforward email addresses. For
8647 example:
8648 .code
8649 senders = jbc@askone.example : hs@anacreon.example
8650 .endd
8651 A certain amount of wildcarding is permitted. If a pattern contains an @
8652 character, but is not a regular expression and does not begin with a
8653 semicolon-terminated lookup type (described below), the local part of the
8654 subject address is compared with the local part of the pattern, which may start
8655 with an asterisk. If the local parts match, the domain is checked in exactly
8656 the same way as for a pattern in a domain list. For example, the domain can be
8657 wildcarded, refer to a named list, or be a lookup:
8658 .code
8659 deny senders = *@*.spamming.site:\
8660                *@+hostile_domains:\
8661                bozo@partial-lsearch;/list/of/dodgy/sites:\
8662                *@dbm;/bad/domains.db
8663 .endd
8664 .cindex "local part" "starting with !"
8665 .cindex "address list" "local part starting with !"
8666 If a local part that begins with an exclamation mark is required, it has to be
8667 specified using a regular expression, because otherwise the exclamation mark is
8668 treated as a sign of negation, as is standard in lists.
8669
8670 If a non-empty pattern that is not a regular expression or a lookup does not
8671 contain an @ character, it is matched against the domain part of the subject
8672 address. The only two formats that are recognized this way are a literal
8673 domain, or a domain pattern that starts with *. In both these cases, the effect
8674 is the same as if &`*@`& preceded the pattern. For example:
8675 .code
8676 deny senders = enemy.domain : *.enemy.domain
8677 .endd
8678
8679 The following kinds of more complicated address list pattern can match any
8680 address, including the empty address that is characteristic of bounce message
8681 senders:
8682
8683 .ilist
8684 .cindex "regular expressions" "in address list"
8685 .cindex "address list" "regular expression in"
8686 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8687 done against the complete address, with the pattern as the regular expression.
8688 You must take care that backslash and dollar characters are not misinterpreted
8689 as part of the string expansion. The simplest way to do this is to use &`\N`&
8690 to mark that part of the string as non-expandable. For example:
8691 .code
8692 deny senders = \N^.*this.*@example\.com$\N : \
8693                \N^\d{8}.+@spamhaus.example$\N : ...
8694 .endd
8695 The &`\N`& sequences are removed by the expansion, so these items do indeed
8696 start with &"^"& by the time they are being interpreted as address patterns.
8697
8698 .next
8699 .cindex "address list" "lookup for complete address"
8700 Complete addresses can be looked up by using a pattern that starts with a
8701 lookup type terminated by a semicolon, followed by the data for the lookup. For
8702 example:
8703 .code
8704 deny senders = cdb;/etc/blocked.senders : \
8705   mysql;select address from blocked where \
8706   address='${quote_mysql:$sender_address}'
8707 .endd
8708 Both query-style and single-key lookup types can be used. For a single-key
8709 lookup type, Exim uses the complete address as the key. However, empty keys are
8710 not supported for single-key lookups, so a match against the empty address
8711 always fails. This restriction does not apply to query-style lookups.
8712
8713 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8714 cannot be used, and is ignored if specified, with an entry being written to the
8715 panic log.
8716 .cindex "*@ with single-key lookup"
8717 However, you can configure lookup defaults, as described in section
8718 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8719 default. For example, with this lookup:
8720 .code
8721 accept senders = lsearch*@;/some/file
8722 .endd
8723 the file could contains lines like this:
8724 .code
8725 user1@domain1.example
8726 *@domain2.example
8727 .endd
8728 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8729 that are tried is:
8730 .code
8731 nimrod@jaeger.example
8732 *@jaeger.example
8733 *
8734 .endd
8735 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8736 would mean that every address matches, thus rendering the test useless.
8737
8738 &*Warning 2*&: Do not confuse these two kinds of item:
8739 .code
8740 deny recipients = dbm*@;/some/file
8741 deny recipients = *@dbm;/some/file
8742 .endd
8743 The first does a whole address lookup, with defaulting, as just described,
8744 because it starts with a lookup type. The second matches the local part and
8745 domain independently, as described in a bullet point below.
8746 .endlist
8747
8748
8749 The following kinds of address list pattern can match only non-empty addresses.
8750 If the subject address is empty, a match against any of these pattern types
8751 always fails.
8752
8753
8754 .ilist
8755 .cindex "@@ with single-key lookup"
8756 .cindex "address list" "@@ lookup type"
8757 .cindex "address list" "split local part and domain"
8758 If a pattern starts with &"@@"& followed by a single-key lookup item
8759 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8760 split into a local part and a domain. The domain is looked up in the file. If
8761 it is not found, there is no match. If it is found, the data that is looked up
8762 from the file is treated as a colon-separated list of local part patterns, each
8763 of which is matched against the subject local part in turn.
8764
8765 .cindex "asterisk" "in address list"
8766 The lookup may be a partial one, and/or one involving a search for a default
8767 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8768 patterns that are looked up can be regular expressions or begin with &"*"&, or
8769 even be further lookups. They may also be independently negated. For example,
8770 with
8771 .code
8772 deny senders = @@dbm;/etc/reject-by-domain
8773 .endd
8774 the data from which the DBM file is built could contain lines like
8775 .code
8776 baddomain.com:  !postmaster : *
8777 .endd
8778 to reject all senders except &%postmaster%& from that domain.
8779
8780 .cindex "local part" "starting with !"
8781 If a local part that actually begins with an exclamation mark is required, it
8782 has to be specified using a regular expression. In &(lsearch)& files, an entry
8783 may be split over several lines by indenting the second and subsequent lines,
8784 but the separating colon must still be included at line breaks. White space
8785 surrounding the colons is ignored. For example:
8786 .code
8787 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8788   spammer3 : spammer4
8789 .endd
8790 As in all colon-separated lists in Exim, a colon can be included in an item by
8791 doubling.
8792
8793 If the last item in the list starts with a right angle-bracket, the remainder
8794 of the item is taken as a new key to look up in order to obtain a continuation
8795 list of local parts. The new key can be any sequence of characters. Thus one
8796 might have entries like
8797 .code
8798 aol.com: spammer1 : spammer 2 : >*
8799 xyz.com: spammer3 : >*
8800 *:       ^\d{8}$
8801 .endd
8802 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8803 local parts for all domains, in addition to the specific local parts listed for
8804 each domain. Of course, using this feature costs another lookup each time a
8805 chain is followed, but the effort needed to maintain the data is reduced.
8806
8807 .cindex "loop" "in lookups"
8808 It is possible to construct loops using this facility, and in order to catch
8809 them, the chains may be no more than fifty items long.
8810
8811 .next
8812 The @@<&'lookup'&> style of item can also be used with a query-style
8813 lookup, but in this case, the chaining facility is not available. The lookup
8814 can only return a single list of local parts.
8815 .endlist
8816
8817 &*Warning*&: There is an important difference between the address list items
8818 in these two examples:
8819 .code
8820 senders = +my_list
8821 senders = *@+my_list
8822 .endd
8823 In the first one, &`my_list`& is a named address list, whereas in the second
8824 example it is a named domain list.
8825
8826
8827
8828
8829 .section "Case of letters in address lists" "SECTcasletadd"
8830 .cindex "case of local parts"
8831 .cindex "address list" "case forcing"
8832 .cindex "case forcing in address lists"
8833 Domains in email addresses are always handled caselessly, but for local parts
8834 case may be significant on some systems (see &%caseful_local_part%& for how
8835 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8836 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8837 blocking lists should be done in a case-independent manner. Since most address
8838 lists in Exim are used for this kind of control, Exim attempts to do this by
8839 default.
8840
8841 The domain portion of an address is always lowercased before matching it to an
8842 address list. The local part is lowercased by default, and any string
8843 comparisons that take place are done caselessly. This means that the data in
8844 the address list itself, in files included as plain file names, and in any file
8845 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8846 keys in files that are looked up by a search type other than &(lsearch)& (which
8847 works caselessly) must be in lower case, because these lookups are not
8848 case-independent.
8849
8850 .cindex "&`+caseful`&"
8851 To allow for the possibility of caseful address list matching, if an item in
8852 an address list is the string &"+caseful"&, the original case of the local
8853 part is restored for any comparisons that follow, and string comparisons are no
8854 longer case-independent. This does not affect the domain, which remains in
8855 lower case. However, although independent matches on the domain alone are still
8856 performed caselessly, regular expressions that match against an entire address
8857 become case-sensitive after &"+caseful"& has been seen.
8858
8859
8860
8861 .section "Local part lists" "SECTlocparlis"
8862 .cindex "list" "local part list"
8863 .cindex "local part" "list"
8864 Case-sensitivity in local part lists is handled in the same way as for address
8865 lists, as just described. The &"+caseful"& item can be used if required. In a
8866 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8867 set false, the subject is lowercased and the matching is initially
8868 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8869 matching in the local part list, but not elsewhere in the router. If
8870 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8871 option is case-sensitive from the start.
8872
8873 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8874 comments are handled in the same way as address lists &-- they are recognized
8875 only if the # is preceded by white space or the start of the line.
8876 Otherwise, local part lists are matched in the same way as domain lists, except
8877 that the special items that refer to the local host (&`@`&, &`@[]`&,
8878 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8879 Refer to section &<<SECTdomainlist>>& for details of the other available item
8880 types.
8881 .ecindex IIDdohoadli
8882
8883
8884
8885
8886 . ////////////////////////////////////////////////////////////////////////////
8887 . ////////////////////////////////////////////////////////////////////////////
8888
8889 .chapter "String expansions" "CHAPexpand"
8890 .scindex IIDstrexp "expansion" "of strings"
8891 Many strings in Exim's run time configuration are expanded before use. Some of
8892 them are expanded every time they are used; others are expanded only once.
8893
8894 When a string is being expanded it is copied verbatim from left to right except
8895 when a dollar or backslash character is encountered. A dollar specifies the
8896 start of a portion of the string that is interpreted and replaced as described
8897 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8898 escape character, as described in the following section.
8899
8900 Whether a string is expanded depends upon the context.  Usually this is solely
8901 dependent upon the option for which a value is sought; in this documentation,
8902 options for which string expansion is performed are marked with &dagger; after
8903 the data type.  ACL rules always expand strings.  A couple of expansion
8904 conditions do not expand some of the brace-delimited branches, for security
8905 reasons.
8906
8907
8908
8909 .section "Literal text in expanded strings" "SECTlittext"
8910 .cindex "expansion" "including literal text"
8911 An uninterpreted dollar can be included in an expanded string by putting a
8912 backslash in front of it. A backslash can be used to prevent any special
8913 character being treated specially in an expansion, including backslash itself.
8914 If the string appears in quotes in the configuration file, two backslashes are
8915 required because the quotes themselves cause interpretation of backslashes when
8916 the string is read in (see section &<<SECTstrings>>&).
8917
8918 .cindex "expansion" "non-expandable substrings"
8919 A portion of the string can specified as non-expandable by placing it between
8920 two occurrences of &`\N`&. This is particularly useful for protecting regular
8921 expressions, which often contain backslashes and dollar signs. For example:
8922 .code
8923 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8924 .endd
8925 On encountering the first &`\N`&, the expander copies subsequent characters
8926 without interpretation until it reaches the next &`\N`& or the end of the
8927 string.
8928
8929
8930
8931 .section "Character escape sequences in expanded strings" "SECID82"
8932 .cindex "expansion" "escape sequences"
8933 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8934 expanded string is recognized as an escape sequence for the character newline,
8935 carriage return, or tab, respectively. A backslash followed by up to three
8936 octal digits is recognized as an octal encoding for a single character, and a
8937 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8938 encoding.
8939
8940 These escape sequences are also recognized in quoted strings when they are read
8941 in. Their interpretation in expansions as well is useful for unquoted strings,
8942 and for other cases such as looked-up strings that are then expanded.
8943
8944
8945 .section "Testing string expansions" "SECID83"
8946 .cindex "expansion" "testing"
8947 .cindex "testing" "string expansion"
8948 .oindex "&%-be%&"
8949 Many expansions can be tested by calling Exim with the &%-be%& option. This
8950 takes the command arguments, or lines from the standard input if there are no
8951 arguments, runs them through the string expansion code, and writes the results
8952 to the standard output. Variables based on configuration values are set up, but
8953 since no message is being processed, variables such as &$local_part$& have no
8954 value. Nevertheless the &%-be%& option can be useful for checking out file and
8955 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8956 and &%nhash%&.
8957
8958 Exim gives up its root privilege when it is called with the &%-be%& option, and
8959 instead runs under the uid and gid it was called with, to prevent users from
8960 using &%-be%& for reading files to which they do not have access.
8961
8962 .oindex "&%-bem%&"
8963 If you want to test expansions that include variables whose values are taken
8964 from a message, there are two other options that can be used. The &%-bem%&
8965 option is like &%-be%& except that it is followed by a file name. The file is
8966 read as a message before doing the test expansions. For example:
8967 .code
8968 exim -bem /tmp/test.message '$h_subject:'
8969 .endd
8970 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8971 Exim message identifier. For example:
8972 .code
8973 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8974 .endd
8975 This loads the message from Exim's spool before doing the test expansions, and
8976 is therefore restricted to admin users.
8977
8978
8979 .section "Forced expansion failure" "SECTforexpfai"
8980 .cindex "expansion" "forced failure"
8981 A number of expansions that are described in the following section have
8982 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8983 (which are sometimes called &"curly brackets"&). Which of the two strings is
8984 used depends on some condition that is evaluated as part of the expansion. If,
8985 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8986 the entire string expansion fails in a way that can be detected by the code
8987 that requested the expansion. This is called &"forced expansion failure"&, and
8988 its consequences depend on the circumstances. In some cases it is no different
8989 from any other expansion failure, but in others a different action may be
8990 taken. Such variations are mentioned in the documentation of the option that is
8991 being expanded.
8992
8993
8994
8995
8996 .section "Expansion items" "SECTexpansionitems"
8997 The following items are recognized in expanded strings. White space may be used
8998 between sub-items that are keywords or substrings enclosed in braces inside an
8999 outer set of braces, to improve readability. &*Warning*&: Within braces,
9000 white space is significant.
9001
9002 .vlist
9003 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9004 .cindex "expansion" "variables"
9005 Substitute the contents of the named variable, for example:
9006 .code
9007 $local_part
9008 ${domain}
9009 .endd
9010 The second form can be used to separate the name from subsequent alphanumeric
9011 characters. This form (using braces) is available only for variables; it does
9012 &'not'& apply to message headers. The names of the variables are given in
9013 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9014 given, the expansion fails.
9015
9016 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9017 .cindex "expansion" "operators"
9018 The string is first itself expanded, and then the operation specified by
9019 <&'op'&> is applied to it. For example:
9020 .code
9021 ${lc:$local_part}
9022 .endd
9023 The string starts with the first character after the colon, which may be
9024 leading white space. A list of operators is given in section &<<SECTexpop>>&
9025 below. The operator notation is used for simple expansion items that have just
9026 one argument, because it reduces the number of braces and therefore makes the
9027 string easier to understand.
9028
9029 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9030 This item inserts &"basic"& header lines. It is described with the &%header%&
9031 expansion item below.
9032
9033
9034 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9035 .cindex "expansion" "calling an acl"
9036 .cindex "&%acl%&" "call from expansion"
9037 The name and zero to nine argument strings are first expanded separately.  The expanded
9038 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9039 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9040 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9041 and may use the variables; if another acl expansion is used the values
9042 are restored after it returns.  If the ACL sets
9043 a value using a "message =" modifier and returns accept or deny, the value becomes
9044 the result of the expansion.
9045 If no message is set and the ACL returns accept or deny
9046 the expansion result is an empty string.
9047 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9048
9049
9050 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9051        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9052 .cindex "expansion" "extracting cerificate fields"
9053 .cindex "&%certextract%&" "certificate fields"
9054 .cindex "certificate" "extracting fields"
9055 The <&'certificate'&> must be a variable of type certificate.
9056 The field name is expanded and used to retrieve the relevant field from
9057 the certificate.  Supported fields are:
9058 .display
9059 &`version        `&
9060 &`serial_number  `&
9061 &`subject        `& RFC4514 DN
9062 &`issuer         `& RFC4514 DN
9063 &`notbefore      `& time
9064 &`notafter       `& time
9065 &`sig_algorithm  `&
9066 &`signature      `&
9067 &`subj_altname   `& tagged list
9068 &`ocsp_uri       `& list
9069 &`crl_uri        `& list
9070 .endd
9071 If the field is found,
9072 <&'string2'&> is expanded, and replaces the whole item;
9073 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9074 variable &$value$& contains the value that has been extracted. Afterwards, it
9075 is restored to any previous value it might have had.
9076
9077 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9078 key is not found. If {<&'string2'&>} is also omitted, the value that was
9079 extracted is used.
9080
9081 Some field names take optional modifiers, appended and separated by commas.
9082
9083 The field selectors marked as "RFC4514" above
9084 output a Distinguished Name string which is
9085 not quite
9086 parseable by Exim as a comma-separated tagged list
9087 (the exceptions being elements containing commas).
9088 RDN elements of a single type may be selected by
9089 a modifier of the type label; if so the expansion
9090 result is a list (newline-separated by default).
9091 The separator may be changed by another modifier of
9092 a right angle-bracket followed immediately by the new separator.
9093 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9094
9095 The field selectors marked as "time" above
9096 take an optional modifier of "int"
9097 for which the result is the number of seconds since epoch.
9098 Otherwise the result is a human-readable string
9099 in the timezone selected by the main "timezone" option.
9100
9101 The field selectors marked as "list" above return a list,
9102 newline-separated by default,
9103 (embedded separator characters in elements are doubled).
9104 The separator may be changed by a modifier of
9105 a right angle-bracket followed immediately by the new separator.
9106
9107 The field selectors marked as "tagged" above
9108 prefix each list element with a type string and an equals sign.
9109 Elements of only one type may be selected by a modifier
9110 which is one of "dns", "uri" or "mail";
9111 if so the element tags are omitted.
9112
9113 If not otherwise noted field values are presented in human-readable form.
9114
9115 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9116        {*&<&'arg'&>&*}...}*&"
9117 .cindex &%dlfunc%&
9118 This expansion dynamically loads and then calls a locally-written C function.
9119 This functionality is available only if Exim is compiled with
9120 .code
9121 EXPAND_DLFUNC=yes
9122 .endd
9123 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9124 object so that it doesn't reload the same object file in the same Exim process
9125 (but of course Exim does start new processes frequently).
9126
9127 There may be from zero to eight arguments to the function. When compiling
9128 a local function that is to be called in this way, &_local_scan.h_& should be
9129 included. The Exim variables and functions that are defined by that API
9130 are also available for dynamically loaded functions. The function itself
9131 must have the following type:
9132 .code
9133 int dlfunction(uschar **yield, int argc, uschar *argv[])
9134 .endd
9135 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9136 function should return one of the following values:
9137
9138 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9139 into the expanded string that is being built.
9140
9141 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9142 from &'yield'&, if it is set.
9143
9144 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9145 taken from &'yield'& if it is set.
9146
9147 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9148
9149 When compiling a function that is to be used in this way with gcc,
9150 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9151 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9152
9153
9154 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9155 .cindex "expansion" "extracting value from environment"
9156 .cindex "environment" "values from"
9157 The key is first expanded separately, and leading and trailing white space
9158 removed.
9159 This is then searched for as a name in the environment.
9160 If a variable is found then its value is placed in &$value$&
9161 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9162
9163 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9164 appear, for example:
9165 .code
9166 ${env{USER}{$value} fail }
9167 .endd
9168 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9169 {<&'string1'&>} must be present for &"fail"& to be recognized.
9170
9171 If {<&'string2'&>} is omitted an empty string is substituted on
9172 search failure.
9173 If {<&'string1'&>} is omitted the search result is substituted on
9174 search success.
9175
9176 The environment is adjusted by the &%keep_environment%& and
9177 &%add_environment%& main section options.
9178
9179
9180 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9181        {*&<&'string3'&>&*}}*&"
9182 .cindex "expansion" "extracting substrings by key"
9183 .cindex "&%extract%&" "substrings by key"
9184 The key and <&'string1'&> are first expanded separately. Leading and trailing
9185 white space is removed from the key (but not from any of the strings). The key
9186 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9187 form:
9188 .display
9189 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9190 .endd
9191 .vindex "&$value$&"
9192 where the equals signs and spaces (but not both) are optional. If any of the
9193 values contain white space, they must be enclosed in double quotes, and any
9194 values that are enclosed in double quotes are subject to escape processing as
9195 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9196 for the value that corresponds to the key. The search is case-insensitive. If
9197 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9198 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9199 variable &$value$& contains the value that has been extracted. Afterwards, it
9200 is restored to any previous value it might have had.
9201
9202 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9203 key is not found. If {<&'string2'&>} is also omitted, the value that was
9204 extracted is used. Thus, for example, these two expansions are identical, and
9205 yield &"2001"&:
9206 .code
9207 ${extract{gid}{uid=1984 gid=2001}}
9208 ${extract{gid}{uid=1984 gid=2001}{$value}}
9209 .endd
9210 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9211 appear, for example:
9212 .code
9213 ${extract{Z}{A=... B=...}{$value} fail }
9214 .endd
9215 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9216 {<&'string2'&>} must be present for &"fail"& to be recognized.
9217
9218
9219 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9220         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9221 .cindex "expansion" "extracting substrings by number"
9222 .cindex "&%extract%&" "substrings by number"
9223 The <&'number'&> argument must consist entirely of decimal digits,
9224 apart from leading and trailing white space, which is ignored.
9225 This is what distinguishes this form of &%extract%& from the previous kind. It
9226 behaves in the same way, except that, instead of extracting a named field, it
9227 extracts from <&'string1'&> the field whose number is given as the first
9228 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9229 <&'string3'&> as before.
9230
9231 The fields in the string are separated by any one of the characters in the
9232 separator string. These may include space or tab characters.
9233 The first field is numbered one. If the number is negative, the fields are
9234 counted from the end of the string, with the rightmost one numbered -1. If the
9235 number given is zero, the entire string is returned. If the modulus of the
9236 number is greater than the number of fields in the string, the result is the
9237 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9238 provided. For example:
9239 .code
9240 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9241 .endd
9242 yields &"42"&, and
9243 .code
9244 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9245 .endd
9246 yields &"99"&. Two successive separators mean that the field between them is
9247 empty (for example, the fifth field above).
9248
9249
9250 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9251 .cindex "list" "selecting by condition"
9252 .cindex "expansion" "selecting from list by condition"
9253 .vindex "&$item$&"
9254 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9255 default, but the separator can be changed in the usual way. For each item
9256 in this list, its value is place in &$item$&, and then the condition is
9257 evaluated. If the condition is true, &$item$& is added to the output as an
9258 item in a new list; if the condition is false, the item is discarded. The
9259 separator used for the output list is the same as the one used for the
9260 input, but a separator setting is not included in the output. For example:
9261 .code
9262 ${filter{a:b:c}{!eq{$item}{b}}
9263 .endd
9264 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9265 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9266
9267
9268 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9269 .cindex "hash function" "textual"
9270 .cindex "expansion" "textual hash"
9271 This is a textual hashing function, and was the first to be implemented in
9272 early versions of Exim. In current releases, there are other hashing functions
9273 (numeric, MD5, and SHA-1), which are described below.
9274
9275 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9276 <&'n'&>. If you are using fixed values for these numbers, that is, if
9277 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9278 use the simpler operator notation that avoids some of the braces:
9279 .code
9280 ${hash_<n>_<m>:<string>}
9281 .endd
9282 The second number is optional (in both notations). If <&'n'&> is greater than
9283 or equal to the length of the string, the expansion item returns the string.
9284 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9285 function to the string. The new string consists of characters taken from the
9286 first <&'m'&> characters of the string
9287 .code
9288 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9289 .endd
9290 If <&'m'&> is not present the value 26 is used, so that only lower case
9291 letters appear. For example:
9292 .display
9293 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9294 &`$hash{5}{monty}}           `&   yields  &`monty`&
9295 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9296 .endd
9297
9298 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9299         &*$h_*&<&'header&~name'&>&*:*&" &&&
9300        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9301         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9302        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9303         &*$rh_*&<&'header&~name'&>&*:*&"
9304 .cindex "expansion" "header insertion"
9305 .vindex "&$header_$&"
9306 .vindex "&$bheader_$&"
9307 .vindex "&$rheader_$&"
9308 .cindex "header lines" "in expansion strings"
9309 .cindex "header lines" "character sets"
9310 .cindex "header lines" "decoding"
9311 Substitute the contents of the named message header line, for example
9312 .code
9313 $header_reply-to:
9314 .endd
9315 The newline that terminates a header line is not included in the expansion, but
9316 internal newlines (caused by splitting the header line over several physical
9317 lines) may be present.
9318
9319 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9320 the data in the header line is interpreted.
9321
9322 .ilist
9323 .cindex "white space" "in header lines"
9324 &%rheader%& gives the original &"raw"& content of the header line, with no
9325 processing at all, and without the removal of leading and trailing white space.
9326
9327 .next
9328 .cindex "base64 encoding" "in header lines"
9329 &%bheader%& removes leading and trailing white space, and then decodes base64
9330 or quoted-printable MIME &"words"& within the header text, but does no
9331 character set translation. If decoding of what looks superficially like a MIME
9332 &"word"& fails, the raw string is returned. If decoding
9333 .cindex "binary zero" "in header line"
9334 produces a binary zero character, it is replaced by a question mark &-- this is
9335 what Exim does for binary zeros that are actually received in header lines.
9336
9337 .next
9338 &%header%& tries to translate the string as decoded by &%bheader%& to a
9339 standard character set. This is an attempt to produce the same string as would
9340 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9341 returned. Translation is attempted only on operating systems that support the
9342 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9343 a system Makefile or in &_Local/Makefile_&.
9344 .endlist ilist
9345
9346 In a filter file, the target character set for &%header%& can be specified by a
9347 command of the following form:
9348 .code
9349 headers charset "UTF-8"
9350 .endd
9351 This command affects all references to &$h_$& (or &$header_$&) expansions in
9352 subsequently obeyed filter commands. In the absence of this command, the target
9353 character set in a filter is taken from the setting of the &%headers_charset%&
9354 option in the runtime configuration. The value of this option defaults to the
9355 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9356 ISO-8859-1.
9357
9358 Header names follow the syntax of RFC 2822, which states that they may contain
9359 any printing characters except space and colon. Consequently, curly brackets
9360 &'do not'& terminate header names, and should not be used to enclose them as
9361 if they were variables. Attempting to do so causes a syntax error.
9362
9363 Only header lines that are common to all copies of a message are visible to
9364 this mechanism. These are the original header lines that are received with the
9365 message, and any that are added by an ACL statement or by a system
9366 filter. Header lines that are added to a particular copy of a message by a
9367 router or transport are not accessible.
9368
9369 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9370 before the DATA ACL, because the header structure is not set up until the
9371 message is received. Header lines that are added in a RCPT ACL (for example)
9372 are saved until the message's incoming header lines are available, at which
9373 point they are added. When a DATA ACL is running, however, header lines added
9374 by earlier ACLs are visible.
9375
9376 Upper case and lower case letters are synonymous in header names. If the
9377 following character is white space, the terminating colon may be omitted, but
9378 this is not recommended, because you may then forget it when it is needed. When
9379 white space terminates the header name, this white space is included in the
9380 expanded string.  If the message does not contain the given header, the
9381 expansion item is replaced by an empty string. (See the &%def%& condition in
9382 section &<<SECTexpcond>>& for a means of testing for the existence of a
9383 header.)
9384
9385 If there is more than one header with the same name, they are all concatenated
9386 to form the substitution string, up to a maximum length of 64K. Unless
9387 &%rheader%& is being used, leading and trailing white space is removed from
9388 each header before concatenation, and a completely empty header is ignored. A
9389 newline character is then inserted between non-empty headers, but there is no
9390 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9391 those headers that contain lists of addresses, a comma is also inserted at the
9392 junctions between headers. This does not happen for the &%rheader%& expansion.
9393
9394
9395 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9396 .cindex "expansion" "hmac hashing"
9397 .cindex &%hmac%&
9398 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9399 shared secret and some text into a message authentication code, as specified in
9400 RFC 2104. This differs from &`${md5:secret_text...}`& or
9401 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9402 cryptographic hash, allowing for authentication that is not possible with MD5
9403 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9404 present. For example:
9405 .code
9406 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9407 .endd
9408 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9409 produces:
9410 .code
9411 dd97e3ba5d1a61b5006108f8c8252953
9412 .endd
9413 As an example of how this might be used, you might put in the main part of
9414 an Exim configuration:
9415 .code
9416 SPAMSCAN_SECRET=cohgheeLei2thahw
9417 .endd
9418 In a router or a transport you could then have:
9419 .code
9420 headers_add = \
9421   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9422   ${hmac{md5}{SPAMSCAN_SECRET}\
9423   {${primary_hostname},${message_exim_id},$h_message-id:}}
9424 .endd
9425 Then given a message, you can check where it was scanned by looking at the
9426 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9427 this header line is authentic by recomputing the authentication code from the
9428 host name, message ID and the &'Message-id:'& header line. This can be done
9429 using Exim's &%-be%& option, or by other means, for example by using the
9430 &'hmac_md5_hex()'& function in Perl.
9431
9432
9433 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9434 .cindex "expansion" "conditional"
9435 .cindex "&%if%&, expansion item"
9436 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9437 item; otherwise <&'string2'&> is used. The available conditions are described
9438 in section &<<SECTexpcond>>& below. For example:
9439 .code
9440 ${if eq {$local_part}{postmaster} {yes}{no} }
9441 .endd
9442 The second string need not be present; if it is not and the condition is not
9443 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9444 be present instead of the second string (without any curly brackets). In this
9445 case, the expansion is forced to fail if the condition is not true (see section
9446 &<<SECTforexpfai>>&).
9447
9448 If both strings are omitted, the result is the string &`true`& if the condition
9449 is true, and the empty string if the condition is false. This makes it less
9450 cumbersome to write custom ACL and router conditions. For example, instead of
9451 .code
9452 condition = ${if >{$acl_m4}{3}{true}{false}}
9453 .endd
9454 you can use
9455 .code
9456 condition = ${if >{$acl_m4}{3}}
9457 .endd
9458
9459
9460
9461 .new
9462 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9463 .cindex expansion "imap folder"
9464 .cindex "&%imapfolder%& expansion item"
9465 This item converts a (possibly multilevel, or with non-ASCII characters)
9466 folder specification to a Maildir name for filesystem use.
9467 For information on internationalisation support see &<<SECTi18nMDA>>&.
9468 .wen
9469
9470
9471
9472 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9473 .cindex "expansion" "string truncation"
9474 .cindex "&%length%& expansion item"
9475 The &%length%& item is used to extract the initial portion of a string. Both
9476 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9477 you are using a fixed value for the number, that is, if <&'string1'&> does not
9478 change when expanded, you can use the simpler operator notation that avoids
9479 some of the braces:
9480 .code
9481 ${length_<n>:<string>}
9482 .endd
9483 The result of this item is either the first <&'n'&> characters or the whole
9484 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9485 &%strlen%&, which gives the length of a string.
9486
9487
9488 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9489         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9490 .cindex "expansion" "extracting list elements by number"
9491 .cindex "&%listextract%&" "extract list elements by number"
9492 .cindex "list" "extracting elements by number"
9493 The <&'number'&> argument must consist entirely of decimal digits,
9494 apart from an optional leading minus,
9495 and leading and trailing white space (which is ignored).
9496
9497 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9498 default, but the separator can be changed in the usual way.
9499
9500 The first field of the list is numbered one.
9501 If the number is negative, the fields are
9502 counted from the end of the list, with the rightmost one numbered -1.
9503 The numbered element of the list is extracted and placed in &$value$&,
9504 then <&'string2'&> is expanded as the result.
9505
9506 If the modulus of the
9507 number is zero or greater than the number of fields in the string,
9508 the result is the expansion of <&'string3'&>.
9509
9510 For example:
9511 .code
9512 ${listextract{2}{x:42:99}}
9513 .endd
9514 yields &"42"&, and
9515 .code
9516 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9517 .endd
9518 yields &"result: 42"&.
9519
9520 If {<&'string3'&>} is omitted, an empty string is used for string3.
9521 If {<&'string2'&>} is also omitted, the value that was
9522 extracted is used.
9523 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9524
9525
9526 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9527         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9528 This is the first of one of two different types of lookup item, which are both
9529 described in the next item.
9530
9531 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9532         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9533 .cindex "expansion" "lookup in"
9534 .cindex "file" "lookups"
9535 .cindex "lookup" "in expanded string"
9536 The two forms of lookup item specify data lookups in files and databases, as
9537 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9538 lookups, and the second is used for query-style lookups. The <&'key'&>,
9539 <&'file'&>, and <&'query'&> strings are expanded before use.
9540
9541 If there is any white space in a lookup item which is part of a filter command,
9542 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9543 other place where white space is significant, the lookup item must be enclosed
9544 in double quotes. The use of data lookups in users' filter files may be locked
9545 out by the system administrator.
9546
9547 .vindex "&$value$&"
9548 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9549 During its expansion, the variable &$value$& contains the data returned by the
9550 lookup. Afterwards it reverts to the value it had previously (at the outer
9551 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9552 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9553 string on failure. If <&'string2'&> is provided, it can itself be a nested
9554 lookup, thus providing a mechanism for looking up a default value when the
9555 original lookup fails.
9556
9557 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9558 data for the outer lookup while the parameters of the second lookup are
9559 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9560 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9561 appear, and in this case, if the lookup fails, the entire expansion is forced
9562 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9563 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9564 successful lookup, and nothing in the case of failure.
9565
9566 For single-key lookups, the string &"partial"& is permitted to precede the
9567 search type in order to do partial matching, and * or *@ may follow a search
9568 type to request default lookups if the key does not match (see sections
9569 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9570
9571 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9572 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9573 and non-wild parts of the key during the expansion of the replacement text.
9574 They return to their previous values at the end of the lookup item.
9575
9576 This example looks up the postmaster alias in the conventional alias file:
9577 .code
9578 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9579 .endd
9580 This example uses NIS+ to look up the full name of the user corresponding to
9581 the local part of an address, forcing the expansion to fail if it is not found:
9582 .code
9583 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9584   {$value}fail}
9585 .endd
9586
9587
9588 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9589 .cindex "expansion" "list creation"
9590 .vindex "&$item$&"
9591 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9592 default, but the separator can be changed in the usual way. For each item
9593 in this list, its value is place in &$item$&, and then <&'string2'&> is
9594 expanded and added to the output as an item in a new list. The separator used
9595 for the output list is the same as the one used for the input, but a separator
9596 setting is not included in the output. For example:
9597 .code
9598 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9599 .endd
9600 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9601 value of &$item$& is restored to what it was before. See also the &*filter*&
9602 and &*reduce*& expansion items.
9603
9604 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9605 .cindex "expansion" "numeric hash"
9606 .cindex "hash function" "numeric"
9607 The three strings are expanded; the first two must yield numbers. Call them
9608 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9609 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9610 can use the simpler operator notation that avoids some of the braces:
9611 .code
9612 ${nhash_<n>_<m>:<string>}
9613 .endd
9614 The second number is optional (in both notations). If there is only one number,
9615 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9616 processed by a div/mod hash function that returns two numbers, separated by a
9617 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9618 example,
9619 .code
9620 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9621 .endd
9622 returns the string &"6/33"&.
9623
9624
9625
9626 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9627 .cindex "Perl" "use in expanded string"
9628 .cindex "expansion" "calling Perl from"
9629 This item is available only if Exim has been built to include an embedded Perl
9630 interpreter. The subroutine name and the arguments are first separately
9631 expanded, and then the Perl subroutine is called with those arguments. No
9632 additional arguments need be given; the maximum number permitted, including the
9633 name of the subroutine, is nine.
9634
9635 The return value of the subroutine is inserted into the expanded string, unless
9636 the return value is &%undef%&. In that case, the expansion fails in the same
9637 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9638 Whatever you return is evaluated in a scalar context. For example, if you
9639 return the name of a Perl vector, the return value is the size of the vector,
9640 not its contents.
9641
9642 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9643 with the error message that was passed to &%die%&. More details of the embedded
9644 Perl facility are given in chapter &<<CHAPperl>>&.
9645
9646 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9647 out the use of this expansion item in filter files.
9648
9649
9650 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9651 .cindex "&%prvs%& expansion item"
9652 The first argument is a complete email address and the second is secret
9653 keystring. The third argument, specifying a key number, is optional. If absent,
9654 it defaults to 0. The result of the expansion is a prvs-signed email address,
9655 to be typically used with the &%return_path%& option on an &(smtp)& transport
9656 as part of a bounce address tag validation (BATV) scheme. For more discussion
9657 and an example, see section &<<SECTverifyPRVS>>&.
9658
9659 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9660         {*&<&'string'&>&*}}*&"
9661 .cindex "&%prvscheck%& expansion item"
9662 This expansion item is the complement of the &%prvs%& item. It is used for
9663 checking prvs-signed addresses. If the expansion of the first argument does not
9664 yield a syntactically valid prvs-signed address, the whole item expands to the
9665 empty string. When the first argument does expand to a syntactically valid
9666 prvs-signed address, the second argument is expanded, with the prvs-decoded
9667 version of the address and the key number extracted from the address in the
9668 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9669
9670 These two variables can be used in the expansion of the second argument to
9671 retrieve the secret. The validity of the prvs-signed address is then checked
9672 against the secret. The result is stored in the variable &$prvscheck_result$&,
9673 which is empty for failure or &"1"& for success.
9674
9675 The third argument is optional; if it is missing, it defaults to an empty
9676 string. This argument is now expanded. If the result is an empty string, the
9677 result of the expansion is the decoded version of the address. This is the case
9678 whether or not the signature was valid. Otherwise, the result of the expansion
9679 is the expansion of the third argument.
9680
9681 All three variables can be used in the expansion of the third argument.
9682 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9683 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9684
9685 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9686 .cindex "expansion" "inserting an entire file"
9687 .cindex "file" "inserting into expansion"
9688 .cindex "&%readfile%& expansion item"
9689 The file name and end-of-line string are first expanded separately. The file is
9690 then read, and its contents replace the entire item. All newline characters in
9691 the file are replaced by the end-of-line string if it is present. Otherwise,
9692 newlines are left in the string.
9693 String expansion is not applied to the contents of the file. If you want this,
9694 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9695 the string expansion fails.
9696
9697 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9698 locks out the use of this expansion item in filter files.
9699
9700
9701
9702 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9703         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9704 .cindex "expansion" "inserting from a socket"
9705 .cindex "socket, use of in expansion"
9706 .cindex "&%readsocket%& expansion item"
9707 This item inserts data from a Unix domain or TCP socket into the expanded
9708 string. The minimal way of using it uses just two arguments, as in these
9709 examples:
9710 .code
9711 ${readsocket{/socket/name}{request string}}
9712 ${readsocket{inet:some.host:1234}{request string}}
9713 .endd
9714 For a Unix domain socket, the first substring must be the path to the socket.
9715 For an Internet socket, the first substring must contain &`inet:`& followed by
9716 a host name or IP address, followed by a colon and a port, which can be a
9717 number or the name of a TCP port in &_/etc/services_&. An IP address may
9718 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9719 example:
9720 .code
9721 ${readsocket{inet:[::1]:1234}{request string}}
9722 .endd
9723 Only a single host name may be given, but if looking it up yields more than
9724 one IP address, they are each tried in turn until a connection is made. For
9725 both kinds of socket, Exim makes a connection, writes the request string
9726 unless it is an empty string; and no terminating NUL is ever sent)
9727 and reads from the socket until an end-of-file
9728 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9729 extend what can be done. Firstly, you can vary the timeout. For example:
9730 .code
9731 ${readsocket{/socket/name}{request string}{3s}}
9732 .endd
9733 A fourth argument allows you to change any newlines that are in the data
9734 that is read, in the same way as for &%readfile%& (see above). This example
9735 turns them into spaces:
9736 .code
9737 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9738 .endd
9739 As with all expansions, the substrings are expanded before the processing
9740 happens. Errors in these sub-expansions cause the expansion to fail. In
9741 addition, the following errors can occur:
9742
9743 .ilist
9744 Failure to create a socket file descriptor;
9745 .next
9746 Failure to connect the socket;
9747 .next
9748 Failure to write the request string;
9749 .next
9750 Timeout on reading from the socket.
9751 .endlist
9752
9753 By default, any of these errors causes the expansion to fail. However, if
9754 you supply a fifth substring, it is expanded and used when any of the above
9755 errors occurs. For example:
9756 .code
9757 ${readsocket{/socket/name}{request string}{3s}{\n}\
9758   {socket failure}}
9759 .endd
9760 You can test for the existence of a Unix domain socket by wrapping this
9761 expansion in &`${if exists`&, but there is a race condition between that test
9762 and the actual opening of the socket, so it is safer to use the fifth argument
9763 if you want to be absolutely sure of avoiding an expansion error for a
9764 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9765
9766 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9767 locks out the use of this expansion item in filter files.
9768
9769
9770 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9771 .cindex "expansion" "reducing a list to a scalar"
9772 .cindex "list" "reducing to a scalar"
9773 .vindex "&$value$&"
9774 .vindex "&$item$&"
9775 This operation reduces a list to a single, scalar string. After expansion,
9776 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9777 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9778 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9779 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9780 them. The result of that expansion is assigned to &$value$& before the next
9781 iteration. When the end of the list is reached, the final value of &$value$& is
9782 added to the expansion output. The &*reduce*& expansion item can be used in a
9783 number of ways. For example, to add up a list of numbers:
9784 .code
9785 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9786 .endd
9787 The result of that expansion would be &`6`&. The maximum of a list of numbers
9788 can be found:
9789 .code
9790 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9791 .endd
9792 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9793 restored to what they were before. See also the &*filter*& and &*map*&
9794 expansion items.
9795
9796 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9797 This item inserts &"raw"& header lines. It is described with the &%header%&
9798 expansion item above.
9799
9800 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9801         {*&<&'string2'&>&*}}*&"
9802 .cindex "expansion" "running a command"
9803 .cindex "&%run%& expansion item"
9804 The command and its arguments are first expanded as one string. The string is
9805 split apart into individual arguments by spaces, and then the command is run
9806 in a separate process, but under the same uid and gid.  As in other command
9807 executions from Exim, a shell is not used by default. If the command requires
9808 a shell, you must explicitly code it.
9809
9810 Since the arguments are split by spaces, when there is a variable expansion
9811 which has an empty result, it will cause the situation that the argument will
9812 simply be omitted when the program is actually executed by Exim. If the
9813 script/program requires a specific number of arguments and the expanded
9814 variable could possibly result in this empty expansion, the variable must be
9815 quoted. This is more difficult if the expanded variable itself could result
9816 in a string containing quotes, because it would interfere with the quotes
9817 around the command arguments. A possible guard against this is to wrap the
9818 variable in the &%sg%& operator to change any quote marks to some other
9819 character.
9820
9821 The standard input for the command exists, but is empty. The standard output
9822 and standard error are set to the same file descriptor.
9823 .cindex "return code" "from &%run%& expansion"
9824 .vindex "&$value$&"
9825 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9826 and replaces the entire item; during this expansion, the standard output/error
9827 from the command is in the variable &$value$&. If the command fails,
9828 <&'string2'&>, if present, is expanded and used. Once again, during the
9829 expansion, the standard output/error from the command is in the variable
9830 &$value$&.
9831
9832 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9833 can be the word &"fail"& (not in braces) to force expansion failure if the
9834 command does not succeed. If both strings are omitted, the result is contents
9835 of the standard output/error on success, and nothing on failure.
9836
9837 .vindex "&$run_in_acl$&"
9838 The standard output/error of the command is put in the variable &$value$&.
9839 In this ACL example, the output of a command is logged for the admin to
9840 troubleshoot:
9841 .code
9842 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9843       log_message  = Output of id: $value
9844 .endd
9845 If the command requires shell idioms, such as the > redirect operator, the
9846 shell must be invoked directly, such as with:
9847 .code
9848 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9849 .endd
9850
9851 .vindex "&$runrc$&"
9852 The return code from the command is put in the variable &$runrc$&, and this
9853 remains set afterwards, so in a filter file you can do things like this:
9854 .code
9855 if "${run{x y z}{}}$runrc" is 1 then ...
9856   elif $runrc is 2 then ...
9857   ...
9858 endif
9859 .endd
9860 If execution of the command fails (for example, the command does not exist),
9861 the return code is 127 &-- the same code that shells use for non-existent
9862 commands.
9863
9864 &*Warning*&: In a router or transport, you cannot assume the order in which
9865 option values are expanded, except for those preconditions whose order of
9866 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9867 by the expansion of one option, and use it in another.
9868
9869 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9870 out the use of this expansion item in filter files.
9871
9872
9873 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9874 .cindex "expansion" "string substitution"
9875 .cindex "&%sg%& expansion item"
9876 This item works like Perl's substitution operator (s) with the global (/g)
9877 option; hence its name. However, unlike the Perl equivalent, Exim does not
9878 modify the subject string; instead it returns the modified string for insertion
9879 into the overall expansion. The item takes three arguments: the subject string,
9880 a regular expression, and a substitution string. For example:
9881 .code
9882 ${sg{abcdefabcdef}{abc}{xyz}}
9883 .endd
9884 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9885 if any $ or \ characters are required in the regular expression or in the
9886 substitution string, they have to be escaped. For example:
9887 .code
9888 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9889 .endd
9890 yields &"defabc"&, and
9891 .code
9892 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9893 .endd
9894 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9895 the regular expression from string expansion.
9896
9897
9898
9899 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9900 .cindex sorting "a list"
9901 .cindex list sorting
9902 .cindex expansion "list sorting"
9903 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9904 default, but the separator can be changed in the usual way.
9905 The <&'comparator'&> argument is interpreted as the operator
9906 of a two-argument expansion condition.
9907 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9908 The comparison should return true when applied to two values
9909 if the first value should sort before the second value.
9910 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9911 the element being placed in &$item$&,
9912 to give values for comparison.
9913
9914 The item result is a sorted list,
9915 with the original list separator,
9916 of the list elements (in full) of the original.
9917
9918 Examples:
9919 .code
9920 ${sort{3:2:1:4}{<}{$item}}
9921 .endd
9922 sorts a list of numbers, and
9923 .code
9924 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9925 .endd
9926 will sort an MX lookup into priority order.
9927
9928
9929 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9930 .cindex "&%substr%& expansion item"
9931 .cindex "substring extraction"
9932 .cindex "expansion" "substring extraction"
9933 The three strings are expanded; the first two must yield numbers. Call them
9934 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9935 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9936 can use the simpler operator notation that avoids some of the braces:
9937 .code
9938 ${substr_<n>_<m>:<string>}
9939 .endd
9940 The second number is optional (in both notations).
9941 If it is absent in the simpler format, the preceding underscore must also be
9942 omitted.
9943
9944 The &%substr%& item can be used to extract more general substrings than
9945 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9946 length required. For example
9947 .code
9948 ${substr{3}{2}{$local_part}}
9949 .endd
9950 If the starting offset is greater than the string length the result is the
9951 null string; if the length plus starting offset is greater than the string
9952 length, the result is the right-hand part of the string, starting from the
9953 given offset. The first character in the string has offset zero.
9954
9955 The &%substr%& expansion item can take negative offset values to count
9956 from the right-hand end of its operand. The last character is offset -1, the
9957 second-last is offset -2, and so on. Thus, for example,
9958 .code
9959 ${substr{-5}{2}{1234567}}
9960 .endd
9961 yields &"34"&. If the absolute value of a negative offset is greater than the
9962 length of the string, the substring starts at the beginning of the string, and
9963 the length is reduced by the amount of overshoot. Thus, for example,
9964 .code
9965 ${substr{-5}{2}{12}}
9966 .endd
9967 yields an empty string, but
9968 .code
9969 ${substr{-3}{2}{12}}
9970 .endd
9971 yields &"1"&.
9972
9973 When the second number is omitted from &%substr%&, the remainder of the string
9974 is taken if the offset is positive. If it is negative, all characters in the
9975 string preceding the offset point are taken. For example, an offset of -1 and
9976 no length, as in these semantically identical examples:
9977 .code
9978 ${substr_-1:abcde}
9979 ${substr{-1}{abcde}}
9980 .endd
9981 yields all but the last character of the string, that is, &"abcd"&.
9982
9983
9984
9985 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9986         {*&<&'replacements'&>&*}}*&"
9987 .cindex "expansion" "character translation"
9988 .cindex "&%tr%& expansion item"
9989 This item does single-character translation on its subject string. The second
9990 argument is a list of characters to be translated in the subject string. Each
9991 matching character is replaced by the corresponding character from the
9992 replacement list. For example
9993 .code
9994 ${tr{abcdea}{ac}{13}}
9995 .endd
9996 yields &`1b3de1`&. If there are duplicates in the second character string, the
9997 last occurrence is used. If the third string is shorter than the second, its
9998 last character is replicated. However, if it is empty, no translation takes
9999 place.
10000 .endlist
10001
10002
10003
10004 .section "Expansion operators" "SECTexpop"
10005 .cindex "expansion" "operators"
10006 For expansion items that perform transformations on a single argument string,
10007 the &"operator"& notation is used because it is simpler and uses fewer braces.
10008 The substring is first expanded before the operation is applied to it. The
10009 following operations can be performed:
10010
10011 .vlist
10012 .vitem &*${address:*&<&'string'&>&*}*&
10013 .cindex "expansion" "RFC 2822 address handling"
10014 .cindex "&%address%& expansion item"
10015 The string is interpreted as an RFC 2822 address, as it might appear in a
10016 header line, and the effective address is extracted from it. If the string does
10017 not parse successfully, the result is empty.
10018
10019
10020 .vitem &*${addresses:*&<&'string'&>&*}*&
10021 .cindex "expansion" "RFC 2822 address handling"
10022 .cindex "&%addresses%& expansion item"
10023 The string (after expansion) is interpreted as a list of addresses in RFC
10024 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10025 operative address (&'local-part@domain'&) is extracted from each item, and the
10026 result of the expansion is a colon-separated list, with appropriate
10027 doubling of colons should any happen to be present in the email addresses.
10028 Syntactically invalid RFC2822 address items are omitted from the output.
10029
10030 It is possible to specify a character other than colon for the output
10031 separator by starting the string with > followed by the new separator
10032 character. For example:
10033 .code
10034 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10035 .endd
10036 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10037 expansion item, which extracts the working address from a single RFC2822
10038 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10039 processing lists.
10040
10041 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10042 a strict interpretation of header line formatting.  Exim parses the bare,
10043 unquoted portion of an email address and if it finds a comma, treats it as an
10044 email address separator. For the example header line:
10045 .code
10046 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10047 .endd
10048 The first example below demonstrates that Q-encoded email addresses are parsed
10049 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10050 It does not see the comma because it's still encoded as "=2C".  The second
10051 example below is passed the contents of &`$header_from:`&, meaning it gets
10052 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10053 The third example shows that the presence of a comma is skipped when it is
10054 quoted.
10055 .code
10056 # exim -be '${addresses:From: \
10057 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10058 user@example.com
10059 # exim -be '${addresses:From: Last, First <user@example.com>}'
10060 Last:user@example.com
10061 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10062 user@example.com
10063 .endd
10064
10065 .vitem &*${base62:*&<&'digits'&>&*}*&
10066 .cindex "&%base62%& expansion item"
10067 .cindex "expansion" "conversion to base 62"
10068 The string must consist entirely of decimal digits. The number is converted to
10069 base 62 and output as a string of six characters, including leading zeros. In
10070 the few operating environments where Exim uses base 36 instead of base 62 for
10071 its message identifiers (because those systems do not have case-sensitive file
10072 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10073 be absolutely clear: this is &'not'& base64 encoding.
10074
10075 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10076 .cindex "&%base62d%& expansion item"
10077 .cindex "expansion" "conversion to base 62"
10078 The string must consist entirely of base-62 digits, or, in operating
10079 environments where Exim uses base 36 instead of base 62 for its message
10080 identifiers, base-36 digits. The number is converted to decimal and output as a
10081 string.
10082
10083 .new
10084 .vitem &*${base64:*&<&'string'&>&*}*&
10085 .cindex "expansion" "base64 encoding"
10086 .cindex "base64 encoding" "in string expansion"
10087 .cindex "&%base64%& expansion item"
10088 .cindex certificate "base64 of DER"
10089 This operator converts a string into one that is base64 encoded.
10090
10091 If the string is a single variable of type certificate,
10092 returns the base64 encoding of the DER form of the certificate.
10093
10094
10095 .vitem &*${base64d:*&<&'string'&>&*}*&
10096 .cindex "expansion" "base64 decoding"
10097 .cindex "base64 decoding" "in string expansion"
10098 .cindex "&%base64d%& expansion item"
10099 This operator converts a base64-encoded string into the un-coded form.
10100 .wen
10101
10102
10103 .vitem &*${domain:*&<&'string'&>&*}*&
10104 .cindex "domain" "extraction"
10105 .cindex "expansion" "domain extraction"
10106 The string is interpreted as an RFC 2822 address and the domain is extracted
10107 from it. If the string does not parse successfully, the result is empty.
10108
10109
10110 .vitem &*${escape:*&<&'string'&>&*}*&
10111 .cindex "expansion" "escaping non-printing characters"
10112 .cindex "&%escape%& expansion item"
10113 If the string contains any non-printing characters, they are converted to
10114 escape sequences starting with a backslash. Whether characters with the most
10115 significant bit set (so-called &"8-bit characters"&) count as printing or not
10116 is controlled by the &%print_topbitchars%& option.
10117
10118
10119 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10120 .cindex "expansion" "expression evaluation"
10121 .cindex "expansion" "arithmetic expression"
10122 .cindex "&%eval%& expansion item"
10123 These items supports simple arithmetic and bitwise logical operations in
10124 expansion strings. The string (after expansion) must be a conventional
10125 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10126 logical operators, and parentheses. All operations are carried out using
10127 integer arithmetic. The operator priorities are as follows (the same as in the
10128 C programming language):
10129 .table2 70pt 300pt
10130 .irow &'highest:'& "not (~), negate (-)"
10131 .irow ""   "multiply (*), divide (/), remainder (%)"
10132 .irow ""   "plus (+), minus (-)"
10133 .irow ""   "shift-left (<<), shift-right (>>)"
10134 .irow ""   "and (&&)"
10135 .irow ""   "xor (^)"
10136 .irow &'lowest:'&  "or (|)"
10137 .endtable
10138 Binary operators with the same priority are evaluated from left to right. White
10139 space is permitted before or after operators.
10140
10141 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10142 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10143 decimal, even if they start with a leading zero; hexadecimal numbers are not
10144 permitted. This can be useful when processing numbers extracted from dates or
10145 times, which often do have leading zeros.
10146
10147 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10148 or 1024*1024*1024,
10149 respectively. Negative numbers are supported. The result of the computation is
10150 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10151
10152 .display
10153 &`${eval:1+1}            `&  yields 2
10154 &`${eval:1+2*3}          `&  yields 7
10155 &`${eval:(1+2)*3}        `&  yields 9
10156 &`${eval:2+42%5}         `&  yields 4
10157 &`${eval:0xc&amp;5}          `&  yields 4
10158 &`${eval:0xc|5}          `&  yields 13
10159 &`${eval:0xc^5}          `&  yields 9
10160 &`${eval:0xc>>1}         `&  yields 6
10161 &`${eval:0xc<<1}         `&  yields 24
10162 &`${eval:~255&amp;0x1234}    `&  yields 4608
10163 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10164 .endd
10165
10166 As a more realistic example, in an ACL you might have
10167 .code
10168 deny   message = Too many bad recipients
10169        condition =                    \
10170          ${if and {                   \
10171            {>{$rcpt_count}{10}}       \
10172            {                          \
10173            <                          \
10174              {$recipients_count}      \
10175              {${eval:$rcpt_count/2}}  \
10176            }                          \
10177          }{yes}{no}}
10178 .endd
10179 The condition is true if there have been more than 10 RCPT commands and
10180 fewer than half of them have resulted in a valid recipient.
10181
10182
10183 .vitem &*${expand:*&<&'string'&>&*}*&
10184 .cindex "expansion" "re-expansion of substring"
10185 The &%expand%& operator causes a string to be expanded for a second time. For
10186 example,
10187 .code
10188 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10189 .endd
10190 first looks up a string in a file while expanding the operand for &%expand%&,
10191 and then re-expands what it has found.
10192
10193
10194 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10195 .cindex "Unicode"
10196 .cindex "UTF-8" "conversion from"
10197 .cindex "expansion" "UTF-8 conversion"
10198 .cindex "&%from_utf8%& expansion item"
10199 The world is slowly moving towards Unicode, although there are no standards for
10200 email yet. However, other applications (including some databases) are starting
10201 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10202 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10203 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10204 the result is an undefined sequence of bytes.
10205
10206 Unicode code points with values less than 256 are compatible with ASCII and
10207 ISO-8859-1 (also known as Latin-1).
10208 For example, character 169 is the copyright symbol in both cases, though the
10209 way it is encoded is different. In UTF-8, more than one byte is needed for
10210 characters with code values greater than 127, whereas ISO-8859-1 is a
10211 single-byte encoding (but thereby limited to 256 characters). This makes
10212 translation from UTF-8 to ISO-8859-1 straightforward.
10213
10214
10215 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10216 .cindex "hash function" "textual"
10217 .cindex "expansion" "textual hash"
10218 The &%hash%& operator is a simpler interface to the hashing function that can
10219 be used when the two parameters are fixed numbers (as opposed to strings that
10220 change when expanded). The effect is the same as
10221 .code
10222 ${hash{<n>}{<m>}{<string>}}
10223 .endd
10224 See the description of the general &%hash%& item above for details. The
10225 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10226
10227
10228
10229 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10230 .cindex "base64 encoding" "conversion from hex"
10231 .cindex "expansion" "hex to base64"
10232 .cindex "&%hex2b64%& expansion item"
10233 This operator converts a hex string into one that is base64 encoded. This can
10234 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10235
10236
10237
10238 .vitem &*${hexquote:*&<&'string'&>&*}*&
10239 .cindex "quoting" "hex-encoded unprintable characters"
10240 .cindex "&%hexquote%& expansion item"
10241 This operator converts non-printable characters in a string into a hex
10242 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10243 as is, and other byte values are converted to &`\xNN`&, for example a
10244 byte value 127 is converted to &`\x7f`&.
10245
10246
10247 .new
10248 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10249 .cindex "&%ipv6denorm%& expansion item"
10250 .cindex "IP address" normalisation
10251 This expands an IPv6 address to a full eight-element colon-separated set
10252 of hex digits including leading zeroes.
10253 A trailing ipv4-style dotted-decimal set is converted to hex.
10254 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10255
10256 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10257 .cindex "&%ipv6norm%& expansion item"
10258 .cindex "IP address" normalisation
10259 .cindex "IP address" "canonical form"
10260 This converts an IPv6 address to canonical form.
10261 Leading zeroes of groups are omitted, and the longest
10262 set of zero-valued groups is replaced with a double colon.
10263 A trailing ipv4-style dotted-decimal set is converted to hex.
10264 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10265 .wen
10266
10267
10268 .vitem &*${lc:*&<&'string'&>&*}*&
10269 .cindex "case forcing in strings"
10270 .cindex "string" "case forcing"
10271 .cindex "lower casing"
10272 .cindex "expansion" "case forcing"
10273 .cindex "&%lc%& expansion item"
10274 This forces the letters in the string into lower-case, for example:
10275 .code
10276 ${lc:$local_part}
10277 .endd
10278
10279 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10280 .cindex "expansion" "string truncation"
10281 .cindex "&%length%& expansion item"
10282 The &%length%& operator is a simpler interface to the &%length%& function that
10283 can be used when the parameter is a fixed number (as opposed to a string that
10284 changes when expanded). The effect is the same as
10285 .code
10286 ${length{<number>}{<string>}}
10287 .endd
10288 See the description of the general &%length%& item above for details. Note that
10289 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10290 when &%length%& is used as an operator.
10291
10292
10293 .vitem &*${listcount:*&<&'string'&>&*}*&
10294 .cindex "expansion" "list item count"
10295 .cindex "list" "item count"
10296 .cindex "list" "count of items"
10297 .cindex "&%listcount%& expansion item"
10298 The string is interpreted as a list and the number of items is returned.
10299
10300
10301 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10302 .cindex "expansion" "named list"
10303 .cindex "&%listnamed%& expansion item"
10304 The name is interpreted as a named list and the content of the list is returned,
10305 expanding any referenced lists, re-quoting as needed for colon-separation.
10306 If the optional type is given it must be one of "a", "d", "h" or "l"
10307 and selects address-, domain-, host- or localpart- lists to search among respectively.
10308 Otherwise all types are searched in an undefined order and the first
10309 matching list is returned.
10310
10311
10312 .vitem &*${local_part:*&<&'string'&>&*}*&
10313 .cindex "expansion" "local part extraction"
10314 .cindex "&%local_part%& expansion item"
10315 The string is interpreted as an RFC 2822 address and the local part is
10316 extracted from it. If the string does not parse successfully, the result is
10317 empty.
10318
10319
10320 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10321 .cindex "masked IP address"
10322 .cindex "IP address" "masking"
10323 .cindex "CIDR notation"
10324 .cindex "expansion" "IP address masking"
10325 .cindex "&%mask%& expansion item"
10326 If the form of the string to be operated on is not an IP address followed by a
10327 slash and an integer (that is, a network address in CIDR notation), the
10328 expansion fails. Otherwise, this operator converts the IP address to binary,
10329 masks off the least significant bits according to the bit count, and converts
10330 the result back to text, with mask appended. For example,
10331 .code
10332 ${mask:10.111.131.206/28}
10333 .endd
10334 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10335 be mostly used for looking up masked addresses in files, the result for an IPv6
10336 address uses dots to separate components instead of colons, because colon
10337 terminates a key string in lsearch files. So, for example,
10338 .code
10339 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10340 .endd
10341 returns the string
10342 .code
10343 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10344 .endd
10345 Letters in IPv6 addresses are always output in lower case.
10346
10347
10348 .vitem &*${md5:*&<&'string'&>&*}*&
10349 .cindex "MD5 hash"
10350 .cindex "expansion" "MD5 hash"
10351 .cindex certificate fingerprint
10352 .cindex "&%md5%& expansion item"
10353 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10354 as a 32-digit hexadecimal number, in which any letters are in lower case.
10355
10356 If the string is a single variable of type certificate,
10357 returns the MD5 hash fingerprint of the certificate.
10358
10359
10360 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10361 .cindex "expansion" "numeric hash"
10362 .cindex "hash function" "numeric"
10363 The &%nhash%& operator is a simpler interface to the numeric hashing function
10364 that can be used when the two parameters are fixed numbers (as opposed to
10365 strings that change when expanded). The effect is the same as
10366 .code
10367 ${nhash{<n>}{<m>}{<string>}}
10368 .endd
10369 See the description of the general &%nhash%& item above for details.
10370
10371
10372 .vitem &*${quote:*&<&'string'&>&*}*&
10373 .cindex "quoting" "in string expansions"
10374 .cindex "expansion" "quoting"
10375 .cindex "&%quote%& expansion item"
10376 The &%quote%& operator puts its argument into double quotes if it
10377 is an empty string or
10378 contains anything other than letters, digits, underscores, dots, and hyphens.
10379 Any occurrences of double quotes and backslashes are escaped with a backslash.
10380 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10381 respectively For example,
10382 .code
10383 ${quote:ab"*"cd}
10384 .endd
10385 becomes
10386 .code
10387 "ab\"*\"cd"
10388 .endd
10389 The place where this is useful is when the argument is a substitution from a
10390 variable or a message header.
10391
10392 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10393 .cindex "&%quote_local_part%& expansion item"
10394 This operator is like &%quote%&, except that it quotes the string only if
10395 required to do so by the rules of RFC 2822 for quoting local parts. For
10396 example, a plus sign would not cause quoting (but it would for &%quote%&).
10397 If you are creating a new email address from the contents of &$local_part$&
10398 (or any other unknown data), you should always use this operator.
10399
10400
10401 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10402 .cindex "quoting" "lookup-specific"
10403 This operator applies lookup-specific quoting rules to the string. Each
10404 query-style lookup type has its own quoting rules which are described with
10405 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10406 .code
10407 ${quote_ldap:two * two}
10408 .endd
10409 returns
10410 .code
10411 two%20%5C2A%20two
10412 .endd
10413 For single-key lookup types, no quoting is ever necessary and this operator
10414 yields an unchanged string.
10415
10416
10417 .vitem &*${randint:*&<&'n'&>&*}*&
10418 .cindex "random number"
10419 This operator returns a somewhat random number which is less than the
10420 supplied number and is at least 0.  The quality of this randomness depends
10421 on how Exim was built; the values are not suitable for keying material.
10422 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10423 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10424 for versions of GnuTLS with that function.
10425 Otherwise, the implementation may be arc4random(), random() seeded by
10426 srandomdev() or srandom(), or a custom implementation even weaker than
10427 random().
10428
10429
10430 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10431 .cindex "expansion" "IP address"
10432 This operator reverses an IP address; for IPv4 addresses, the result is in
10433 dotted-quad decimal form, while for IPv6 addresses the result is in
10434 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10435 for DNS.  For example,
10436 .code
10437 ${reverse_ip:192.0.2.4}
10438 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10439 .endd
10440 returns
10441 .code
10442 4.2.0.192
10443 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
10444 .endd
10445
10446
10447 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10448 .cindex "expansion" "RFC 2047"
10449 .cindex "RFC 2047" "expansion operator"
10450 .cindex "&%rfc2047%& expansion item"
10451 This operator encodes text according to the rules of RFC 2047. This is an
10452 encoding that is used in header lines to encode non-ASCII characters. It is
10453 assumed that the input string is in the encoding specified by the
10454 &%headers_charset%& option, which gets its default at build time. If the string
10455 contains only characters in the range 33&--126, and no instances of the
10456 characters
10457 .code
10458 ? = ( ) < > @ , ; : \ " . [ ] _
10459 .endd
10460 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10461 string, using as many &"encoded words"& as necessary to encode all the
10462 characters.
10463
10464
10465 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10466 .cindex "expansion" "RFC 2047"
10467 .cindex "RFC 2047" "decoding"
10468 .cindex "&%rfc2047d%& expansion item"
10469 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10470 bytes are replaced by question marks. Characters are converted into the
10471 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10472 not recognized unless &%check_rfc2047_length%& is set false.
10473
10474 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10475 access a header line, RFC 2047 decoding is done automatically. You do not need
10476 to use this operator as well.
10477
10478
10479
10480 .vitem &*${rxquote:*&<&'string'&>&*}*&
10481 .cindex "quoting" "in regular expressions"
10482 .cindex "regular expressions" "quoting"
10483 .cindex "&%rxquote%& expansion item"
10484 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10485 characters in its argument. This is useful when substituting the values of
10486 variables or headers inside regular expressions.
10487
10488
10489 .vitem &*${sha1:*&<&'string'&>&*}*&
10490 .cindex "SHA-1 hash"
10491 .cindex "expansion" "SHA-1 hashing"
10492 .cindex certificate fingerprint
10493 .cindex "&%sha2%& expansion item"
10494 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10495 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10496
10497 If the string is a single variable of type certificate,
10498 returns the SHA-1 hash fingerprint of the certificate.
10499
10500
10501 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10502 .cindex "SHA-256 hash"
10503 .cindex certificate fingerprint
10504 .cindex "expansion" "SHA-256 hashing"
10505 .cindex "&%sha256%& expansion item"
10506 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10507 certificate,
10508 and returns
10509 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10510 Only arguments which are a single variable of certificate type are supported.
10511
10512
10513 .vitem &*${stat:*&<&'string'&>&*}*&
10514 .cindex "expansion" "statting a file"
10515 .cindex "file" "extracting characteristics"
10516 .cindex "&%stat%& expansion item"
10517 The string, after expansion, must be a file path. A call to the &[stat()]&
10518 function is made for this path. If &[stat()]& fails, an error occurs and the
10519 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10520 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10521 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10522 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10523 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10524 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10525 can extract individual fields using the &%extract%& expansion item.
10526
10527 The use of the &%stat%& expansion in users' filter files can be locked out by
10528 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10529 systems for files larger than 2GB.
10530
10531 .vitem &*${str2b64:*&<&'string'&>&*}*&
10532 .cindex "&%str2b64%& expansion item"
10533 .new
10534 Now deprecated, a synonym for the &%base64%& expansion operator.
10535 .wen
10536
10537
10538
10539 .vitem &*${strlen:*&<&'string'&>&*}*&
10540 .cindex "expansion" "string length"
10541 .cindex "string" "length in expansion"
10542 .cindex "&%strlen%& expansion item"
10543 The item is replace by the length of the expanded string, expressed as a
10544 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10545
10546
10547 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10548 .cindex "&%substr%& expansion item"
10549 .cindex "substring extraction"
10550 .cindex "expansion" "substring expansion"
10551 The &%substr%& operator is a simpler interface to the &%substr%& function that
10552 can be used when the two parameters are fixed numbers (as opposed to strings
10553 that change when expanded). The effect is the same as
10554 .code
10555 ${substr{<start>}{<length>}{<string>}}
10556 .endd
10557 See the description of the general &%substr%& item above for details. The
10558 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10559
10560 .vitem &*${time_eval:*&<&'string'&>&*}*&
10561 .cindex "&%time_eval%& expansion item"
10562 .cindex "time interval" "decoding"
10563 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10564 seconds.
10565
10566 .vitem &*${time_interval:*&<&'string'&>&*}*&
10567 .cindex "&%time_interval%& expansion item"
10568 .cindex "time interval" "formatting"
10569 The argument (after sub-expansion) must be a sequence of decimal digits that
10570 represents an interval of time as a number of seconds. It is converted into a
10571 number of larger units and output in Exim's normal time format, for example,
10572 &`1w3d4h2m6s`&.
10573
10574 .vitem &*${uc:*&<&'string'&>&*}*&
10575 .cindex "case forcing in strings"
10576 .cindex "string" "case forcing"
10577 .cindex "upper casing"
10578 .cindex "expansion" "case forcing"
10579 .cindex "&%uc%& expansion item"
10580 This forces the letters in the string into upper-case.
10581
10582 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10583 .cindex "correction of invalid utf-8 sequences in strings"
10584 .cindex "utf-8" "utf-8 sequences"
10585 .cindex "incorrect utf-8"
10586 .cindex "expansion" "utf-8 forcing"
10587 .cindex "&%utf8clean%& expansion item"
10588 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10589
10590 .new
10591 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10592        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10593        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10594        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10595 .cindex expansion UTF-8
10596 .cindex UTF-8 expansion
10597 .cindex EAI
10598 .cindex internationalisation
10599 .cindex "&%utf8_domain_to_alabel%& expansion item"
10600 .cindex "&%utf8_domain_from_alabel%& expansion item"
10601 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10602 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10603 These convert EAI mail name components between UTF-8 and a-label forms.
10604 For information on internationalisation support see &<<SECTi18nMTA>>&.
10605 .wen
10606 .endlist
10607
10608
10609
10610
10611
10612
10613 .section "Expansion conditions" "SECTexpcond"
10614 .scindex IIDexpcond "expansion" "conditions"
10615 The following conditions are available for testing by the &%${if%& construct
10616 while expanding strings:
10617
10618 .vlist
10619 .vitem &*!*&<&'condition'&>
10620 .cindex "expansion" "negating a condition"
10621 .cindex "negation" "in expansion condition"
10622 Preceding any condition with an exclamation mark negates the result of the
10623 condition.
10624
10625 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10626 .cindex "numeric comparison"
10627 .cindex "expansion" "numeric comparison"
10628 There are a number of symbolic operators for doing numeric comparisons. They
10629 are:
10630 .display
10631 &`=   `&   equal
10632 &`==  `&   equal
10633 &`>   `&   greater
10634 &`>=  `&   greater or equal
10635 &`<   `&   less
10636 &`<=  `&   less or equal
10637 .endd
10638 For example:
10639 .code
10640 ${if >{$message_size}{10M} ...
10641 .endd
10642 Note that the general negation operator provides for inequality testing. The
10643 two strings must take the form of optionally signed decimal integers,
10644 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10645 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10646 As a special case, the numerical value of an empty string is taken as
10647 zero.
10648
10649 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10650 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10651 10M, not if 10M is larger than &$message_size$&.
10652
10653
10654 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10655         {*&<&'arg2'&>&*}...}*&
10656 .cindex "expansion" "calling an acl"
10657 .cindex "&%acl%&" "expansion condition"
10658 The name and zero to nine argument strings are first expanded separately.  The expanded
10659 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10660 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10661 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10662 and may use the variables; if another acl expansion is used the values
10663 are restored after it returns.  If the ACL sets
10664 a value using a "message =" modifier the variable $value becomes
10665 the result of the expansion, otherwise it is empty.
10666 If the ACL returns accept the condition is true; if deny, false.
10667 If the ACL returns defer the result is a forced-fail.
10668
10669 .vitem &*bool&~{*&<&'string'&>&*}*&
10670 .cindex "expansion" "boolean parsing"
10671 .cindex "&%bool%& expansion condition"
10672 This condition turns a string holding a true or false representation into
10673 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10674 (case-insensitively); also integer numbers map to true if non-zero,
10675 false if zero.
10676 An empty string is treated as false.
10677 Leading and trailing whitespace is ignored;
10678 thus a string consisting only of whitespace is false.
10679 All other string values will result in expansion failure.
10680
10681 When combined with ACL variables, this expansion condition will let you
10682 make decisions in one place and act on those decisions in another place.
10683 For example:
10684 .code
10685 ${if bool{$acl_m_privileged_sender} ...
10686 .endd
10687
10688
10689 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10690 .cindex "expansion" "boolean parsing"
10691 .cindex "&%bool_lax%& expansion condition"
10692 Like &%bool%&, this condition turns a string into a boolean state.  But
10693 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10694 loose definition that the Router &%condition%& option uses.  The empty string
10695 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10696 true.  Leading and trailing whitespace is ignored.
10697
10698 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10699
10700 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10701 .cindex "expansion" "encrypted comparison"
10702 .cindex "encrypted strings, comparing"
10703 .cindex "&%crypteq%& expansion condition"
10704 This condition is included in the Exim binary if it is built to support any
10705 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10706 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10707 included in the binary.
10708
10709 The &%crypteq%& condition has two arguments. The first is encrypted and
10710 compared against the second, which is already encrypted. The second string may
10711 be in the LDAP form for storing encrypted strings, which starts with the
10712 encryption type in curly brackets, followed by the data. If the second string
10713 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10714 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10715 Typically this will be a field from a password file. An example of an encrypted
10716 string in LDAP form is:
10717 .code
10718 {md5}CY9rzUYh03PK3k6DJie09g==
10719 .endd
10720 If such a string appears directly in an expansion, the curly brackets have to
10721 be quoted, because they are part of the expansion syntax. For example:
10722 .code
10723 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10724 .endd
10725 The following encryption types (whose names are matched case-independently) are
10726 supported:
10727
10728 .ilist
10729 .cindex "MD5 hash"
10730 .cindex "base64 encoding" "in encrypted password"
10731 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10732 printable characters to compare with the remainder of the second string. If the
10733 length of the comparison string is 24, Exim assumes that it is base64 encoded
10734 (as in the above example). If the length is 32, Exim assumes that it is a
10735 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10736 comparison fails.
10737
10738 .next
10739 .cindex "SHA-1 hash"
10740 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10741 printable characters to compare with the remainder of the second string. If the
10742 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10743 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10744 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10745
10746 .next
10747 .cindex "&[crypt()]&"
10748 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10749 only the first eight characters of the password. However, in modern operating
10750 systems this is no longer true, and in many cases the entire password is used,
10751 whatever its length.
10752
10753 .next
10754 .cindex "&[crypt16()]&"
10755 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10756 use up to 16 characters of the password in some operating systems. Again, in
10757 modern operating systems, more characters may be used.
10758 .endlist
10759 Exim has its own version of &[crypt16()]&, which is just a double call to
10760 &[crypt()]&. For operating systems that have their own version, setting
10761 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10762 operating system version instead of its own. This option is set by default in
10763 the OS-dependent &_Makefile_& for those operating systems that are known to
10764 support &[crypt16()]&.
10765
10766 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10767 it was not using the same algorithm as some operating systems' versions. It
10768 turns out that as well as &[crypt16()]& there is a function called
10769 &[bigcrypt()]& in some operating systems. This may or may not use the same
10770 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10771
10772 However, since there is now a move away from the traditional &[crypt()]&
10773 functions towards using SHA1 and other algorithms, tidying up this area of
10774 Exim is seen as very low priority.
10775
10776 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10777 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10778 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10779 default is &`{crypt}`&. Whatever the default, you can always use either
10780 function by specifying it explicitly in curly brackets.
10781
10782 .vitem &*def:*&<&'variable&~name'&>
10783 .cindex "expansion" "checking for empty variable"
10784 .cindex "&%def%& expansion condition"
10785 The &%def%& condition must be followed by the name of one of the expansion
10786 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10787 variable does not contain the empty string. For example:
10788 .code
10789 ${if def:sender_ident {from $sender_ident}}
10790 .endd
10791 Note that the variable name is given without a leading &%$%& character. If the
10792 variable does not exist, the expansion fails.
10793
10794 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10795         &~&*def:h_*&<&'header&~name'&>&*:*&"
10796 .cindex "expansion" "checking header line existence"
10797 This condition is true if a message is being processed and the named header
10798 exists in the message. For example,
10799 .code
10800 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10801 .endd
10802 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10803 the header name must be terminated by a colon if white space does not follow.
10804
10805 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10806        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10807 .cindex "string" "comparison"
10808 .cindex "expansion" "string comparison"
10809 .cindex "&%eq%& expansion condition"
10810 .cindex "&%eqi%& expansion condition"
10811 The two substrings are first expanded. The condition is true if the two
10812 resulting strings are identical. For &%eq%& the comparison includes the case of
10813 letters, whereas for &%eqi%& the comparison is case-independent.
10814
10815 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10816 .cindex "expansion" "file existence test"
10817 .cindex "file" "existence test"
10818 .cindex "&%exists%&, expansion condition"
10819 The substring is first expanded and then interpreted as an absolute path. The
10820 condition is true if the named file (or directory) exists. The existence test
10821 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10822 users' filter files may be locked out by the system administrator.
10823
10824 .vitem &*first_delivery*&
10825 .cindex "delivery" "first"
10826 .cindex "first delivery"
10827 .cindex "expansion" "first delivery test"
10828 .cindex "&%first_delivery%& expansion condition"
10829 This condition, which has no data, is true during a message's first delivery
10830 attempt. It is false during any subsequent delivery attempts.
10831
10832
10833 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10834        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10835 .cindex "list" "iterative conditions"
10836 .cindex "expansion" "&*forall*& condition"
10837 .cindex "expansion" "&*forany*& condition"
10838 .vindex "&$item$&"
10839 These conditions iterate over a list. The first argument is expanded to form
10840 the list. By default, the list separator is a colon, but it can be changed by
10841 the normal method. The second argument is interpreted as a condition that is to
10842 be applied to each item in the list in turn. During the interpretation of the
10843 condition, the current list item is placed in a variable called &$item$&.
10844 .ilist
10845 For &*forany*&, interpretation stops if the condition is true for any item, and
10846 the result of the whole condition is true. If the condition is false for all
10847 items in the list, the overall condition is false.
10848 .next
10849 For &*forall*&, interpretation stops if the condition is false for any item,
10850 and the result of the whole condition is false. If the condition is true for
10851 all items in the list, the overall condition is true.
10852 .endlist
10853 Note that negation of &*forany*& means that the condition must be false for all
10854 items for the overall condition to succeed, and negation of &*forall*& means
10855 that the condition must be false for at least one item. In this example, the
10856 list separator is changed to a comma:
10857 .code
10858 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10859 .endd
10860 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10861 being processed, to enable these expansion items to be nested.
10862
10863 To scan a named list, expand it with the &*listnamed*& operator.
10864
10865
10866 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10867        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10868 .cindex "string" "comparison"
10869 .cindex "expansion" "string comparison"
10870 .cindex "&%ge%& expansion condition"
10871 .cindex "&%gei%& expansion condition"
10872 The two substrings are first expanded. The condition is true if the first
10873 string is lexically greater than or equal to the second string. For &%ge%& the
10874 comparison includes the case of letters, whereas for &%gei%& the comparison is
10875 case-independent.
10876
10877 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10878        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10879 .cindex "string" "comparison"
10880 .cindex "expansion" "string comparison"
10881 .cindex "&%gt%& expansion condition"
10882 .cindex "&%gti%& expansion condition"
10883 The two substrings are first expanded. The condition is true if the first
10884 string is lexically greater than the second string. For &%gt%& the comparison
10885 includes the case of letters, whereas for &%gti%& the comparison is
10886 case-independent.
10887
10888 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10889        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10890 .cindex "string" "comparison"
10891 .cindex "list" "iterative conditions"
10892 Both strings are expanded; the second string is treated as a list of simple
10893 strings; if the first string is a member of the second, then the condition
10894 is true.
10895
10896 These are simpler to use versions of the more powerful &*forany*& condition.
10897 Examples, and the &*forany*& equivalents:
10898 .code
10899 ${if inlist{needle}{foo:needle:bar}}
10900   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10901 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10902   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10903 .endd
10904
10905 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10906        &*isip4&~{*&<&'string'&>&*}*& &&&
10907        &*isip6&~{*&<&'string'&>&*}*&
10908 .cindex "IP address" "testing string format"
10909 .cindex "string" "testing for IP address"
10910 .cindex "&%isip%& expansion condition"
10911 .cindex "&%isip4%& expansion condition"
10912 .cindex "&%isip6%& expansion condition"
10913 The substring is first expanded, and then tested to see if it has the form of
10914 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10915 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10916
10917 For an IPv4 address, the test is for four dot-separated components, each of
10918 which consists of from one to three digits. For an IPv6 address, up to eight
10919 colon-separated components are permitted, each containing from one to four
10920 hexadecimal digits. There may be fewer than eight components if an empty
10921 component (adjacent colons) is present. Only one empty component is permitted.
10922
10923 &*Note*&: The checks are just on the form of the address; actual numerical
10924 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10925 check. The main use of these tests is to distinguish between IP addresses and
10926 host names, or between IPv4 and IPv6 addresses. For example, you could use
10927 .code
10928 ${if isip4{$sender_host_address}...
10929 .endd
10930 to test which IP version an incoming SMTP connection is using.
10931
10932 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10933 .cindex "LDAP" "use for authentication"
10934 .cindex "expansion" "LDAP authentication test"
10935 .cindex "&%ldapauth%& expansion condition"
10936 This condition supports user authentication using LDAP. See section
10937 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10938 queries. For this use, the query must contain a user name and password. The
10939 query itself is not used, and can be empty. The condition is true if the
10940 password is not empty, and the user name and password are accepted by the LDAP
10941 server. An empty password is rejected without calling LDAP because LDAP binds
10942 with an empty password are considered anonymous regardless of the username, and
10943 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10944 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10945 this can be used.
10946
10947
10948 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10949        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10950 .cindex "string" "comparison"
10951 .cindex "expansion" "string comparison"
10952 .cindex "&%le%& expansion condition"
10953 .cindex "&%lei%& expansion condition"
10954 The two substrings are first expanded. The condition is true if the first
10955 string is lexically less than or equal to the second string. For &%le%& the
10956 comparison includes the case of letters, whereas for &%lei%& the comparison is
10957 case-independent.
10958
10959 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10960        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10961 .cindex "string" "comparison"
10962 .cindex "expansion" "string comparison"
10963 .cindex "&%lt%& expansion condition"
10964 .cindex "&%lti%& expansion condition"
10965 The two substrings are first expanded. The condition is true if the first
10966 string is lexically less than the second string. For &%lt%& the comparison
10967 includes the case of letters, whereas for &%lti%& the comparison is
10968 case-independent.
10969
10970
10971 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10972 .cindex "expansion" "regular expression comparison"
10973 .cindex "regular expressions" "match in expanded string"
10974 .cindex "&%match%& expansion condition"
10975 The two substrings are first expanded. The second is then treated as a regular
10976 expression and applied to the first. Because of the pre-expansion, if the
10977 regular expression contains dollar, or backslash characters, they must be
10978 escaped. Care must also be taken if the regular expression contains braces
10979 (curly brackets). A closing brace must be escaped so that it is not taken as a
10980 premature termination of <&'string2'&>. The easiest approach is to use the
10981 &`\N`& feature to disable expansion of the regular expression.
10982 For example,
10983 .code
10984 ${if match {$local_part}{\N^\d{3}\N} ...
10985 .endd
10986 If the whole expansion string is in double quotes, further escaping of
10987 backslashes is also required.
10988
10989 The condition is true if the regular expression match succeeds.
10990 The regular expression is not required to begin with a circumflex
10991 metacharacter, but if there is no circumflex, the expression is not anchored,
10992 and it may match anywhere in the subject, not just at the start. If you want
10993 the pattern to match at the end of the subject, you must include the &`$`&
10994 metacharacter at an appropriate point.
10995
10996 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10997 At the start of an &%if%& expansion the values of the numeric variable
10998 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10999 succeeds causes them to be reset to the substrings of that condition and they
11000 will have these values during the expansion of the success string. At the end
11001 of the &%if%& expansion, the previous values are restored. After testing a
11002 combination of conditions using &%or%&, the subsequent values of the numeric
11003 variables are those of the condition that succeeded.
11004
11005 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11006 .cindex "&%match_address%& expansion condition"
11007 See &*match_local_part*&.
11008
11009 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11010 .cindex "&%match_domain%& expansion condition"
11011 See &*match_local_part*&.
11012
11013 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11014 .cindex "&%match_ip%& expansion condition"
11015 This condition matches an IP address to a list of IP address patterns. It must
11016 be followed by two argument strings. The first (after expansion) must be an IP
11017 address or an empty string. The second (not expanded) is a restricted host
11018 list that can match only an IP address, not a host name. For example:
11019 .code
11020 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11021 .endd
11022 The specific types of host list item that are permitted in the list are:
11023
11024 .ilist
11025 An IP address, optionally with a CIDR mask.
11026 .next
11027 A single asterisk, which matches any IP address.
11028 .next
11029 An empty item, which matches only if the IP address is empty. This could be
11030 useful for testing for a locally submitted message or one from specific hosts
11031 in a single test such as
11032 . ==== As this is a nested list, any displays it contains must be indented
11033 . ==== as otherwise they are too far to the left. This comment applies to
11034 . ==== the use of xmlto plus fop. There's no problem when formatting with
11035 . ==== sdop, with or without the extra indent.
11036 .code
11037   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11038 .endd
11039 where the first item in the list is the empty string.
11040 .next
11041 The item @[] matches any of the local host's interface addresses.
11042 .next
11043 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11044 even if &`net-`& is not specified. There is never any attempt to turn the IP
11045 address into a host name. The most common type of linear search for
11046 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11047 masks. For example:
11048 .code
11049   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11050 .endd
11051 It is of course possible to use other kinds of lookup, and in such a case, you
11052 do need to specify the &`net-`& prefix if you want to specify a specific
11053 address mask, for example:
11054 .code
11055   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11056 .endd
11057 However, unless you are combining a &%match_ip%& condition with others, it is
11058 just as easy to use the fact that a lookup is itself a condition, and write:
11059 .code
11060   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11061 .endd
11062 .endlist ilist
11063
11064 Note that <&'string2'&> is not itself subject to string expansion, unless
11065 Exim was built with the EXPAND_LISTMATCH_RHS option.
11066
11067 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11068
11069 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11070 .cindex "domain list" "in expansion condition"
11071 .cindex "address list" "in expansion condition"
11072 .cindex "local part" "list, in expansion condition"
11073 .cindex "&%match_local_part%& expansion condition"
11074 This condition, together with &%match_address%& and &%match_domain%&, make it
11075 possible to test domain, address, and local part lists within expansions. Each
11076 condition requires two arguments: an item and a list to match. A trivial
11077 example is:
11078 .code
11079 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11080 .endd
11081 In each case, the second argument may contain any of the allowable items for a
11082 list of the appropriate type. Also, because the second argument (after
11083 expansion) is a standard form of list, it is possible to refer to a named list.
11084 Thus, you can use conditions like this:
11085 .code
11086 ${if match_domain{$domain}{+local_domains}{...
11087 .endd
11088 .cindex "&`+caseful`&"
11089 For address lists, the matching starts off caselessly, but the &`+caseful`&
11090 item can be used, as in all address lists, to cause subsequent items to
11091 have their local parts matched casefully. Domains are always matched
11092 caselessly.
11093
11094 Note that <&'string2'&> is not itself subject to string expansion, unless
11095 Exim was built with the EXPAND_LISTMATCH_RHS option.
11096
11097 &*Note*&: Host lists are &'not'& supported in this way. This is because
11098 hosts have two identities: a name and an IP address, and it is not clear
11099 how to specify cleanly how such a test would work. However, IP addresses can be
11100 matched using &%match_ip%&.
11101
11102 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11103 .cindex "PAM authentication"
11104 .cindex "AUTH" "with PAM"
11105 .cindex "Solaris" "PAM support"
11106 .cindex "expansion" "PAM authentication test"
11107 .cindex "&%pam%& expansion condition"
11108 &'Pluggable Authentication Modules'&
11109 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11110 available in the latest releases of Solaris and in some GNU/Linux
11111 distributions. The Exim support, which is intended for use in conjunction with
11112 the SMTP AUTH command, is available only if Exim is compiled with
11113 .code
11114 SUPPORT_PAM=yes
11115 .endd
11116 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11117 in some releases of GNU/Linux &%-ldl%& is also needed.
11118
11119 The argument string is first expanded, and the result must be a
11120 colon-separated list of strings. Leading and trailing white space is ignored.
11121 The PAM module is initialized with the service name &"exim"& and the user name
11122 taken from the first item in the colon-separated data string (<&'string1'&>).
11123 The remaining items in the data string are passed over in response to requests
11124 from the authentication function. In the simple case there will only be one
11125 request, for a password, so the data consists of just two strings.
11126
11127 There can be problems if any of the strings are permitted to contain colon
11128 characters. In the usual way, these have to be doubled to avoid being taken as
11129 separators. If the data is being inserted from a variable, the &%sg%& expansion
11130 item can be used to double any existing colons. For example, the configuration
11131 of a LOGIN authenticator might contain this setting:
11132 .code
11133 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11134 .endd
11135 For a PLAIN authenticator you could use:
11136 .code
11137 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11138 .endd
11139 In some operating systems, PAM authentication can be done only from a process
11140 running as root. Since Exim is running as the Exim user when receiving
11141 messages, this means that PAM cannot be used directly in those systems.
11142 A patched version of the &'pam_unix'& module that comes with the
11143 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11144 The patched module allows one special uid/gid combination, in addition to root,
11145 to authenticate. If you build the patched module to allow the Exim user and
11146 group, PAM can then be used from an Exim authenticator.
11147
11148
11149 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11150 .cindex "&'pwcheck'& daemon"
11151 .cindex "Cyrus"
11152 .cindex "expansion" "&'pwcheck'& authentication test"
11153 .cindex "&%pwcheck%& expansion condition"
11154 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11155 This is one way of making it possible for passwords to be checked by a process
11156 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11157 deprecated. Its replacement is &'saslauthd'& (see below).
11158
11159 The pwcheck support is not included in Exim by default. You need to specify
11160 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11161 building Exim. For example:
11162 .code
11163 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11164 .endd
11165 You do not need to install the full Cyrus software suite in order to use
11166 the pwcheck daemon. You can compile and install just the daemon alone
11167 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11168 access to the &_/var/pwcheck_& directory.
11169
11170 The &%pwcheck%& condition takes one argument, which must be the user name and
11171 password, separated by a colon. For example, in a LOGIN authenticator
11172 configuration, you might have this:
11173 .code
11174 server_condition = ${if pwcheck{$auth1:$auth2}}
11175 .endd
11176 Again, for a PLAIN authenticator configuration, this would be:
11177 .code
11178 server_condition = ${if pwcheck{$auth2:$auth3}}
11179 .endd
11180 .vitem &*queue_running*&
11181 .cindex "queue runner" "detecting when delivering from"
11182 .cindex "expansion" "queue runner test"
11183 .cindex "&%queue_running%& expansion condition"
11184 This condition, which has no data, is true during delivery attempts that are
11185 initiated by queue runner processes, and false otherwise.
11186
11187
11188 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11189 .cindex "Radius"
11190 .cindex "expansion" "Radius authentication"
11191 .cindex "&%radius%& expansion condition"
11192 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11193 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11194 the Radius client configuration file in order to build Exim with Radius
11195 support.
11196
11197 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11198 library, using the original API. If you are using release 0.4.0 or later of
11199 this library, you need to set
11200 .code
11201 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11202 .endd
11203 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11204 &%libradius%& library that comes with FreeBSD. To do this, set
11205 .code
11206 RADIUS_LIB_TYPE=RADLIB
11207 .endd
11208 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11209 You may also have to supply a suitable setting in EXTRALIBS so that the
11210 Radius library can be found when Exim is linked.
11211
11212 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11213 Radius client library, which calls the Radius server. The condition is true if
11214 the authentication is successful. For example:
11215 .code
11216 server_condition = ${if radius{<arguments>}}
11217 .endd
11218
11219
11220 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11221         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11222 .cindex "&'saslauthd'& daemon"
11223 .cindex "Cyrus"
11224 .cindex "expansion" "&'saslauthd'& authentication test"
11225 .cindex "&%saslauthd%& expansion condition"
11226 This condition supports user authentication using the Cyrus &'saslauthd'&
11227 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11228 Using this daemon is one way of making it possible for passwords to be checked
11229 by a process that is not running as root.
11230
11231 The saslauthd support is not included in Exim by default. You need to specify
11232 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11233 building Exim. For example:
11234 .code
11235 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11236 .endd
11237 You do not need to install the full Cyrus software suite in order to use
11238 the saslauthd daemon. You can compile and install just the daemon alone
11239 from the Cyrus SASL library.
11240
11241 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11242 two are mandatory. For example:
11243 .code
11244 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11245 .endd
11246 The service and the realm are optional (which is why the arguments are enclosed
11247 in their own set of braces). For details of the meaning of the service and
11248 realm, and how to run the daemon, consult the Cyrus documentation.
11249 .endlist vlist
11250
11251
11252
11253 .section "Combining expansion conditions" "SECID84"
11254 .cindex "expansion" "combining conditions"
11255 Several conditions can be tested at once by combining them using the &%and%&
11256 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11257 conditions on their own, and precede their lists of sub-conditions. Each
11258 sub-condition must be enclosed in braces within the overall braces that contain
11259 the list. No repetition of &%if%& is used.
11260
11261
11262 .vlist
11263 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11264 .cindex "&""or""& expansion condition"
11265 .cindex "expansion" "&""or""& of conditions"
11266 The sub-conditions are evaluated from left to right. The condition is true if
11267 any one of the sub-conditions is true.
11268 For example,
11269 .code
11270 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11271 .endd
11272 When a true sub-condition is found, the following ones are parsed but not
11273 evaluated. If there are several &"match"& sub-conditions the values of the
11274 numeric variables afterwards are taken from the first one that succeeds.
11275
11276 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11277 .cindex "&""and""& expansion condition"
11278 .cindex "expansion" "&""and""& of conditions"
11279 The sub-conditions are evaluated from left to right. The condition is true if
11280 all of the sub-conditions are true. If there are several &"match"&
11281 sub-conditions, the values of the numeric variables afterwards are taken from
11282 the last one. When a false sub-condition is found, the following ones are
11283 parsed but not evaluated.
11284 .endlist
11285 .ecindex IIDexpcond
11286
11287
11288
11289
11290 .section "Expansion variables" "SECTexpvar"
11291 .cindex "expansion" "variables, list of"
11292 This section contains an alphabetical list of all the expansion variables. Some
11293 of them are available only when Exim is compiled with specific options such as
11294 support for TLS or the content scanning extension.
11295
11296 .vlist
11297 .vitem "&$0$&, &$1$&, etc"
11298 .cindex "numerical variables (&$1$& &$2$& etc)"
11299 When a &%match%& expansion condition succeeds, these variables contain the
11300 captured substrings identified by the regular expression during subsequent
11301 processing of the success string of the containing &%if%& expansion item.
11302 In the expansion condition case
11303 they do not retain their values afterwards; in fact, their previous
11304 values are restored at the end of processing an &%if%& item. The numerical
11305 variables may also be set externally by some other matching process which
11306 precedes the expansion of the string. For example, the commands available in
11307 Exim filter files include an &%if%& command with its own regular expression
11308 matching condition.
11309
11310 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11311 Within an acl condition, expansion condition or expansion item
11312 any arguments are copied to these variables,
11313 any unused variables being made empty.
11314
11315 .vitem "&$acl_c...$&"
11316 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11317 can be given any name that starts with &$acl_c$& and is at least six characters
11318 long, but the sixth character must be either a digit or an underscore. For
11319 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11320 variables persist throughout the lifetime of an SMTP connection. They can be
11321 used to pass information between ACLs and between different invocations of the
11322 same ACL. When a message is received, the values of these variables are saved
11323 with the message, and can be accessed by filters, routers, and transports
11324 during subsequent delivery.
11325
11326 .vitem "&$acl_m...$&"
11327 These variables are like the &$acl_c...$& variables, except that their values
11328 are reset after a message has been received. Thus, if several messages are
11329 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11330 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11331 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11332 message is received, the values of these variables are saved with the message,
11333 and can be accessed by filters, routers, and transports during subsequent
11334 delivery.
11335
11336 .vitem &$acl_narg$&
11337 Within an acl condition, expansion condition or expansion item
11338 this variable has the number of arguments.
11339
11340 .vitem &$acl_verify_message$&
11341 .vindex "&$acl_verify_message$&"
11342 After an address verification has failed, this variable contains the failure
11343 message. It retains its value for use in subsequent modifiers. The message can
11344 be preserved by coding like this:
11345 .code
11346 warn !verify = sender
11347      set acl_m0 = $acl_verify_message
11348 .endd
11349 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11350 &%log_message%& modifiers, to include information about the verification
11351 failure.
11352
11353 .vitem &$address_data$&
11354 .vindex "&$address_data$&"
11355 This variable is set by means of the &%address_data%& option in routers. The
11356 value then remains with the address while it is processed by subsequent routers
11357 and eventually a transport. If the transport is handling multiple addresses,
11358 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11359 for more details. &*Note*&: The contents of &$address_data$& are visible in
11360 user filter files.
11361
11362 If &$address_data$& is set when the routers are called from an ACL to verify
11363 a recipient address, the final value is still in the variable for subsequent
11364 conditions and modifiers of the ACL statement. If routing the address caused it
11365 to be redirected to just one address, the child address is also routed as part
11366 of the verification, and in this case the final value of &$address_data$& is
11367 from the child's routing.
11368
11369 If &$address_data$& is set when the routers are called from an ACL to verify a
11370 sender address, the final value is also preserved, but this time in
11371 &$sender_address_data$&, to distinguish it from data from a recipient
11372 address.
11373
11374 In both cases (recipient and sender verification), the value does not persist
11375 after the end of the current ACL statement. If you want to preserve
11376 these values for longer, you can save them in ACL variables.
11377
11378 .vitem &$address_file$&
11379 .vindex "&$address_file$&"
11380 When, as a result of aliasing, forwarding, or filtering, a message is directed
11381 to a specific file, this variable holds the name of the file when the transport
11382 is running. At other times, the variable is empty. For example, using the
11383 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11384 .code
11385 /home/r2d2/savemail
11386 .endd
11387 then when the &(address_file)& transport is running, &$address_file$&
11388 contains the text string &`/home/r2d2/savemail`&.
11389 .cindex "Sieve filter" "value of &$address_file$&"
11390 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11391 then up to the transport configuration to generate an appropriate absolute path
11392 to the relevant file.
11393
11394 .vitem &$address_pipe$&
11395 .vindex "&$address_pipe$&"
11396 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11397 this variable holds the pipe command when the transport is running.
11398
11399 .vitem "&$auth1$& &-- &$auth3$&"
11400 .vindex "&$auth1$&, &$auth2$&, etc"
11401 These variables are used in SMTP authenticators (see chapters
11402 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11403
11404 .vitem &$authenticated_id$&
11405 .cindex "authentication" "id"
11406 .vindex "&$authenticated_id$&"
11407 When a server successfully authenticates a client it may be configured to
11408 preserve some of the authentication information in the variable
11409 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11410 user/password authenticator configuration might preserve the user name for use
11411 in the routers. Note that this is not the same information that is saved in
11412 &$sender_host_authenticated$&.
11413 When a message is submitted locally (that is, not over a TCP connection)
11414 the value of &$authenticated_id$& is normally the login name of the calling
11415 process. However, a trusted user can override this by means of the &%-oMai%&
11416 command line option.
11417
11418 .vitem &$authenticated_fail_id$&
11419 .cindex "authentication" "fail" "id"
11420 .vindex "&$authenticated_fail_id$&"
11421 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11422 will contain the failed authentication id. If more than one authentication
11423 id is attempted, it will contain only the last one. The variable is
11424 available for processing in the ACL's, generally the quit or notquit ACL.
11425 A message to a local recipient could still be accepted without requiring
11426 authentication, which means this variable could also be visible in all of
11427 the ACL's as well.
11428
11429
11430 .vitem &$authenticated_sender$&
11431 .cindex "sender" "authenticated"
11432 .cindex "authentication" "sender"
11433 .cindex "AUTH" "on MAIL command"
11434 .vindex "&$authenticated_sender$&"
11435 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11436 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11437 described in section &<<SECTauthparamail>>&. Unless the data is the string
11438 &"<>"&, it is set as the authenticated sender of the message, and the value is
11439 available during delivery in the &$authenticated_sender$& variable. If the
11440 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11441
11442 .vindex "&$qualify_domain$&"
11443 When a message is submitted locally (that is, not over a TCP connection), the
11444 value of &$authenticated_sender$& is an address constructed from the login
11445 name of the calling process and &$qualify_domain$&, except that a trusted user
11446 can override this by means of the &%-oMas%& command line option.
11447
11448
11449 .vitem &$authentication_failed$&
11450 .cindex "authentication" "failure"
11451 .vindex "&$authentication_failed$&"
11452 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11453 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11454 possible to distinguish between &"did not try to authenticate"&
11455 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11456 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11457 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11458 negative response to an AUTH command, including (for example) an attempt to use
11459 an undefined mechanism.
11460
11461 .vitem &$av_failed$&
11462 .cindex "content scanning" "AV scanner failure"
11463 This variable is available when Exim is compiled with the content-scanning
11464 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11465 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11466 the ACL malware condition.
11467
11468 .vitem &$body_linecount$&
11469 .cindex "message body" "line count"
11470 .cindex "body of message" "line count"
11471 .vindex "&$body_linecount$&"
11472 When a message is being received or delivered, this variable contains the
11473 number of lines in the message's body. See also &$message_linecount$&.
11474
11475 .vitem &$body_zerocount$&
11476 .cindex "message body" "binary zero count"
11477 .cindex "body of message" "binary zero count"
11478 .cindex "binary zero" "in message body"
11479 .vindex "&$body_zerocount$&"
11480 When a message is being received or delivered, this variable contains the
11481 number of binary zero bytes (ASCII NULs) in the message's body.
11482
11483 .vitem &$bounce_recipient$&
11484 .vindex "&$bounce_recipient$&"
11485 This is set to the recipient address of a bounce message while Exim is creating
11486 it. It is useful if a customized bounce message text file is in use (see
11487 chapter &<<CHAPemsgcust>>&).
11488
11489 .vitem &$bounce_return_size_limit$&
11490 .vindex "&$bounce_return_size_limit$&"
11491 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11492 up to a multiple of 1000. It is useful when a customized error message text
11493 file is in use (see chapter &<<CHAPemsgcust>>&).
11494
11495 .vitem &$caller_gid$&
11496 .cindex "gid (group id)" "caller"
11497 .vindex "&$caller_gid$&"
11498 The real group id under which the process that called Exim was running. This is
11499 not the same as the group id of the originator of a message (see
11500 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11501 incarnation normally contains the Exim gid.
11502
11503 .vitem &$caller_uid$&
11504 .cindex "uid (user id)" "caller"
11505 .vindex "&$caller_uid$&"
11506 The real user id under which the process that called Exim was running. This is
11507 not the same as the user id of the originator of a message (see
11508 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11509 incarnation normally contains the Exim uid.
11510
11511 .vitem &$callout_address$&
11512 .vindex "&$callout_address$&"
11513 After a callout for verification, spamd or malware daemon service, the
11514 address that was connected to.
11515
11516 .vitem &$compile_number$&
11517 .vindex "&$compile_number$&"
11518 The building process for Exim keeps a count of the number
11519 of times it has been compiled. This serves to distinguish different
11520 compilations of the same version of the program.
11521
11522 .vitem &$config_dir$&
11523 .vindex "&$config_dir$&"
11524 The directory name of the main configuration file. That is, the content of
11525 &$config_file$& with the last component stripped. The value does not
11526 contain the trailing slash. If &$config_file$& does not contain a slash,
11527 &$config_dir$& is ".".
11528
11529 .vitem &$config_file$&
11530 .vindex "&$config_file$&"
11531 The name of the main configuration file Exim is using.
11532
11533 .vitem &$demime_errorlevel$&
11534 .vindex "&$demime_errorlevel$&"
11535 This variable is available when Exim is compiled with
11536 the content-scanning extension and the obsolete &%demime%& condition. For
11537 details, see section &<<SECTdemimecond>>&.
11538
11539 .vitem &$demime_reason$&
11540 .vindex "&$demime_reason$&"
11541 This variable is available when Exim is compiled with the
11542 content-scanning extension and the obsolete &%demime%& condition. For details,
11543 see section &<<SECTdemimecond>>&.
11544
11545 .vitem &$dkim_cur_signer$& &&&
11546        &$dkim_verify_status$& &&&
11547        &$dkim_verify_reason$& &&&
11548        &$dkim_domain$& &&&
11549        &$dkim_identity$& &&&
11550        &$dkim_selector$& &&&
11551        &$dkim_algo$& &&&
11552        &$dkim_canon_body$& &&&
11553        &$dkim_canon_headers$& &&&
11554        &$dkim_copiedheaders$& &&&
11555        &$dkim_bodylength$& &&&
11556        &$dkim_created$& &&&
11557        &$dkim_expires$& &&&
11558        &$dkim_headernames$& &&&
11559        &$dkim_key_testing$& &&&
11560        &$dkim_key_nosubdomains$& &&&
11561        &$dkim_key_srvtype$& &&&
11562        &$dkim_key_granularity$& &&&
11563        &$dkim_key_notes$& &&&
11564        &$dkim_key_length$&
11565 These variables are only available within the DKIM ACL.
11566 For details see chapter &<<CHAPdkim>>&.
11567
11568 .vitem &$dkim_signers$&
11569 .vindex &$dkim_signers$&
11570 When a message has been received this variable contains
11571 a colon-separated list of signer domains and identities for the message.
11572 For details see chapter &<<CHAPdkim>>&.
11573
11574 .vitem &$dnslist_domain$& &&&
11575        &$dnslist_matched$& &&&
11576        &$dnslist_text$& &&&
11577        &$dnslist_value$&
11578 .vindex "&$dnslist_domain$&"
11579 .vindex "&$dnslist_matched$&"
11580 .vindex "&$dnslist_text$&"
11581 .vindex "&$dnslist_value$&"
11582 .cindex "black list (DNS)"
11583 When a DNS (black) list lookup succeeds, these variables are set to contain
11584 the following data from the lookup: the list's domain name, the key that was
11585 looked up, the contents of any associated TXT record, and the value from the
11586 main A record. See section &<<SECID204>>& for more details.
11587
11588 .vitem &$domain$&
11589 .vindex "&$domain$&"
11590 When an address is being routed, or delivered on its own, this variable
11591 contains the domain. Uppercase letters in the domain are converted into lower
11592 case for &$domain$&.
11593
11594 Global address rewriting happens when a message is received, so the value of
11595 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11596 is set during user filtering, but not during system filtering, because a
11597 message may have many recipients and the system filter is called just once.
11598
11599 When more than one address is being delivered at once (for example, several
11600 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11601 have the same domain. Transports can be restricted to handling only one domain
11602 at a time if the value of &$domain$& is required at transport time &-- this is
11603 the default for local transports. For further details of the environment in
11604 which local transports are run, see chapter &<<CHAPenvironment>>&.
11605
11606 .oindex "&%delay_warning_condition%&"
11607 At the end of a delivery, if all deferred addresses have the same domain, it is
11608 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11609
11610 The &$domain$& variable is also used in some other circumstances:
11611
11612 .ilist
11613 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11614 the recipient address. The domain of the &'sender'& address is in
11615 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11616 normally set during the running of the MAIL ACL. However, if the sender address
11617 is verified with a callout during the MAIL ACL, the sender domain is placed in
11618 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11619 the &(smtp)& transport.
11620
11621 .next
11622 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11623 &$domain$& contains the domain portion of the address that is being rewritten;
11624 it can be used in the expansion of the replacement address, for example, to
11625 rewrite domains by file lookup.
11626
11627 .next
11628 With one important exception, whenever a domain list is being scanned,
11629 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11630 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11631 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11632 that, in a RCPT ACL, the sender domain list can be dependent on the
11633 recipient domain (which is what is in &$domain$& at this time).
11634
11635 .next
11636 .cindex "ETRN" "value of &$domain$&"
11637 .oindex "&%smtp_etrn_command%&"
11638 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11639 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11640 .endlist
11641
11642
11643 .vitem &$domain_data$&
11644 .vindex "&$domain_data$&"
11645 When the &%domains%& option on a router matches a domain by
11646 means of a lookup, the data read by the lookup is available during the running
11647 of the router as &$domain_data$&. In addition, if the driver routes the
11648 address to a transport, the value is available in that transport. If the
11649 transport is handling multiple addresses, the value from the first address is
11650 used.
11651
11652 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11653 domain by means of a lookup. The data read by the lookup is available during
11654 the rest of the ACL statement. In all other situations, this variable expands
11655 to nothing.
11656
11657 .vitem &$exim_gid$&
11658 .vindex "&$exim_gid$&"
11659 This variable contains the numerical value of the Exim group id.
11660
11661 .vitem &$exim_path$&
11662 .vindex "&$exim_path$&"
11663 This variable contains the path to the Exim binary.
11664
11665 .vitem &$exim_uid$&
11666 .vindex "&$exim_uid$&"
11667 This variable contains the numerical value of the Exim user id.
11668
11669 .vitem &$exim_version$&
11670 .vindex "&$exim_version$&"
11671 This variable contains the version string of the Exim build.
11672 The first character is a major version number, currently 4.
11673 Then after a dot, the next group of digits is a minor version number.
11674 There may be other characters following the minor version.
11675
11676 .vitem &$found_extension$&
11677 .vindex "&$found_extension$&"
11678 This variable is available when Exim is compiled with the
11679 content-scanning extension and the obsolete &%demime%& condition. For details,
11680 see section &<<SECTdemimecond>>&.
11681
11682 .vitem &$header_$&<&'name'&>
11683 This is not strictly an expansion variable. It is expansion syntax for
11684 inserting the message header line with the given name. Note that the name must
11685 be terminated by colon or white space, because it may contain a wide variety of
11686 characters. Note also that braces must &'not'& be used.
11687
11688 .vitem &$headers_added$&
11689 .vindex "&$headers_added$&"
11690 Within an ACL this variable contains the headers added so far by
11691 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11692 The headers are a newline-separated list.
11693
11694 .vitem &$home$&
11695 .vindex "&$home$&"
11696 When the &%check_local_user%& option is set for a router, the user's home
11697 directory is placed in &$home$& when the check succeeds. In particular, this
11698 means it is set during the running of users' filter files. A router may also
11699 explicitly set a home directory for use by a transport; this can be overridden
11700 by a setting on the transport itself.
11701
11702 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11703 of the environment variable HOME, which is subject to the
11704 &%keep_environment%& and &%add_environment%& main config options.
11705
11706 .vitem &$host$&
11707 .vindex "&$host$&"
11708 If a router assigns an address to a transport (any transport), and passes a
11709 list of hosts with the address, the value of &$host$& when the transport starts
11710 to run is the name of the first host on the list. Note that this applies both
11711 to local and remote transports.
11712
11713 .cindex "transport" "filter"
11714 .cindex "filter" "transport filter"
11715 For the &(smtp)& transport, if there is more than one host, the value of
11716 &$host$& changes as the transport works its way through the list. In
11717 particular, when the &(smtp)& transport is expanding its options for encryption
11718 using TLS, or for specifying a transport filter (see chapter
11719 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11720 is connected.
11721
11722 When used in the client part of an authenticator configuration (see chapter
11723 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11724 client is connected.
11725
11726
11727 .vitem &$host_address$&
11728 .vindex "&$host_address$&"
11729 This variable is set to the remote host's IP address whenever &$host$& is set
11730 for a remote connection. It is also set to the IP address that is being checked
11731 when the &%ignore_target_hosts%& option is being processed.
11732
11733 .vitem &$host_data$&
11734 .vindex "&$host_data$&"
11735 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11736 result of the lookup is made available in the &$host_data$& variable. This
11737 allows you, for example, to do things like this:
11738 .code
11739 deny  hosts = net-lsearch;/some/file
11740 message = $host_data
11741 .endd
11742 .vitem &$host_lookup_deferred$&
11743 .cindex "host name" "lookup, failure of"
11744 .vindex "&$host_lookup_deferred$&"
11745 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11746 message comes from a remote host and there is an attempt to look up the host's
11747 name from its IP address, and the attempt is not successful, one of these
11748 variables is set to &"1"&.
11749
11750 .ilist
11751 If the lookup receives a definite negative response (for example, a DNS lookup
11752 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11753
11754 .next
11755 If there is any kind of problem during the lookup, such that Exim cannot
11756 tell whether or not the host name is defined (for example, a timeout for a DNS
11757 lookup), &$host_lookup_deferred$& is set to &"1"&.
11758 .endlist ilist
11759
11760 Looking up a host's name from its IP address consists of more than just a
11761 single reverse lookup. Exim checks that a forward lookup of at least one of the
11762 names it receives from a reverse lookup yields the original IP address. If this
11763 is not the case, Exim does not accept the looked up name(s), and
11764 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11765 IP address (for example, the existence of a PTR record in the DNS) is not
11766 sufficient on its own for the success of a host name lookup. If the reverse
11767 lookup succeeds, but there is a lookup problem such as a timeout when checking
11768 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11769 &"1"&. See also &$sender_host_name$&.
11770
11771 .vitem &$host_lookup_failed$&
11772 .vindex "&$host_lookup_failed$&"
11773 See &$host_lookup_deferred$&.
11774
11775 .vitem &$host_port$&
11776 .vindex "&$host_port$&"
11777 This variable is set to the remote host's TCP port whenever &$host$& is set
11778 for an outbound connection.
11779
11780 .vitem &$initial_cwd$&
11781 .vindex "&$initial_cwd$&
11782 This variable contains the full path name of the initial working
11783 directory of the current Exim process. This may differ from the current
11784 working directory, as Exim changes this to "/" during early startup, and
11785 to &$spool_directory$& later.
11786
11787 .vitem &$inode$&
11788 .vindex "&$inode$&"
11789 The only time this variable is set is while expanding the &%directory_file%&
11790 option in the &(appendfile)& transport. The variable contains the inode number
11791 of the temporary file which is about to be renamed. It can be used to construct
11792 a unique name for the file.
11793
11794 .vitem &$interface_address$&
11795 .vindex "&$interface_address$&"
11796 This is an obsolete name for &$received_ip_address$&.
11797
11798 .vitem &$interface_port$&
11799 .vindex "&$interface_port$&"
11800 This is an obsolete name for &$received_port$&.
11801
11802 .vitem &$item$&
11803 .vindex "&$item$&"
11804 This variable is used during the expansion of &*forall*& and &*forany*&
11805 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11806 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11807 empty.
11808
11809 .vitem &$ldap_dn$&
11810 .vindex "&$ldap_dn$&"
11811 This variable, which is available only when Exim is compiled with LDAP support,
11812 contains the DN from the last entry in the most recently successful LDAP
11813 lookup.
11814
11815 .vitem &$load_average$&
11816 .vindex "&$load_average$&"
11817 This variable contains the system load average, multiplied by 1000 so that it
11818 is an integer. For example, if the load average is 0.21, the value of the
11819 variable is 210. The value is recomputed every time the variable is referenced.
11820
11821 .vitem &$local_part$&
11822 .vindex "&$local_part$&"
11823 When an address is being routed, or delivered on its own, this
11824 variable contains the local part. When a number of addresses are being
11825 delivered together (for example, multiple RCPT commands in an SMTP
11826 session), &$local_part$& is not set.
11827
11828 Global address rewriting happens when a message is received, so the value of
11829 &$local_part$& during routing and delivery is the value after rewriting.
11830 &$local_part$& is set during user filtering, but not during system filtering,
11831 because a message may have many recipients and the system filter is called just
11832 once.
11833
11834 .vindex "&$local_part_prefix$&"
11835 .vindex "&$local_part_suffix$&"
11836 If a local part prefix or suffix has been recognized, it is not included in the
11837 value of &$local_part$& during routing and subsequent delivery. The values of
11838 any prefix or suffix are in &$local_part_prefix$& and
11839 &$local_part_suffix$&, respectively.
11840
11841 When a message is being delivered to a file, pipe, or autoreply transport as a
11842 result of aliasing or forwarding, &$local_part$& is set to the local part of
11843 the parent address, not to the file name or command (see &$address_file$& and
11844 &$address_pipe$&).
11845
11846 When an ACL is running for a RCPT command, &$local_part$& contains the
11847 local part of the recipient address.
11848
11849 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11850 &$local_part$& contains the local part of the address that is being rewritten;
11851 it can be used in the expansion of the replacement address, for example.
11852
11853 In all cases, all quoting is removed from the local part. For example, for both
11854 the addresses
11855 .code
11856 "abc:xyz"@test.example
11857 abc\:xyz@test.example
11858 .endd
11859 the value of &$local_part$& is
11860 .code
11861 abc:xyz
11862 .endd
11863 If you use &$local_part$& to create another address, you should always wrap it
11864 inside a quoting operator. For example, in a &(redirect)& router you could
11865 have:
11866 .code
11867 data = ${quote_local_part:$local_part}@new.domain.example
11868 .endd
11869 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11870 to process local parts in a case-dependent manner in a router, you can set the
11871 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11872
11873 .vitem &$local_part_data$&
11874 .vindex "&$local_part_data$&"
11875 When the &%local_parts%& option on a router matches a local part by means of a
11876 lookup, the data read by the lookup is available during the running of the
11877 router as &$local_part_data$&. In addition, if the driver routes the address
11878 to a transport, the value is available in that transport. If the transport is
11879 handling multiple addresses, the value from the first address is used.
11880
11881 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11882 matches a local part by means of a lookup. The data read by the lookup is
11883 available during the rest of the ACL statement. In all other situations, this
11884 variable expands to nothing.
11885
11886 .vitem &$local_part_prefix$&
11887 .vindex "&$local_part_prefix$&"
11888 When an address is being routed or delivered, and a
11889 specific prefix for the local part was recognized, it is available in this
11890 variable, having been removed from &$local_part$&.
11891
11892 .vitem &$local_part_suffix$&
11893 .vindex "&$local_part_suffix$&"
11894 When an address is being routed or delivered, and a
11895 specific suffix for the local part was recognized, it is available in this
11896 variable, having been removed from &$local_part$&.
11897
11898 .vitem &$local_scan_data$&
11899 .vindex "&$local_scan_data$&"
11900 This variable contains the text returned by the &[local_scan()]& function when
11901 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11902
11903 .vitem &$local_user_gid$&
11904 .vindex "&$local_user_gid$&"
11905 See &$local_user_uid$&.
11906
11907 .vitem &$local_user_uid$&
11908 .vindex "&$local_user_uid$&"
11909 This variable and &$local_user_gid$& are set to the uid and gid after the
11910 &%check_local_user%& router precondition succeeds. This means that their values
11911 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11912 and &%condition%&), for the &%address_data%& expansion, and for any
11913 router-specific expansions. At all other times, the values in these variables
11914 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11915
11916 .vitem &$localhost_number$&
11917 .vindex "&$localhost_number$&"
11918 This contains the expanded value of the
11919 &%localhost_number%& option. The expansion happens after the main options have
11920 been read.
11921
11922 .vitem &$log_inodes$&
11923 .vindex "&$log_inodes$&"
11924 The number of free inodes in the disk partition where Exim's
11925 log files are being written. The value is recalculated whenever the variable is
11926 referenced. If the relevant file system does not have the concept of inodes,
11927 the value of is -1. See also the &%check_log_inodes%& option.
11928
11929 .vitem &$log_space$&
11930 .vindex "&$log_space$&"
11931 The amount of free space (as a number of kilobytes) in the disk
11932 partition where Exim's log files are being written. The value is recalculated
11933 whenever the variable is referenced. If the operating system does not have the
11934 ability to find the amount of free space (only true for experimental systems),
11935 the space value is -1. See also the &%check_log_space%& option.
11936
11937
11938 .vitem &$lookup_dnssec_authenticated$&
11939 .vindex "&$lookup_dnssec_authenticated$&"
11940 This variable is set after a DNS lookup done by
11941 a dnsdb lookup expansion, dnslookup router or smtp transport.
11942 .cindex "DNS" "DNSSEC"
11943 It will be empty if &(DNSSEC)& was not requested,
11944 &"no"& if the result was not labelled as authenticated data
11945 and &"yes"& if it was.
11946 Results that are labelled as authoritative answer that match
11947 the &%dns_trust_aa%& configuration variable count also
11948 as authenticated data.
11949
11950 .vitem &$mailstore_basename$&
11951 .vindex "&$mailstore_basename$&"
11952 This variable is set only when doing deliveries in &"mailstore"& format in the
11953 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11954 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11955 contains the basename of the files that are being written, that is, the name
11956 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11957 variable is empty.
11958
11959 .vitem &$malware_name$&
11960 .vindex "&$malware_name$&"
11961 This variable is available when Exim is compiled with the
11962 content-scanning extension. It is set to the name of the virus that was found
11963 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11964
11965 .vitem &$max_received_linelength$&
11966 .vindex "&$max_received_linelength$&"
11967 .cindex "maximum" "line length"
11968 .cindex "line length" "maximum"
11969 This variable contains the number of bytes in the longest line that was
11970 received as part of the message, not counting the line termination
11971 character(s).
11972
11973 .vitem &$message_age$&
11974 .cindex "message" "age of"
11975 .vindex "&$message_age$&"
11976 This variable is set at the start of a delivery attempt to contain the number
11977 of seconds since the message was received. It does not change during a single
11978 delivery attempt.
11979
11980 .vitem &$message_body$&
11981 .cindex "body of message" "expansion variable"
11982 .cindex "message body" "in expansion"
11983 .cindex "binary zero" "in message body"
11984 .vindex "&$message_body$&"
11985 .oindex "&%message_body_visible%&"
11986 This variable contains the initial portion of a message's body while it is
11987 being delivered, and is intended mainly for use in filter files. The maximum
11988 number of characters of the body that are put into the variable is set by the
11989 &%message_body_visible%& configuration option; the default is 500.
11990
11991 .oindex "&%message_body_newlines%&"
11992 By default, newlines are converted into spaces in &$message_body$&, to make it
11993 easier to search for phrases that might be split over a line break. However,
11994 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11995 zeros are always converted into spaces.
11996
11997 .vitem &$message_body_end$&
11998 .cindex "body of message" "expansion variable"
11999 .cindex "message body" "in expansion"
12000 .vindex "&$message_body_end$&"
12001 This variable contains the final portion of a message's
12002 body while it is being delivered. The format and maximum size are as for
12003 &$message_body$&.
12004
12005 .vitem &$message_body_size$&
12006 .cindex "body of message" "size"
12007 .cindex "message body" "size"
12008 .vindex "&$message_body_size$&"
12009 When a message is being delivered, this variable contains the size of the body
12010 in bytes. The count starts from the character after the blank line that
12011 separates the body from the header. Newlines are included in the count. See
12012 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12013
12014 .vitem &$message_exim_id$&
12015 .vindex "&$message_exim_id$&"
12016 When a message is being received or delivered, this variable contains the
12017 unique message id that is generated and used by Exim to identify the message.
12018 An id is not created for a message until after its header has been successfully
12019 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12020 line; it is the local id that Exim assigns to the message, for example:
12021 &`1BXTIK-0001yO-VA`&.
12022
12023 .vitem &$message_headers$&
12024 .vindex &$message_headers$&
12025 This variable contains a concatenation of all the header lines when a message
12026 is being processed, except for lines added by routers or transports. The header
12027 lines are separated by newline characters. Their contents are decoded in the
12028 same way as a header line that is inserted by &%bheader%&.
12029
12030 .vitem &$message_headers_raw$&
12031 .vindex &$message_headers_raw$&
12032 This variable is like &$message_headers$& except that no processing of the
12033 contents of header lines is done.
12034
12035 .vitem &$message_id$&
12036 This is an old name for &$message_exim_id$&. It is now deprecated.
12037
12038 .vitem &$message_linecount$&
12039 .vindex "&$message_linecount$&"
12040 This variable contains the total number of lines in the header and body of the
12041 message. Compare &$body_linecount$&, which is the count for the body only.
12042 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12043 number of lines received. Before delivery happens (that is, before filters,
12044 routers, and transports run) the count is increased to include the
12045 &'Received:'& header line that Exim standardly adds, and also any other header
12046 lines that are added by ACLs. The blank line that separates the message header
12047 from the body is not counted.
12048
12049 As with the special case of &$message_size$&, during the expansion of the
12050 appendfile transport's maildir_tag option in maildir format, the value of
12051 &$message_linecount$& is the precise size of the number of newlines in the
12052 file that has been written (minus one for the blank line between the
12053 header and the body).
12054
12055 Here is an example of the use of this variable in a DATA ACL:
12056 .code
12057 deny message   = Too many lines in message header
12058      condition = \
12059       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12060 .endd
12061 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12062 message has not yet been received.
12063
12064 .vitem &$message_size$&
12065 .cindex "size" "of message"
12066 .cindex "message" "size"
12067 .vindex "&$message_size$&"
12068 When a message is being processed, this variable contains its size in bytes. In
12069 most cases, the size includes those headers that were received with the
12070 message, but not those (such as &'Envelope-to:'&) that are added to individual
12071 deliveries as they are written. However, there is one special case: during the
12072 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12073 doing a delivery in maildir format, the value of &$message_size$& is the
12074 precise size of the file that has been written. See also
12075 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12076
12077 .cindex "RCPT" "value of &$message_size$&"
12078 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12079 contains the size supplied on the MAIL command, or -1 if no size was given. The
12080 value may not, of course, be truthful.
12081
12082 .vitem &$mime_$&&'xxx'&
12083 A number of variables whose names start with &$mime$& are
12084 available when Exim is compiled with the content-scanning extension. For
12085 details, see section &<<SECTscanmimepart>>&.
12086
12087 .vitem "&$n0$& &-- &$n9$&"
12088 These variables are counters that can be incremented by means
12089 of the &%add%& command in filter files.
12090
12091 .vitem &$original_domain$&
12092 .vindex "&$domain$&"
12093 .vindex "&$original_domain$&"
12094 When a top-level address is being processed for delivery, this contains the
12095 same value as &$domain$&. However, if a &"child"& address (for example,
12096 generated by an alias, forward, or filter file) is being processed, this
12097 variable contains the domain of the original address (lower cased). This
12098 differs from &$parent_domain$& only when there is more than one level of
12099 aliasing or forwarding. When more than one address is being delivered in a
12100 single transport run, &$original_domain$& is not set.
12101
12102 If a new address is created by means of a &%deliver%& command in a system
12103 filter, it is set up with an artificial &"parent"& address. This has the local
12104 part &'system-filter'& and the default qualify domain.
12105
12106 .vitem &$original_local_part$&
12107 .vindex "&$local_part$&"
12108 .vindex "&$original_local_part$&"
12109 When a top-level address is being processed for delivery, this contains the
12110 same value as &$local_part$&, unless a prefix or suffix was removed from the
12111 local part, because &$original_local_part$& always contains the full local
12112 part. When a &"child"& address (for example, generated by an alias, forward, or
12113 filter file) is being processed, this variable contains the full local part of
12114 the original address.
12115
12116 If the router that did the redirection processed the local part
12117 case-insensitively, the value in &$original_local_part$& is in lower case.
12118 This variable differs from &$parent_local_part$& only when there is more than
12119 one level of aliasing or forwarding. When more than one address is being
12120 delivered in a single transport run, &$original_local_part$& is not set.
12121
12122 If a new address is created by means of a &%deliver%& command in a system
12123 filter, it is set up with an artificial &"parent"& address. This has the local
12124 part &'system-filter'& and the default qualify domain.
12125
12126 .vitem &$originator_gid$&
12127 .cindex "gid (group id)" "of originating user"
12128 .cindex "sender" "gid"
12129 .vindex "&$caller_gid$&"
12130 .vindex "&$originator_gid$&"
12131 This variable contains the value of &$caller_gid$& that was set when the
12132 message was received. For messages received via the command line, this is the
12133 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12134 normally the gid of the Exim user.
12135
12136 .vitem &$originator_uid$&
12137 .cindex "uid (user id)" "of originating user"
12138 .cindex "sender" "uid"
12139 .vindex "&$caller_uid$&"
12140 .vindex "&$originaltor_uid$&"
12141 The value of &$caller_uid$& that was set when the message was received. For
12142 messages received via the command line, this is the uid of the sending user.
12143 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12144 user.
12145
12146 .vitem &$parent_domain$&
12147 .vindex "&$parent_domain$&"
12148 This variable is similar to &$original_domain$& (see
12149 above), except that it refers to the immediately preceding parent address.
12150
12151 .vitem &$parent_local_part$&
12152 .vindex "&$parent_local_part$&"
12153 This variable is similar to &$original_local_part$&
12154 (see above), except that it refers to the immediately preceding parent address.
12155
12156 .vitem &$pid$&
12157 .cindex "pid (process id)" "of current process"
12158 .vindex "&$pid$&"
12159 This variable contains the current process id.
12160
12161 .vitem &$pipe_addresses$&
12162 .cindex "filter" "transport filter"
12163 .cindex "transport" "filter"
12164 .vindex "&$pipe_addresses$&"
12165 This is not an expansion variable, but is mentioned here because the string
12166 &`$pipe_addresses`& is handled specially in the command specification for the
12167 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12168 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12169 It cannot be used in general expansion strings, and provokes an &"unknown
12170 variable"& error if encountered.
12171
12172 .vitem &$primary_hostname$&
12173 .vindex "&$primary_hostname$&"
12174 This variable contains the value set by &%primary_hostname%& in the
12175 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12176 a single-component name, Exim calls &[gethostbyname()]& (or
12177 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12178 qualified host name. See also &$smtp_active_hostname$&.
12179
12180
12181 .new
12182 .vitem &$proxy_host_address$& &&&
12183        &$proxy_host_port$& &&&
12184        &$proxy_target_address$& &&&
12185        &$proxy_target_port$& &&&
12186        &$proxy_session$&
12187 These variables are only available when built with Proxy Protocol
12188 or Socks5 support
12189 For details see chapter &<<SECTproxyInbound>>&.
12190 .wen
12191
12192 .new
12193 .vitem &$prdr_requested$&
12194 .cindex "PRDR" "variable for"
12195 This variable is set to &"yes"& if PRDR was requested by the client for the
12196 current message, otherwise &"no"&.
12197 .wen
12198
12199 .vitem &$prvscheck_address$&
12200 This variable is used in conjunction with the &%prvscheck%& expansion item,
12201 which is described in sections &<<SECTexpansionitems>>& and
12202 &<<SECTverifyPRVS>>&.
12203
12204 .vitem &$prvscheck_keynum$&
12205 This variable is used in conjunction with the &%prvscheck%& expansion item,
12206 which is described in sections &<<SECTexpansionitems>>& and
12207 &<<SECTverifyPRVS>>&.
12208
12209 .vitem &$prvscheck_result$&
12210 This variable is used in conjunction with the &%prvscheck%& expansion item,
12211 which is described in sections &<<SECTexpansionitems>>& and
12212 &<<SECTverifyPRVS>>&.
12213
12214 .vitem &$qualify_domain$&
12215 .vindex "&$qualify_domain$&"
12216 The value set for the &%qualify_domain%& option in the configuration file.
12217
12218 .vitem &$qualify_recipient$&
12219 .vindex "&$qualify_recipient$&"
12220 The value set for the &%qualify_recipient%& option in the configuration file,
12221 or if not set, the value of &$qualify_domain$&.
12222
12223 .vitem &$rcpt_count$&
12224 .vindex "&$rcpt_count$&"
12225 When a message is being received by SMTP, this variable contains the number of
12226 RCPT commands received for the current message. If this variable is used in a
12227 RCPT ACL, its value includes the current command.
12228
12229 .vitem &$rcpt_defer_count$&
12230 .vindex "&$rcpt_defer_count$&"
12231 .cindex "4&'xx'& responses" "count of"
12232 When a message is being received by SMTP, this variable contains the number of
12233 RCPT commands in the current message that have previously been rejected with a
12234 temporary (4&'xx'&) response.
12235
12236 .vitem &$rcpt_fail_count$&
12237 .vindex "&$rcpt_fail_count$&"
12238 When a message is being received by SMTP, this variable contains the number of
12239 RCPT commands in the current message that have previously been rejected with a
12240 permanent (5&'xx'&) response.
12241
12242 .vitem &$received_count$&
12243 .vindex "&$received_count$&"
12244 This variable contains the number of &'Received:'& header lines in the message,
12245 including the one added by Exim (so its value is always greater than zero). It
12246 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12247 delivering.
12248
12249 .vitem &$received_for$&
12250 .vindex "&$received_for$&"
12251 If there is only a single recipient address in an incoming message, this
12252 variable contains that address when the &'Received:'& header line is being
12253 built. The value is copied after recipient rewriting has happened, but before
12254 the &[local_scan()]& function is run.
12255
12256 .vitem &$received_ip_address$&
12257 .vindex "&$received_ip_address$&"
12258 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12259 variable is set to the address of the local IP interface, and &$received_port$&
12260 is set to the local port number. (The remote IP address and port are in
12261 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12262 the port value is -1 unless it has been set using the &%-oMi%& command line
12263 option.
12264
12265 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12266 could be used, for example, to make the file name for a TLS certificate depend
12267 on which interface and/or port is being used for the incoming connection. The
12268 values of &$received_ip_address$& and &$received_port$& are saved with any
12269 messages that are received, thus making these variables available at delivery
12270 time.
12271 For outbound connections see &$sending_ip_address$&.
12272
12273 .vitem &$received_port$&
12274 .vindex "&$received_port$&"
12275 See &$received_ip_address$&.
12276
12277 .vitem &$received_protocol$&
12278 .vindex "&$received_protocol$&"
12279 When a message is being processed, this variable contains the name of the
12280 protocol by which it was received. Most of the names used by Exim are defined
12281 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12282 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12283 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12284 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12285 connection and the client was successfully authenticated.
12286
12287 Exim uses the protocol name &"smtps"& for the case when encryption is
12288 automatically set up on connection without the use of STARTTLS (see
12289 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12290 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12291 where the client initially uses EHLO, sets up an encrypted connection using
12292 STARTTLS, and then uses HELO afterwards.
12293
12294 The &%-oMr%& option provides a way of specifying a custom protocol name for
12295 messages that are injected locally by trusted callers. This is commonly used to
12296 identify messages that are being re-injected after some kind of scanning.
12297
12298 .vitem &$received_time$&
12299 .vindex "&$received_time$&"
12300 This variable contains the date and time when the current message was received,
12301 as a number of seconds since the start of the Unix epoch.
12302
12303 .vitem &$recipient_data$&
12304 .vindex "&$recipient_data$&"
12305 This variable is set after an indexing lookup success in an ACL &%recipients%&
12306 condition. It contains the data from the lookup, and the value remains set
12307 until the next &%recipients%& test. Thus, you can do things like this:
12308 .display
12309 &`require recipients  = cdb*@;/some/file`&
12310 &`deny    `&&'some further test involving'& &`$recipient_data`&
12311 .endd
12312 &*Warning*&: This variable is set only when a lookup is used as an indexing
12313 method in the address list, using the semicolon syntax as in the example above.
12314 The variable is not set for a lookup that is used as part of the string
12315 expansion that all such lists undergo before being interpreted.
12316
12317 .vitem &$recipient_verify_failure$&
12318 .vindex "&$recipient_verify_failure$&"
12319 In an ACL, when a recipient verification fails, this variable contains
12320 information about the failure. It is set to one of the following words:
12321
12322 .ilist
12323 &"qualify"&: The address was unqualified (no domain), and the message
12324 was neither local nor came from an exempted host.
12325
12326 .next
12327 &"route"&: Routing failed.
12328
12329 .next
12330 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12331 or before the MAIL command (that is, on initial connection, HELO, or
12332 MAIL).
12333
12334 .next
12335 &"recipient"&: The RCPT command in a callout was rejected.
12336 .next
12337
12338 &"postmaster"&: The postmaster check in a callout was rejected.
12339 .endlist
12340
12341 The main use of this variable is expected to be to distinguish between
12342 rejections of MAIL and rejections of RCPT.
12343
12344 .vitem &$recipients$&
12345 .vindex "&$recipients$&"
12346 This variable contains a list of envelope recipients for a message. A comma and
12347 a space separate the addresses in the replacement text. However, the variable
12348 is not generally available, to prevent exposure of Bcc recipients in
12349 unprivileged users' filter files. You can use &$recipients$& only in these
12350 cases:
12351
12352 .olist
12353 In a system filter file.
12354 .next
12355 In the ACLs associated with the DATA command and with non-SMTP messages, that
12356 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12357 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12358 &%acl_not_smtp_mime%&.
12359 .next
12360 From within a &[local_scan()]& function.
12361 .endlist
12362
12363
12364 .vitem &$recipients_count$&
12365 .vindex "&$recipients_count$&"
12366 When a message is being processed, this variable contains the number of
12367 envelope recipients that came with the message. Duplicates are not excluded
12368 from the count. While a message is being received over SMTP, the number
12369 increases for each accepted recipient. It can be referenced in an ACL.
12370
12371
12372 .vitem &$regex_match_string$&
12373 .vindex "&$regex_match_string$&"
12374 This variable is set to contain the matching regular expression after a
12375 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12376
12377 .vitem "&$regex1$&, &$regex2$&, etc"
12378 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12379 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12380 these variables contain the
12381 captured substrings identified by the regular expression.
12382
12383
12384 .vitem &$reply_address$&
12385 .vindex "&$reply_address$&"
12386 When a message is being processed, this variable contains the contents of the
12387 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12388 contents of the &'From:'& header line. Apart from the removal of leading
12389 white space, the value is not processed in any way. In particular, no RFC 2047
12390 decoding or character code translation takes place.
12391
12392 .vitem &$return_path$&
12393 .vindex "&$return_path$&"
12394 When a message is being delivered, this variable contains the return path &--
12395 the sender field that will be sent as part of the envelope. It is not enclosed
12396 in <> characters. At the start of routing an address, &$return_path$& has the
12397 same value as &$sender_address$&, but if, for example, an incoming message to a
12398 mailing list has been expanded by a router which specifies a different address
12399 for bounce messages, &$return_path$& subsequently contains the new bounce
12400 address, whereas &$sender_address$& always contains the original sender address
12401 that was received with the message. In other words, &$sender_address$& contains
12402 the incoming envelope sender, and &$return_path$& contains the outgoing
12403 envelope sender.
12404
12405 .vitem &$return_size_limit$&
12406 .vindex "&$return_size_limit$&"
12407 This is an obsolete name for &$bounce_return_size_limit$&.
12408
12409 .vitem &$router_name$&
12410 .cindex "router" "name"
12411 .cindex "name" "of router"
12412 .vindex "&$router_name$&"
12413 During the running of a router this variable contains its name.
12414
12415 .vitem &$runrc$&
12416 .cindex "return code" "from &%run%& expansion"
12417 .vindex "&$runrc$&"
12418 This variable contains the return code from a command that is run by the
12419 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12420 assume the order in which option values are expanded, except for those
12421 preconditions whose order of testing is documented. Therefore, you cannot
12422 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12423 another.
12424
12425 .vitem &$self_hostname$&
12426 .oindex "&%self%&" "value of host name"
12427 .vindex "&$self_hostname$&"
12428 When an address is routed to a supposedly remote host that turns out to be the
12429 local host, what happens is controlled by the &%self%& generic router option.
12430 One of its values causes the address to be passed to another router. When this
12431 happens, &$self_hostname$& is set to the name of the local host that the
12432 original router encountered. In other circumstances its contents are null.
12433
12434 .vitem &$sender_address$&
12435 .vindex "&$sender_address$&"
12436 When a message is being processed, this variable contains the sender's address
12437 that was received in the message's envelope. The case of letters in the address
12438 is retained, in both the local part and the domain. For bounce messages, the
12439 value of this variable is the empty string. See also &$return_path$&.
12440
12441 .vitem &$sender_address_data$&
12442 .vindex "&$address_data$&"
12443 .vindex "&$sender_address_data$&"
12444 If &$address_data$& is set when the routers are called from an ACL to verify a
12445 sender address, the final value is preserved in &$sender_address_data$&, to
12446 distinguish it from data from a recipient address. The value does not persist
12447 after the end of the current ACL statement. If you want to preserve it for
12448 longer, you can save it in an ACL variable.
12449
12450 .vitem &$sender_address_domain$&
12451 .vindex "&$sender_address_domain$&"
12452 The domain portion of &$sender_address$&.
12453
12454 .vitem &$sender_address_local_part$&
12455 .vindex "&$sender_address_local_part$&"
12456 The local part portion of &$sender_address$&.
12457
12458 .vitem &$sender_data$&
12459 .vindex "&$sender_data$&"
12460 This variable is set after a lookup success in an ACL &%senders%& condition or
12461 in a router &%senders%& option. It contains the data from the lookup, and the
12462 value remains set until the next &%senders%& test. Thus, you can do things like
12463 this:
12464 .display
12465 &`require senders      = cdb*@;/some/file`&
12466 &`deny    `&&'some further test involving'& &`$sender_data`&
12467 .endd
12468 &*Warning*&: This variable is set only when a lookup is used as an indexing
12469 method in the address list, using the semicolon syntax as in the example above.
12470 The variable is not set for a lookup that is used as part of the string
12471 expansion that all such lists undergo before being interpreted.
12472
12473 .vitem &$sender_fullhost$&
12474 .vindex "&$sender_fullhost$&"
12475 When a message is received from a remote host, this variable contains the host
12476 name and IP address in a single string. It ends with the IP address in square
12477 brackets, followed by a colon and a port number if the logging of ports is
12478 enabled. The format of the rest of the string depends on whether the host
12479 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12480 looking up its IP address. (Looking up the IP address can be forced by the
12481 &%host_lookup%& option, independent of verification.) A plain host name at the
12482 start of the string is a verified host name; if this is not present,
12483 verification either failed or was not requested. A host name in parentheses is
12484 the argument of a HELO or EHLO command. This is omitted if it is identical to
12485 the verified host name or to the host's IP address in square brackets.
12486
12487 .vitem &$sender_helo_dnssec$&
12488 .vindex "&$sender_helo_dnssec$&"
12489 This boolean variable is true if a successful HELO verification was
12490 .cindex "DNS" "DNSSEC"
12491 done using DNS information the resolver library stated was authenticated data.
12492
12493 .vitem &$sender_helo_name$&
12494 .vindex "&$sender_helo_name$&"
12495 When a message is received from a remote host that has issued a HELO or EHLO
12496 command, the argument of that command is placed in this variable. It is also
12497 set if HELO or EHLO is used when a message is received using SMTP locally via
12498 the &%-bs%& or &%-bS%& options.
12499
12500 .vitem &$sender_host_address$&
12501 .vindex "&$sender_host_address$&"
12502 When a message is received from a remote host using SMTP,
12503 this variable contains that
12504 host's IP address. For locally non-SMTP submitted messages, it is empty.
12505
12506 .vitem &$sender_host_authenticated$&
12507 .vindex "&$sender_host_authenticated$&"
12508 This variable contains the name (not the public name) of the authenticator
12509 driver that successfully authenticated the client from which the message was
12510 received. It is empty if there was no successful authentication. See also
12511 &$authenticated_id$&.
12512
12513 .vitem &$sender_host_dnssec$&
12514 .vindex "&$sender_host_dnssec$&"
12515 If an attempt to populate &$sender_host_name$& has been made
12516 (by reference, &%hosts_lookup%& or
12517 otherwise) then this boolean will have been set true if, and only if, the
12518 resolver library states that both
12519 the reverse and forward DNS were authenticated data.  At all
12520 other times, this variable is false.
12521
12522 .cindex "DNS" "DNSSEC"
12523 It is likely that you will need to coerce DNSSEC support on in the resolver
12524 library, by setting:
12525 .code
12526 dns_dnssec_ok = 1
12527 .endd
12528
12529 Exim does not perform DNSSEC validation itself, instead leaving that to a
12530 validating resolver (e.g. unbound, or bind with suitable configuration).
12531
12532 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12533 mechanism in the list, then this variable will be false.
12534
12535
12536 .vitem &$sender_host_name$&
12537 .vindex "&$sender_host_name$&"
12538 When a message is received from a remote host, this variable contains the
12539 host's name as obtained by looking up its IP address. For messages received by
12540 other means, this variable is empty.
12541
12542 .vindex "&$host_lookup_failed$&"
12543 If the host name has not previously been looked up, a reference to
12544 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12545 A looked up name is accepted only if it leads back to the original IP address
12546 via a forward lookup. If either the reverse or the forward lookup fails to find
12547 any data, or if the forward lookup does not yield the original IP address,
12548 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12549
12550 .vindex "&$host_lookup_deferred$&"
12551 However, if either of the lookups cannot be completed (for example, there is a
12552 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12553 &$host_lookup_failed$& remains set to &"0"&.
12554
12555 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12556 host name again if there is a subsequent reference to &$sender_host_name$&
12557 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12558 is set to &"1"&.
12559
12560 Exim does not automatically look up every calling host's name. If you want
12561 maximum efficiency, you should arrange your configuration so that it avoids
12562 these lookups altogether. The lookup happens only if one or more of the
12563 following are true:
12564
12565 .ilist
12566 A string containing &$sender_host_name$& is expanded.
12567 .next
12568 The calling host matches the list in &%host_lookup%&. In the default
12569 configuration, this option is set to *, so it must be changed if lookups are
12570 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12571 .next
12572 Exim needs the host name in order to test an item in a host list. The items
12573 that require this are described in sections &<<SECThoslispatnam>>& and
12574 &<<SECThoslispatnamsk>>&.
12575 .next
12576 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12577 In this case, the host name is required to compare with the name quoted in any
12578 EHLO or HELO commands that the client issues.
12579 .next
12580 The remote host issues a EHLO or HELO command that quotes one of the
12581 domains in &%helo_lookup_domains%&. The default value of this option is
12582 . ==== As this is a nested list, any displays it contains must be indented
12583 . ==== as otherwise they are too far to the left.
12584 .code
12585   helo_lookup_domains = @ : @[]
12586 .endd
12587 which causes a lookup if a remote host (incorrectly) gives the server's name or
12588 IP address in an EHLO or HELO command.
12589 .endlist
12590
12591
12592 .vitem &$sender_host_port$&
12593 .vindex "&$sender_host_port$&"
12594 When a message is received from a remote host, this variable contains the port
12595 number that was used on the remote host.
12596
12597 .vitem &$sender_ident$&
12598 .vindex "&$sender_ident$&"
12599 When a message is received from a remote host, this variable contains the
12600 identification received in response to an RFC 1413 request. When a message has
12601 been received locally, this variable contains the login name of the user that
12602 called Exim.
12603
12604 .vitem &$sender_rate_$&&'xxx'&
12605 A number of variables whose names begin &$sender_rate_$& are set as part of the
12606 &%ratelimit%& ACL condition. Details are given in section
12607 &<<SECTratelimiting>>&.
12608
12609 .vitem &$sender_rcvhost$&
12610 .cindex "DNS" "reverse lookup"
12611 .cindex "reverse DNS lookup"
12612 .vindex "&$sender_rcvhost$&"
12613 This is provided specifically for use in &'Received:'& headers. It starts with
12614 either the verified host name (as obtained from a reverse DNS lookup) or, if
12615 there is no verified host name, the IP address in square brackets. After that
12616 there may be text in parentheses. When the first item is a verified host name,
12617 the first thing in the parentheses is the IP address in square brackets,
12618 followed by a colon and a port number if port logging is enabled. When the
12619 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12620 the parentheses.
12621
12622 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12623 was used and its argument was not identical to the real host name or IP
12624 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12625 all three items are present in the parentheses, a newline and tab are inserted
12626 into the string, to improve the formatting of the &'Received:'& header.
12627
12628 .vitem &$sender_verify_failure$&
12629 .vindex "&$sender_verify_failure$&"
12630 In an ACL, when a sender verification fails, this variable contains information
12631 about the failure. The details are the same as for
12632 &$recipient_verify_failure$&.
12633
12634 .vitem &$sending_ip_address$&
12635 .vindex "&$sending_ip_address$&"
12636 This variable is set whenever an outgoing SMTP connection to another host has
12637 been set up. It contains the IP address of the local interface that is being
12638 used. This is useful if a host that has more than one IP address wants to take
12639 on different personalities depending on which one is being used. For incoming
12640 connections, see &$received_ip_address$&.
12641
12642 .vitem &$sending_port$&
12643 .vindex "&$sending_port$&"
12644 This variable is set whenever an outgoing SMTP connection to another host has
12645 been set up. It contains the local port that is being used. For incoming
12646 connections, see &$received_port$&.
12647
12648 .vitem &$smtp_active_hostname$&
12649 .vindex "&$smtp_active_hostname$&"
12650 During an incoming SMTP session, this variable contains the value of the active
12651 host name, as specified by the &%smtp_active_hostname%& option. The value of
12652 &$smtp_active_hostname$& is saved with any message that is received, so its
12653 value can be consulted during routing and delivery.
12654
12655 .vitem &$smtp_command$&
12656 .vindex "&$smtp_command$&"
12657 During the processing of an incoming SMTP command, this variable contains the
12658 entire command. This makes it possible to distinguish between HELO and EHLO in
12659 the HELO ACL, and also to distinguish between commands such as these:
12660 .code
12661 MAIL FROM:<>
12662 MAIL FROM: <>
12663 .endd
12664 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12665 command, the address in &$smtp_command$& is the original address before any
12666 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12667 the address after SMTP-time rewriting.
12668
12669 .vitem &$smtp_command_argument$&
12670 .cindex "SMTP" "command, argument for"
12671 .vindex "&$smtp_command_argument$&"
12672 While an ACL is running to check an SMTP command, this variable contains the
12673 argument, that is, the text that follows the command name, with leading white
12674 space removed. Following the introduction of &$smtp_command$&, this variable is
12675 somewhat redundant, but is retained for backwards compatibility.
12676
12677 .vitem &$smtp_count_at_connection_start$&
12678 .vindex "&$smtp_count_at_connection_start$&"
12679 This variable is set greater than zero only in processes spawned by the Exim
12680 daemon for handling incoming SMTP connections. The name is deliberately long,
12681 in order to emphasize what the contents are. When the daemon accepts a new
12682 connection, it increments this variable. A copy of the variable is passed to
12683 the child process that handles the connection, but its value is fixed, and
12684 never changes. It is only an approximation of how many incoming connections
12685 there actually are, because many other connections may come and go while a
12686 single connection is being processed. When a child process terminates, the
12687 daemon decrements its copy of the variable.
12688
12689 .vitem "&$sn0$& &-- &$sn9$&"
12690 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12691 that were current at the end of the system filter file. This allows a system
12692 filter file to set values that can be tested in users' filter files. For
12693 example, a system filter could set a value indicating how likely it is that a
12694 message is junk mail.
12695
12696 .vitem &$spam_$&&'xxx'&
12697 A number of variables whose names start with &$spam$& are available when Exim
12698 is compiled with the content-scanning extension. For details, see section
12699 &<<SECTscanspamass>>&.
12700
12701
12702 .vitem &$spool_directory$&
12703 .vindex "&$spool_directory$&"
12704 The name of Exim's spool directory.
12705
12706 .vitem &$spool_inodes$&
12707 .vindex "&$spool_inodes$&"
12708 The number of free inodes in the disk partition where Exim's spool files are
12709 being written. The value is recalculated whenever the variable is referenced.
12710 If the relevant file system does not have the concept of inodes, the value of
12711 is -1. See also the &%check_spool_inodes%& option.
12712
12713 .vitem &$spool_space$&
12714 .vindex "&$spool_space$&"
12715 The amount of free space (as a number of kilobytes) in the disk partition where
12716 Exim's spool files are being written. The value is recalculated whenever the
12717 variable is referenced. If the operating system does not have the ability to
12718 find the amount of free space (only true for experimental systems), the space
12719 value is -1. For example, to check in an ACL that there is at least 50
12720 megabytes free on the spool, you could write:
12721 .code
12722 condition = ${if > {$spool_space}{50000}}
12723 .endd
12724 See also the &%check_spool_space%& option.
12725
12726
12727 .vitem &$thisaddress$&
12728 .vindex "&$thisaddress$&"
12729 This variable is set only during the processing of the &%foranyaddress%&
12730 command in a filter file. Its use is explained in the description of that
12731 command, which can be found in the separate document entitled &'Exim's
12732 interfaces to mail filtering'&.
12733
12734 .vitem &$tls_in_bits$&
12735 .vindex "&$tls_in_bits$&"
12736 Contains an approximation of the TLS cipher's bit-strength
12737 on the inbound connection; the meaning of
12738 this depends upon the TLS implementation used.
12739 If TLS has not been negotiated, the value will be 0.
12740 The value of this is automatically fed into the Cyrus SASL authenticator
12741 when acting as a server, to specify the "external SSF" (a SASL term).
12742
12743 The deprecated &$tls_bits$& variable refers to the inbound side
12744 except when used in the context of an outbound SMTP delivery, when it refers to
12745 the outbound.
12746
12747 .vitem &$tls_out_bits$&
12748 .vindex "&$tls_out_bits$&"
12749 Contains an approximation of the TLS cipher's bit-strength
12750 on an outbound SMTP connection; the meaning of
12751 this depends upon the TLS implementation used.
12752 If TLS has not been negotiated, the value will be 0.
12753
12754 .vitem &$tls_in_ourcert$&
12755 .vindex "&$tls_in_ourcert$&"
12756 .cindex certificate veriables
12757 This variable refers to the certificate presented to the peer of an
12758 inbound connection when the message was received.
12759 It is only useful as the argument of a
12760 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12761 or a &%def%& condition.
12762
12763 .vitem &$tls_in_peercert$&
12764 .vindex "&$tls_in_peercert$&"
12765 This variable refers to the certificate presented by the peer of an
12766 inbound connection when the message was received.
12767 It is only useful as the argument of a
12768 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12769 or a &%def%& condition.
12770 If certificate verification fails it may refer to a failing chain element
12771 which is not the leaf.
12772
12773 .vitem &$tls_out_ourcert$&
12774 .vindex "&$tls_out_ourcert$&"
12775 This variable refers to the certificate presented to the peer of an
12776 outbound connection.  It is only useful as the argument of a
12777 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12778 or a &%def%& condition.
12779
12780 .vitem &$tls_out_peercert$&
12781 .vindex "&$tls_out_peercert$&"
12782 This variable refers to the certificate presented by the peer of an
12783 outbound connection.  It is only useful as the argument of a
12784 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12785 or a &%def%& condition.
12786 If certificate verification fails it may refer to a failing chain element
12787 which is not the leaf.
12788
12789 .vitem &$tls_in_certificate_verified$&
12790 .vindex "&$tls_in_certificate_verified$&"
12791 This variable is set to &"1"& if a TLS certificate was verified when the
12792 message was received, and &"0"& otherwise.
12793
12794 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12795 except when used in the context of an outbound SMTP delivery, when it refers to
12796 the outbound.
12797
12798 .vitem &$tls_out_certificate_verified$&
12799 .vindex "&$tls_out_certificate_verified$&"
12800 This variable is set to &"1"& if a TLS certificate was verified when an
12801 outbound SMTP connection was made,
12802 and &"0"& otherwise.
12803
12804 .vitem &$tls_in_cipher$&
12805 .vindex "&$tls_in_cipher$&"
12806 .vindex "&$tls_cipher$&"
12807 When a message is received from a remote host over an encrypted SMTP
12808 connection, this variable is set to the cipher suite that was negotiated, for
12809 example DES-CBC3-SHA. In other circumstances, in particular, for message
12810 received over unencrypted connections, the variable is empty. Testing
12811 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12812 non-encrypted connections during ACL processing.
12813
12814 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12815 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12816 becomes the same as &$tls_out_cipher$&.
12817
12818 .vitem &$tls_out_cipher$&
12819 .vindex "&$tls_out_cipher$&"
12820 This variable is
12821 cleared before any outgoing SMTP connection is made,
12822 and then set to the outgoing cipher suite if one is negotiated. See chapter
12823 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12824 details of the &(smtp)& transport.
12825
12826 .vitem &$tls_in_ocsp$&
12827 .vindex "&$tls_in_ocsp$&"
12828 When a message is received from a remote client connection
12829 the result of any OCSP request from the client is encoded in this variable:
12830 .code
12831 0 OCSP proof was not requested (default value)
12832 1 No response to request
12833 2 Response not verified
12834 3 Verification failed
12835 4 Verification succeeded
12836 .endd
12837
12838 .vitem &$tls_out_ocsp$&
12839 .vindex "&$tls_out_ocsp$&"
12840 When a message is sent to a remote host connection
12841 the result of any OCSP request made is encoded in this variable.
12842 See &$tls_in_ocsp$& for values.
12843
12844 .vitem &$tls_in_peerdn$&
12845 .vindex "&$tls_in_peerdn$&"
12846 .vindex "&$tls_peerdn$&"
12847 .cindex certificate "extracting fields"
12848 When a message is received from a remote host over an encrypted SMTP
12849 connection, and Exim is configured to request a certificate from the client,
12850 the value of the Distinguished Name of the certificate is made available in the
12851 &$tls_in_peerdn$& during subsequent processing.
12852 If certificate verification fails it may refer to a failing chain element
12853 which is not the leaf.
12854
12855 The deprecated &$tls_peerdn$& variable refers to the inbound side
12856 except when used in the context of an outbound SMTP delivery, when it refers to
12857 the outbound.
12858
12859 .vitem &$tls_out_peerdn$&
12860 .vindex "&$tls_out_peerdn$&"
12861 When a message is being delivered to a remote host over an encrypted SMTP
12862 connection, and Exim is configured to request a certificate from the server,
12863 the value of the Distinguished Name of the certificate is made available in the
12864 &$tls_out_peerdn$& during subsequent processing.
12865 If certificate verification fails it may refer to a failing chain element
12866 which is not the leaf.
12867
12868 .vitem &$tls_in_sni$&
12869 .vindex "&$tls_in_sni$&"
12870 .vindex "&$tls_sni$&"
12871 .cindex "TLS" "Server Name Indication"
12872 When a TLS session is being established, if the client sends the Server
12873 Name Indication extension, the value will be placed in this variable.
12874 If the variable appears in &%tls_certificate%& then this option and
12875 some others, described in &<<SECTtlssni>>&,
12876 will be re-expanded early in the TLS session, to permit
12877 a different certificate to be presented (and optionally a different key to be
12878 used) to the client, based upon the value of the SNI extension.
12879
12880 The deprecated &$tls_sni$& variable refers to the inbound side
12881 except when used in the context of an outbound SMTP delivery, when it refers to
12882 the outbound.
12883
12884 .vitem &$tls_out_sni$&
12885 .vindex "&$tls_out_sni$&"
12886 .cindex "TLS" "Server Name Indication"
12887 During outbound
12888 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12889 the transport.
12890
12891 .vitem &$tod_bsdinbox$&
12892 .vindex "&$tod_bsdinbox$&"
12893 The time of day and the date, in the format required for BSD-style mailbox
12894 files, for example: Thu Oct 17 17:14:09 1995.
12895
12896 .vitem &$tod_epoch$&
12897 .vindex "&$tod_epoch$&"
12898 The time and date as a number of seconds since the start of the Unix epoch.
12899
12900 .vitem &$tod_epoch_l$&
12901 .vindex "&$tod_epoch_l$&"
12902 The time and date as a number of microseconds since the start of the Unix epoch.
12903
12904 .vitem &$tod_full$&
12905 .vindex "&$tod_full$&"
12906 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12907 +0100. The timezone is always given as a numerical offset from UTC, with
12908 positive values used for timezones that are ahead (east) of UTC, and negative
12909 values for those that are behind (west).
12910
12911 .vitem &$tod_log$&
12912 .vindex "&$tod_log$&"
12913 The time and date in the format used for writing Exim's log files, for example:
12914 1995-10-12 15:32:29, but without a timezone.
12915
12916 .vitem &$tod_logfile$&
12917 .vindex "&$tod_logfile$&"
12918 This variable contains the date in the format yyyymmdd. This is the format that
12919 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12920 flag.
12921
12922 .vitem &$tod_zone$&
12923 .vindex "&$tod_zone$&"
12924 This variable contains the numerical value of the local timezone, for example:
12925 -0500.
12926
12927 .vitem &$tod_zulu$&
12928 .vindex "&$tod_zulu$&"
12929 This variable contains the UTC date and time in &"Zulu"& format, as specified
12930 by ISO 8601, for example: 20030221154023Z.
12931
12932 .vitem &$transport_name$&
12933 .cindex "transport" "name"
12934 .cindex "name" "of transport"
12935 .vindex "&$transport_name$&"
12936 During the running of a transport, this variable contains its name.
12937
12938 .vitem &$value$&
12939 .vindex "&$value$&"
12940 This variable contains the result of an expansion lookup, extraction operation,
12941 or external command, as described above. It is also used during a
12942 &*reduce*& expansion.
12943
12944 .vitem &$verify_mode$&
12945 .vindex "&$verify_mode$&"
12946 While a router or transport is being run in verify mode
12947 or for cutthrough delivery,
12948 contains "S" for sender-verification or "R" for recipient-verification.
12949 Otherwise, empty.
12950
12951 .vitem &$version_number$&
12952 .vindex "&$version_number$&"
12953 The version number of Exim.
12954
12955 .vitem &$warn_message_delay$&
12956 .vindex "&$warn_message_delay$&"
12957 This variable is set only during the creation of a message warning about a
12958 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12959
12960 .vitem &$warn_message_recipients$&
12961 .vindex "&$warn_message_recipients$&"
12962 This variable is set only during the creation of a message warning about a
12963 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12964 .endlist
12965 .ecindex IIDstrexp
12966
12967
12968
12969 . ////////////////////////////////////////////////////////////////////////////
12970 . ////////////////////////////////////////////////////////////////////////////
12971
12972 .chapter "Embedded Perl" "CHAPperl"
12973 .scindex IIDperl "Perl" "calling from Exim"
12974 Exim can be built to include an embedded Perl interpreter. When this is done,
12975 Perl subroutines can be called as part of the string expansion process. To make
12976 use of the Perl support, you need version 5.004 or later of Perl installed on
12977 your system. To include the embedded interpreter in the Exim binary, include
12978 the line
12979 .code
12980 EXIM_PERL = perl.o
12981 .endd
12982 in your &_Local/Makefile_& and then build Exim in the normal way.
12983
12984
12985 .section "Setting up so Perl can be used" "SECID85"
12986 .oindex "&%perl_startup%&"
12987 Access to Perl subroutines is via a global configuration option called
12988 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12989 no &%perl_startup%& option in the Exim configuration file then no Perl
12990 interpreter is started and there is almost no overhead for Exim (since none of
12991 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12992 option then the associated value is taken to be Perl code which is executed in
12993 a newly created Perl interpreter.
12994
12995 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12996 need backslashes before any characters to escape special meanings. The option
12997 should usually be something like
12998 .code
12999 perl_startup = do '/etc/exim.pl'
13000 .endd
13001 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13002 use from Exim. Exim can be configured either to start up a Perl interpreter as
13003 soon as it is entered, or to wait until the first time it is needed. Starting
13004 the interpreter at the beginning ensures that it is done while Exim still has
13005 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13006 fact used in a particular run. Also, note that this does not mean that Exim is
13007 necessarily running as root when Perl is called at a later time. By default,
13008 the interpreter is started only when it is needed, but this can be changed in
13009 two ways:
13010
13011 .ilist
13012 .oindex "&%perl_at_start%&"
13013 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13014 a startup when Exim is entered.
13015 .next
13016 The command line option &%-ps%& also requests a startup when Exim is entered,
13017 overriding the setting of &%perl_at_start%&.
13018 .endlist
13019
13020 There is also a command line option &%-pd%& (for delay) which suppresses the
13021 initial startup, even if &%perl_at_start%& is set.
13022
13023
13024 .section "Calling Perl subroutines" "SECID86"
13025 When the configuration file includes a &%perl_startup%& option you can make use
13026 of the string expansion item to call the Perl subroutines that are defined
13027 by the &%perl_startup%& code. The operator is used in any of the following
13028 forms:
13029 .code
13030 ${perl{foo}}
13031 ${perl{foo}{argument}}
13032 ${perl{foo}{argument1}{argument2} ... }
13033 .endd
13034 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13035 arguments may be passed. Passing more than this results in an expansion failure
13036 with an error message of the form
13037 .code
13038 Too many arguments passed to Perl subroutine "foo" (max is 8)
13039 .endd
13040 The return value of the Perl subroutine is evaluated in a scalar context before
13041 it is passed back to Exim to be inserted into the expanded string. If the
13042 return value is &'undef'&, the expansion is forced to fail in the same way as
13043 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13044 by obeying Perl's &%die%& function, the expansion fails with the error message
13045 that was passed to &%die%&.
13046
13047
13048 .section "Calling Exim functions from Perl" "SECID87"
13049 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13050 is available to call back into Exim's string expansion function. For example,
13051 the Perl code
13052 .code
13053 my $lp = Exim::expand_string('$local_part');
13054 .endd
13055 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13056 Note those are single quotes and not double quotes to protect against
13057 &$local_part$& being interpolated as a Perl variable.
13058
13059 If the string expansion is forced to fail by a &"fail"& item, the result of
13060 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13061 expansion string, the Perl call from the original expansion string fails with
13062 an appropriate error message, in the same way as if &%die%& were used.
13063
13064 .cindex "debugging" "from embedded Perl"
13065 .cindex "log" "writing from embedded Perl"
13066 Two other Exim functions are available for use from within Perl code.
13067 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13068 debugging is enabled. If you want a newline at the end, you must supply it.
13069 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13070 timestamp. In this case, you should not supply a terminating newline.
13071
13072
13073 .section "Use of standard output and error by Perl" "SECID88"
13074 .cindex "Perl" "standard output and error"
13075 You should not write to the standard error or output streams from within your
13076 Perl code, as it is not defined how these are set up. In versions of Exim
13077 before 4.50, it is possible for the standard output or error to refer to the
13078 SMTP connection during message reception via the daemon. Writing to this stream
13079 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13080 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13081 avoided, but the output is lost.
13082
13083 .cindex "Perl" "use of &%warn%&"
13084 The Perl &%warn%& statement writes to the standard error stream by default.
13085 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13086 you have no control. When Exim starts up the Perl interpreter, it arranges for
13087 output from the &%warn%& statement to be written to the Exim main log. You can
13088 change this by including appropriate Perl magic somewhere in your Perl code.
13089 For example, to discard &%warn%& output completely, you need this:
13090 .code
13091 $SIG{__WARN__} = sub { };
13092 .endd
13093 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13094 example, the code for the subroutine is empty, so it does nothing, but you can
13095 include any Perl code that you like. The text of the &%warn%& message is passed
13096 as the first subroutine argument.
13097 .ecindex IIDperl
13098
13099
13100 . ////////////////////////////////////////////////////////////////////////////
13101 . ////////////////////////////////////////////////////////////////////////////
13102
13103 .chapter "Starting the daemon and the use of network interfaces" &&&
13104          "CHAPinterfaces" &&&
13105          "Starting the daemon"
13106 .cindex "daemon" "starting"
13107 .cindex "interface" "listening"
13108 .cindex "network interface"
13109 .cindex "interface" "network"
13110 .cindex "IP address" "for listening"
13111 .cindex "daemon" "listening IP addresses"
13112 .cindex "TCP/IP" "setting listening interfaces"
13113 .cindex "TCP/IP" "setting listening ports"
13114 A host that is connected to a TCP/IP network may have one or more physical
13115 hardware network interfaces. Each of these interfaces may be configured as one
13116 or more &"logical"& interfaces, which are the entities that a program actually
13117 works with. Each of these logical interfaces is associated with an IP address.
13118 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13119 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13120 knowledge about the host's interfaces for use in three different circumstances:
13121
13122 .olist
13123 When a listening daemon is started, Exim needs to know which interfaces
13124 and ports to listen on.
13125 .next
13126 When Exim is routing an address, it needs to know which IP addresses
13127 are associated with local interfaces. This is required for the correct
13128 processing of MX lists by removing the local host and others with the
13129 same or higher priority values. Also, Exim needs to detect cases
13130 when an address is routed to an IP address that in fact belongs to the
13131 local host. Unless the &%self%& router option or the &%allow_localhost%&
13132 option of the smtp transport is set (as appropriate), this is treated
13133 as an error situation.
13134 .next
13135 When Exim connects to a remote host, it may need to know which interface to use
13136 for the outgoing connection.
13137 .endlist
13138
13139
13140 Exim's default behaviour is likely to be appropriate in the vast majority
13141 of cases. If your host has only one interface, and you want all its IP
13142 addresses to be treated in the same way, and you are using only the
13143 standard SMTP port, you should not need to take any special action. The
13144 rest of this chapter does not apply to you.
13145
13146 In a more complicated situation you may want to listen only on certain
13147 interfaces, or on different ports, and for this reason there are a number of
13148 options that can be used to influence Exim's behaviour. The rest of this
13149 chapter describes how they operate.
13150
13151 When a message is received over TCP/IP, the interface and port that were
13152 actually used are set in &$received_ip_address$& and &$received_port$&.
13153
13154
13155
13156 .section "Starting a listening daemon" "SECID89"
13157 When a listening daemon is started (by means of the &%-bd%& command line
13158 option), the interfaces and ports on which it listens are controlled by the
13159 following options:
13160
13161 .ilist
13162 &%daemon_smtp_ports%& contains a list of default ports
13163 or service names.
13164 (For backward compatibility, this option can also be specified in the singular.)
13165 .next
13166 &%local_interfaces%& contains list of interface IP addresses on which to
13167 listen. Each item may optionally also specify a port.
13168 .endlist
13169
13170 The default list separator in both cases is a colon, but this can be changed as
13171 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13172 it is usually best to change the separator to avoid having to double all the
13173 colons. For example:
13174 .code
13175 local_interfaces = <; 127.0.0.1 ; \
13176                       192.168.23.65 ; \
13177                       ::1 ; \
13178                       3ffe:ffff:836f::fe86:a061
13179 .endd
13180 There are two different formats for specifying a port along with an IP address
13181 in &%local_interfaces%&:
13182
13183 .olist
13184 The port is added onto the address with a dot separator. For example, to listen
13185 on port 1234 on two different IP addresses:
13186 .code
13187 local_interfaces = <; 192.168.23.65.1234 ; \
13188                       3ffe:ffff:836f::fe86:a061.1234
13189 .endd
13190 .next
13191 The IP address is enclosed in square brackets, and the port is added
13192 with a colon separator, for example:
13193 .code
13194 local_interfaces = <; [192.168.23.65]:1234 ; \
13195                       [3ffe:ffff:836f::fe86:a061]:1234
13196 .endd
13197 .endlist
13198
13199 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13200 default setting contains just one port:
13201 .code
13202 daemon_smtp_ports = smtp
13203 .endd
13204 If more than one port is listed, each interface that does not have its own port
13205 specified listens on all of them. Ports that are listed in
13206 &%daemon_smtp_ports%& can be identified either by name (defined in
13207 &_/etc/services_&) or by number. However, when ports are given with individual
13208 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13209
13210
13211
13212 .section "Special IP listening addresses" "SECID90"
13213 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13214 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13215 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13216 instead of setting up separate listening sockets for each interface. The
13217 default value of &%local_interfaces%& is
13218 .code
13219 local_interfaces = 0.0.0.0
13220 .endd
13221 when Exim is built without IPv6 support; otherwise it is:
13222 .code
13223 local_interfaces = <; ::0 ; 0.0.0.0
13224 .endd
13225 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13226
13227
13228
13229 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13230 The &%-oX%& command line option can be used to override the values of
13231 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13232 instance. Another way of doing this would be to use macros and the &%-D%&
13233 option. However, &%-oX%& can be used by any admin user, whereas modification of
13234 the runtime configuration by &%-D%& is allowed only when the caller is root or
13235 exim.
13236
13237 The value of &%-oX%& is a list of items. The default colon separator can be
13238 changed in the usual way if required. If there are any items that do not
13239 contain dots or colons (that is, are not IP addresses), the value of
13240 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13241 items that do contain dots or colons, the value of &%local_interfaces%& is
13242 replaced by those items. Thus, for example,
13243 .code
13244 -oX 1225
13245 .endd
13246 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13247 whereas
13248 .code
13249 -oX 192.168.34.5.1125
13250 .endd
13251 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13252 (However, since &%local_interfaces%& now contains no items without ports, the
13253 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13254
13255
13256
13257 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13258 .cindex "ssmtp protocol"
13259 .cindex "smtps protocol"
13260 .cindex "SMTP" "ssmtp protocol"
13261 .cindex "SMTP" "smtps protocol"
13262 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13263 before the STARTTLS command was standardized for SMTP. Some legacy clients
13264 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13265 list of port numbers or service names,
13266 connections to those ports must use SSMTP. The most
13267 common use of this option is expected to be
13268 .code
13269 tls_on_connect_ports = 465
13270 .endd
13271 because 465 is the usual port number used by the legacy clients. There is also
13272 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13273 this way when a daemon is started.
13274
13275 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13276 daemon to listen on those ports. You must still specify them in
13277 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13278 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13279 connections via the daemon.)
13280
13281
13282
13283
13284 .section "IPv6 address scopes" "SECID92"
13285 .cindex "IPv6" "address scopes"
13286 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13287 can, in principle, have the same link-local IPv6 address on different
13288 interfaces. Thus, additional information is needed, over and above the IP
13289 address, to distinguish individual interfaces. A convention of using a
13290 percent sign followed by something (often the interface name) has been
13291 adopted in some cases, leading to addresses like this:
13292 .code
13293 fe80::202:b3ff:fe03:45c1%eth0
13294 .endd
13295 To accommodate this usage, a percent sign followed by an arbitrary string is
13296 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13297 to convert a textual IPv6 address for actual use. This function recognizes the
13298 percent convention in operating systems that support it, and it processes the
13299 address appropriately. Unfortunately, some older libraries have problems with
13300 &[getaddrinfo()]&. If
13301 .code
13302 IPV6_USE_INET_PTON=yes
13303 .endd
13304 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13305 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13306 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13307 function.) Of course, this means that the additional functionality of
13308 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13309
13310 .section "Disabling IPv6" "SECID93"
13311 .cindex "IPv6" "disabling"
13312 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13313 run on a host whose kernel does not support IPv6. The binary will fall back to
13314 using IPv4, but it may waste resources looking up AAAA records, and trying to
13315 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13316 .oindex "&%disable_ipv6%&"
13317 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13318 activities take place. AAAA records are never looked up, and any IPv6 addresses
13319 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13320 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13321 to handle IPv6 literal addresses.
13322
13323 On the other hand, when IPv6 is in use, there may be times when you want to
13324 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13325 option to globally suppress the lookup of AAAA records for specified domains,
13326 and you can use the &%ignore_target_hosts%& generic router option to ignore
13327 IPv6 addresses in an individual router.
13328
13329
13330
13331 .section "Examples of starting a listening daemon" "SECID94"
13332 The default case in an IPv6 environment is
13333 .code
13334 daemon_smtp_ports = smtp
13335 local_interfaces = <; ::0 ; 0.0.0.0
13336 .endd
13337 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13338 Either one or two sockets may be used, depending on the characteristics of
13339 the TCP/IP stack. (This is complicated and messy; for more information,
13340 read the comments in the &_daemon.c_& source file.)
13341
13342 To specify listening on ports 25 and 26 on all interfaces:
13343 .code
13344 daemon_smtp_ports = 25 : 26
13345 .endd
13346 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13347 .code
13348 local_interfaces = <; ::0.25     ; ::0.26 \
13349                       0.0.0.0.25 ; 0.0.0.0.26
13350 .endd
13351 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13352 IPv4 loopback address only:
13353 .code
13354 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13355 .endd
13356 To specify listening on the default port on specific interfaces only:
13357 .code
13358 local_interfaces = 10.0.0.67 : 192.168.34.67
13359 .endd
13360 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13361
13362
13363
13364 .section "Recognizing the local host" "SECTreclocipadd"
13365 The &%local_interfaces%& option is also used when Exim needs to determine
13366 whether or not an IP address refers to the local host. That is, the IP
13367 addresses of all the interfaces on which a daemon is listening are always
13368 treated as local.
13369
13370 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13371 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13372 available interfaces from the operating system, and extracts the relevant
13373 (that is, IPv4 or IPv6) addresses to use for checking.
13374
13375 Some systems set up large numbers of virtual interfaces in order to provide
13376 many virtual web servers. In this situation, you may want to listen for
13377 email on only a few of the available interfaces, but nevertheless treat all
13378 interfaces as local when routing. You can do this by setting
13379 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13380 &"all"& wildcard values. These addresses are recognized as local, but are not
13381 used for listening. Consider this example:
13382 .code
13383 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13384                       192.168.53.235 ; \
13385                       3ffe:2101:12:1:a00:20ff:fe86:a061
13386
13387 extra_local_interfaces = <; ::0 ; 0.0.0.0
13388 .endd
13389 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13390 address, but all available interface addresses are treated as local when
13391 Exim is routing.
13392
13393 In some environments the local host name may be in an MX list, but with an IP
13394 address that is not assigned to any local interface. In other cases it may be
13395 desirable to treat other host names as if they referred to the local host. Both
13396 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13397 This contains host names rather than IP addresses. When a host is referenced
13398 during routing, either via an MX record or directly, it is treated as the local
13399 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13400 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13401
13402
13403
13404 .section "Delivering to a remote host" "SECID95"
13405 Delivery to a remote host is handled by the smtp transport. By default, it
13406 allows the system's TCP/IP functions to choose which interface to use (if
13407 there is more than one) when connecting to a remote host. However, the
13408 &%interface%& option can be set to specify which interface is used. See the
13409 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13410 details.
13411
13412
13413
13414
13415 . ////////////////////////////////////////////////////////////////////////////
13416 . ////////////////////////////////////////////////////////////////////////////
13417
13418 .chapter "Main configuration" "CHAPmainconfig"
13419 .scindex IIDconfima "configuration file" "main section"
13420 .scindex IIDmaiconf "main configuration"
13421 The first part of the run time configuration file contains three types of item:
13422
13423 .ilist
13424 Macro definitions: These lines start with an upper case letter. See section
13425 &<<SECTmacrodefs>>& for details of macro processing.
13426 .next
13427 Named list definitions: These lines start with one of the words &"domainlist"&,
13428 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13429 section &<<SECTnamedlists>>&.
13430 .next
13431 Main configuration settings: Each setting occupies one line of the file
13432 (with possible continuations). If any setting is preceded by the word
13433 &"hide"&, the &%-bP%& command line option displays its value to admin users
13434 only. See section &<<SECTcos>>& for a description of the syntax of these option
13435 settings.
13436 .endlist
13437
13438 This chapter specifies all the main configuration options, along with their
13439 types and default values. For ease of finding a particular option, they appear
13440 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13441 are now so many options, they are first listed briefly in functional groups, as
13442 an aid to finding the name of the option you are looking for. Some options are
13443 listed in more than one group.
13444
13445 .section "Miscellaneous" "SECID96"
13446 .table2
13447 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13448 .row &%disable_ipv6%&                "do no IPv6 processing"
13449 .row &%keep_malformed%&              "for broken files &-- should not happen"
13450 .row &%localhost_number%&            "for unique message ids in clusters"
13451 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13452 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13453 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13454 .row &%print_topbitchars%&           "top-bit characters are printing"
13455 .row &%timezone%&                    "force time zone"
13456 .endtable
13457
13458
13459 .section "Exim parameters" "SECID97"
13460 .table2
13461 .row &%exim_group%&                  "override compiled-in value"
13462 .row &%exim_path%&                   "override compiled-in value"
13463 .row &%exim_user%&                   "override compiled-in value"
13464 .row &%primary_hostname%&            "default from &[uname()]&"
13465 .row &%split_spool_directory%&       "use multiple directories"
13466 .row &%spool_directory%&             "override compiled-in value"
13467 .endtable
13468
13469
13470
13471 .section "Privilege controls" "SECID98"
13472 .table2
13473 .row &%admin_groups%&                "groups that are Exim admin users"
13474 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13475 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13476 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13477 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13478 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13479 .row &%never_users%&                 "do not run deliveries as these"
13480 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13481 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13482 .row &%trusted_groups%&              "groups that are trusted"
13483 .row &%trusted_users%&               "users that are trusted"
13484 .endtable
13485
13486
13487
13488 .section "Logging" "SECID99"
13489 .table2
13490 .row &%event_action%&                "custom logging"
13491 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13492 .row &%log_file_path%&               "override compiled-in value"
13493 .row &%log_selector%&                "set/unset optional logging"
13494 .row &%log_timezone%&                "add timezone to log lines"
13495 .row &%message_logs%&                "create per-message logs"
13496 .row &%preserve_message_logs%&       "after message completion"
13497 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13498 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13499 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13500 .row &%syslog_facility%&             "set syslog &""facility""& field"
13501 .row &%syslog_processname%&          "set syslog &""ident""& field"
13502 .row &%syslog_timestamp%&            "timestamp syslog lines"
13503 .row &%write_rejectlog%&             "control use of message log"
13504 .endtable
13505
13506
13507
13508 .section "Frozen messages" "SECID100"
13509 .table2
13510 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13511 .row &%freeze_tell%&                 "send message when freezing"
13512 .row &%move_frozen_messages%&        "to another directory"
13513 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13514 .endtable
13515
13516
13517
13518 .section "Data lookups" "SECID101"
13519 .table2
13520 .row &%ibase_servers%&               "InterBase servers"
13521 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13522 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13523 .row &%ldap_cert_file%&              "client cert file for LDAP"
13524 .row &%ldap_cert_key%&               "client key file for LDAP"
13525 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13526 .row &%ldap_default_servers%&        "used if no server in query"
13527 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13528 .row &%ldap_start_tls%&              "require TLS within LDAP"
13529 .row &%ldap_version%&                "set protocol version"
13530 .row &%lookup_open_max%&             "lookup files held open"
13531 .row &%mysql_servers%&               "default MySQL servers"
13532 .row &%oracle_servers%&              "Oracle servers"
13533 .row &%pgsql_servers%&               "default PostgreSQL servers"
13534 .row &%sqlite_lock_timeout%&         "as it says"
13535 .endtable
13536
13537
13538
13539 .section "Message ids" "SECID102"
13540 .table2
13541 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13542 .row &%message_id_header_text%&      "ditto"
13543 .endtable
13544
13545
13546
13547 .section "Embedded Perl Startup" "SECID103"
13548 .table2
13549 .row &%perl_at_start%&               "always start the interpreter"
13550 .row &%perl_startup%&                "code to obey when starting Perl"
13551 .endtable
13552
13553
13554
13555 .section "Daemon" "SECID104"
13556 .table2
13557 .row &%daemon_smtp_ports%&           "default ports"
13558 .row &%daemon_startup_retries%&      "number of times to retry"
13559 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13560 .row &%extra_local_interfaces%&      "not necessarily listened on"
13561 .row &%local_interfaces%&            "on which to listen, with optional ports"
13562 .row &%pid_file_path%&               "override compiled-in value"
13563 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13564 .endtable
13565
13566
13567
13568 .section "Resource control" "SECID105"
13569 .table2
13570 .row &%check_log_inodes%&            "before accepting a message"
13571 .row &%check_log_space%&             "before accepting a message"
13572 .row &%check_spool_inodes%&          "before accepting a message"
13573 .row &%check_spool_space%&           "before accepting a message"
13574 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13575 .row &%queue_only_load%&             "queue incoming if load high"
13576 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13577 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13578 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13579 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13580 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13581 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13582 .row &%smtp_accept_max_per_connection%& "messages per connection"
13583 .row &%smtp_accept_max_per_host%&    "connections from one host"
13584 .row &%smtp_accept_queue%&           "queue mail if more connections"
13585 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13586                                            connection"
13587 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13588 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13589 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13590 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13591 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13592 .endtable
13593
13594
13595
13596 .section "Policy controls" "SECID106"
13597 .table2
13598 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13599 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13600 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13601 .row &%acl_smtp_auth%&               "ACL for AUTH"
13602 .row &%acl_smtp_connect%&            "ACL for connection"
13603 .row &%acl_smtp_data%&               "ACL for DATA"
13604 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13605 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13606 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13607 .row &%acl_smtp_expn%&               "ACL for EXPN"
13608 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13609 .row &%acl_smtp_mail%&               "ACL for MAIL"
13610 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13611 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13612 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13613 .row &%acl_smtp_predata%&            "ACL for start of data"
13614 .row &%acl_smtp_quit%&               "ACL for QUIT"
13615 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13616 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13617 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13618 .row &%av_scanner%&                  "specify virus scanner"
13619 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13620                                       words""&"
13621 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13622 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13623 .row &%header_maxsize%&              "total size of message header"
13624 .row &%header_line_maxsize%&         "individual header line limit"
13625 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13626 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13627 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13628 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13629 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13630 .row &%host_lookup%&                 "host name looked up for these hosts"
13631 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13632 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13633 .row &%host_reject_connection%&      "reject connection from these hosts"
13634 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13635 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13636 .row &%message_size_limit%&          "for all messages"
13637 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13638 .row &%spamd_address%&               "set interface to SpamAssassin"
13639 .row &%strict_acl_vars%&             "object to unset ACL variables"
13640 .endtable
13641
13642
13643
13644 .section "Callout cache" "SECID107"
13645 .table2
13646 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13647                                          item"
13648 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13649                                          item"
13650 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13651 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13652 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13653 .endtable
13654
13655
13656
13657 .section "TLS" "SECID108"
13658 .table2
13659 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13660 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13661 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13662 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13663 .row &%tls_certificate%&             "location of server certificate"
13664 .row &%tls_crl%&                     "certificate revocation list"
13665 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13666 .row &%tls_dhparam%&                 "DH parameters for server"
13667 .row &%tls_eccurve%&                 "EC curve selection for server"
13668 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13669 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13670 .row &%tls_privatekey%&              "location of server private key"
13671 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13672 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13673 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13674 .row &%tls_verify_certificates%&     "expected client certificates"
13675 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13676 .endtable
13677
13678
13679
13680 .section "Local user handling" "SECID109"
13681 .table2
13682 .row &%finduser_retries%&            "useful in NIS environments"
13683 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13684 .row &%gecos_pattern%&               "ditto"
13685 .row &%max_username_length%&         "for systems that truncate"
13686 .row &%unknown_login%&               "used when no login name found"
13687 .row &%unknown_username%&            "ditto"
13688 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13689 .row &%uucp_from_sender%&            "ditto"
13690 .endtable
13691
13692
13693
13694 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13695 .table2
13696 .row &%header_maxsize%&              "total size of message header"
13697 .row &%header_line_maxsize%&         "individual header line limit"
13698 .row &%message_size_limit%&          "applies to all messages"
13699 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13700 .row &%received_header_text%&        "expanded to make &'Received:'&"
13701 .row &%received_headers_max%&        "for mail loop detection"
13702 .row &%recipients_max%&              "limit per message"
13703 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13704 .endtable
13705
13706
13707
13708
13709 .section "Non-SMTP incoming messages" "SECID111"
13710 .table2
13711 .row &%receive_timeout%&             "for non-SMTP messages"
13712 .endtable
13713
13714
13715
13716
13717
13718 .section "Incoming SMTP messages" "SECID112"
13719 See also the &'Policy controls'& section above.
13720
13721 .table2
13722 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13723 .row &%host_lookup%&                 "host name looked up for these hosts"
13724 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13725 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13726 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13727 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13728 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13729 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13730 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13731 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13732 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13733 .row &%smtp_accept_max_per_connection%& "messages per connection"
13734 .row &%smtp_accept_max_per_host%&    "connections from one host"
13735 .row &%smtp_accept_queue%&           "queue mail if more connections"
13736 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13737                                            connection"
13738 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13739 .row &%smtp_active_hostname%&        "host name to use in messages"
13740 .row &%smtp_banner%&                 "text for welcome banner"
13741 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13742 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13743 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13744 .row &%smtp_etrn_command%&           "what to run for ETRN"
13745 .row &%smtp_etrn_serialize%&         "only one at once"
13746 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13747 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13748 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13749 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13750 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13751 .row &%smtp_receive_timeout%&        "per command or data line"
13752 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13753 .row &%smtp_return_error_details%&   "give detail on rejections"
13754 .endtable
13755
13756
13757
13758 .section "SMTP extensions" "SECID113"
13759 .table2
13760 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13761 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13762 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13763 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13764 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13765 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13766 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13767 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13768 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13769 .endtable
13770
13771
13772
13773 .section "Processing messages" "SECID114"
13774 .table2
13775 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13776 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13777 .row &%allow_utf8_domains%&          "in addresses"
13778 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13779                                       words""&"
13780 .row &%delivery_date_remove%&        "from incoming messages"
13781 .row &%envelope_to_remove%&          "from incoming messages"
13782 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13783 .row &%headers_charset%&             "default for translations"
13784 .row &%qualify_domain%&              "default for senders"
13785 .row &%qualify_recipient%&           "default for recipients"
13786 .row &%return_path_remove%&          "from incoming messages"
13787 .row &%strip_excess_angle_brackets%& "in addresses"
13788 .row &%strip_trailing_dot%&          "at end of addresses"
13789 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13790 .endtable
13791
13792
13793
13794 .section "System filter" "SECID115"
13795 .table2
13796 .row &%system_filter%&               "locate system filter"
13797 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13798                                             directory"
13799 .row &%system_filter_file_transport%& "transport for delivery to a file"
13800 .row &%system_filter_group%&         "group for filter running"
13801 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13802 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13803 .row &%system_filter_user%&          "user for filter running"
13804 .endtable
13805
13806
13807
13808 .section "Routing and delivery" "SECID116"
13809 .table2
13810 .row &%disable_ipv6%&                "do no IPv6 processing"
13811 .row &%dns_again_means_nonexist%&    "for broken domains"
13812 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13813 .row &%dns_dnssec_ok%&               "parameter for resolver"
13814 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13815 .row &%dns_retrans%&                 "parameter for resolver"
13816 .row &%dns_retry%&                   "parameter for resolver"
13817 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13818 .row &%dns_use_edns0%&               "parameter for resolver"
13819 .row &%hold_domains%&                "hold delivery for these domains"
13820 .row &%local_interfaces%&            "for routing checks"
13821 .row &%queue_domains%&               "no immediate delivery for these"
13822 .row &%queue_only%&                  "no immediate delivery at all"
13823 .row &%queue_only_file%&             "no immediate delivery if file exists"
13824 .row &%queue_only_load%&             "no immediate delivery if load is high"
13825 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13826 .row &%queue_only_override%&         "allow command line to override"
13827 .row &%queue_run_in_order%&          "order of arrival"
13828 .row &%queue_run_max%&               "of simultaneous queue runners"
13829 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13830 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13831 .row &%remote_sort_domains%&         "order of remote deliveries"
13832 .row &%retry_data_expire%&           "timeout for retry data"
13833 .row &%retry_interval_max%&          "safety net for retry rules"
13834 .endtable
13835
13836
13837
13838 .section "Bounce and warning messages" "SECID117"
13839 .table2
13840 .row &%bounce_message_file%&         "content of bounce"
13841 .row &%bounce_message_text%&         "content of bounce"
13842 .row &%bounce_return_body%&          "include body if returning message"
13843 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13844 .row &%bounce_return_message%&       "include original message in bounce"
13845 .row &%bounce_return_size_limit%&    "limit on returned message"
13846 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13847 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13848 .row &%errors_copy%&                 "copy bounce messages"
13849 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13850 .row &%delay_warning%&               "time schedule"
13851 .row &%delay_warning_condition%&     "condition for warning messages"
13852 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13853 .row &%smtp_return_error_details%&   "give detail on rejections"
13854 .row &%warn_message_file%&           "content of warning message"
13855 .endtable
13856
13857
13858
13859 .section "Alphabetical list of main options" "SECTalomo"
13860 Those options that undergo string expansion before use are marked with
13861 &dagger;.
13862
13863 .option accept_8bitmime main boolean true
13864 .cindex "8BITMIME"
13865 .cindex "8-bit characters"
13866 .cindex "log" "selectors"
13867 .cindex "log" "8BITMIME"
13868 This option causes Exim to send 8BITMIME in its response to an SMTP
13869 EHLO command, and to accept the BODY= parameter on MAIL commands.
13870 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13871 takes no steps to do anything special with messages received by this route.
13872
13873 Historically Exim kept this option off by default, but the maintainers
13874 feel that in today's Internet, this causes more problems than it solves.
13875 It now defaults to true.
13876 A more detailed analysis of the issues is provided by Dan Bernstein:
13877 .display
13878 &url(http://cr.yp.to/smtp/8bitmime.html)
13879 .endd
13880
13881 To log received 8BITMIME status use
13882 .code
13883 log_selector = +8bitmime
13884 .endd
13885
13886 .option acl_not_smtp main string&!! unset
13887 .cindex "&ACL;" "for non-SMTP messages"
13888 .cindex "non-SMTP messages" "ACLs for"
13889 This option defines the ACL that is run when a non-SMTP message has been
13890 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13891 further details.
13892
13893 .option acl_not_smtp_mime main string&!! unset
13894 This option defines the ACL that is run for individual MIME parts of non-SMTP
13895 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13896 SMTP messages.
13897
13898 .option acl_not_smtp_start main string&!! unset
13899 .cindex "&ACL;" "at start of non-SMTP message"
13900 .cindex "non-SMTP messages" "ACLs for"
13901 This option defines the ACL that is run before Exim starts reading a
13902 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13903
13904 .option acl_smtp_auth main string&!! unset
13905 .cindex "&ACL;" "setting up for SMTP commands"
13906 .cindex "AUTH" "ACL for"
13907 This option defines the ACL that is run when an SMTP AUTH command is
13908 received. See chapter &<<CHAPACL>>& for further details.
13909
13910 .option acl_smtp_connect main string&!! unset
13911 .cindex "&ACL;" "on SMTP connection"
13912 This option defines the ACL that is run when an SMTP connection is received.
13913 See chapter &<<CHAPACL>>& for further details.
13914
13915 .option acl_smtp_data main string&!! unset
13916 .cindex "DATA" "ACL for"
13917 This option defines the ACL that is run after an SMTP DATA command has been
13918 processed and the message itself has been received, but before the final
13919 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13920
13921 .option acl_smtp_data_prdr main string&!! accept
13922 .cindex "PRDR" "ACL for"
13923 .cindex "DATA" "PRDR ACL for"
13924 .cindex "&ACL;" "PRDR-related"
13925 .cindex "&ACL;" "per-user data processing"
13926 This option defines the ACL that,
13927 if the PRDR feature has been negotiated,
13928 is run for each recipient after an SMTP DATA command has been
13929 processed and the message itself has been received, but before the
13930 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13931
13932 .option acl_smtp_dkim main string&!! unset
13933 .cindex DKIM "ACL for"
13934 This option defines the ACL that is run for each DKIM signature
13935 of a received message.
13936 See chapter &<<CHAPdkim>>& for further details.
13937
13938 .option acl_smtp_etrn main string&!! unset
13939 .cindex "ETRN" "ACL for"
13940 This option defines the ACL that is run when an SMTP ETRN command is
13941 received. See chapter &<<CHAPACL>>& for further details.
13942
13943 .option acl_smtp_expn main string&!! unset
13944 .cindex "EXPN" "ACL for"
13945 This option defines the ACL that is run when an SMTP EXPN command is
13946 received. See chapter &<<CHAPACL>>& for further details.
13947
13948 .option acl_smtp_helo main string&!! unset
13949 .cindex "EHLO" "ACL for"
13950 .cindex "HELO" "ACL for"
13951 This option defines the ACL that is run when an SMTP EHLO or HELO
13952 command is received. See chapter &<<CHAPACL>>& for further details.
13953
13954
13955 .option acl_smtp_mail main string&!! unset
13956 .cindex "MAIL" "ACL for"
13957 This option defines the ACL that is run when an SMTP MAIL command is
13958 received. See chapter &<<CHAPACL>>& for further details.
13959
13960 .option acl_smtp_mailauth main string&!! unset
13961 .cindex "AUTH" "on MAIL command"
13962 This option defines the ACL that is run when there is an AUTH parameter on
13963 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13964 &<<CHAPSMTPAUTH>>& for details of authentication.
13965
13966 .option acl_smtp_mime main string&!! unset
13967 .cindex "MIME content scanning" "ACL for"
13968 This option is available when Exim is built with the content-scanning
13969 extension. It defines the ACL that is run for each MIME part in a message. See
13970 section &<<SECTscanmimepart>>& for details.
13971
13972 .option acl_smtp_notquit main string&!! unset
13973 .cindex "not-QUIT, ACL for"
13974 This option defines the ACL that is run when an SMTP session
13975 ends without a QUIT command being received.
13976 See chapter &<<CHAPACL>>& for further details.
13977
13978 .option acl_smtp_predata main string&!! unset
13979 This option defines the ACL that is run when an SMTP DATA command is
13980 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13981 further details.
13982
13983 .option acl_smtp_quit main string&!! unset
13984 .cindex "QUIT, ACL for"
13985 This option defines the ACL that is run when an SMTP QUIT command is
13986 received. See chapter &<<CHAPACL>>& for further details.
13987
13988 .option acl_smtp_rcpt main string&!! unset
13989 .cindex "RCPT" "ACL for"
13990 This option defines the ACL that is run when an SMTP RCPT command is
13991 received. See chapter &<<CHAPACL>>& for further details.
13992
13993 .option acl_smtp_starttls main string&!! unset
13994 .cindex "STARTTLS, ACL for"
13995 This option defines the ACL that is run when an SMTP STARTTLS command is
13996 received. See chapter &<<CHAPACL>>& for further details.
13997
13998 .option acl_smtp_vrfy main string&!! unset
13999 .cindex "VRFY" "ACL for"
14000 This option defines the ACL that is run when an SMTP VRFY command is
14001 received. See chapter &<<CHAPACL>>& for further details.
14002
14003 .new
14004 .option add_environment main "string list" empty
14005 .cindex "environment" "set values"
14006 This option allows to set individual environment variables that the
14007 currently linked libraries and programs in child processes use. The
14008 default list is empty,
14009 .wen
14010
14011 .option admin_groups main "string list&!!" unset
14012 .cindex "admin user"
14013 This option is expanded just once, at the start of Exim's processing. If the
14014 current group or any of the supplementary groups of an Exim caller is in this
14015 colon-separated list, the caller has admin privileges. If all your system
14016 programmers are in a specific group, for example, you can give them all Exim
14017 admin privileges by putting that group in &%admin_groups%&. However, this does
14018 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14019 To permit this, you have to add individuals to the Exim group.
14020
14021 .option allow_domain_literals main boolean false
14022 .cindex "domain literal"
14023 If this option is set, the RFC 2822 domain literal format is permitted in
14024 email addresses. The option is not set by default, because the domain literal
14025 format is not normally required these days, and few people know about it. It
14026 has, however, been exploited by mail abusers.
14027
14028 Unfortunately, it seems that some DNS black list maintainers are using this
14029 format to report black listing to postmasters. If you want to accept messages
14030 addressed to your hosts by IP address, you need to set
14031 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14032 domains (defined in the named domain list &%local_domains%& in the default
14033 configuration). This &"magic string"& matches the domain literal form of all
14034 the local host's IP addresses.
14035
14036
14037 .option allow_mx_to_ip main boolean false
14038 .cindex "MX record" "pointing to IP address"
14039 It appears that more and more DNS zone administrators are breaking the rules
14040 and putting domain names that look like IP addresses on the right hand side of
14041 MX records. Exim follows the rules and rejects this, giving an error message
14042 that explains the misconfiguration. However, some other MTAs support this
14043 practice, so to avoid &"Why can't Exim do this?"& complaints,
14044 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14045 recommended, except when you have no other choice.
14046
14047 .option allow_utf8_domains main boolean false
14048 .cindex "domain" "UTF-8 characters in"
14049 .cindex "UTF-8" "in domain name"
14050 Lots of discussion is going on about internationalized domain names. One
14051 camp is strongly in favour of just using UTF-8 characters, and it seems
14052 that at least two other MTAs permit this. This option allows Exim users to
14053 experiment if they wish.
14054
14055 If it is set true, Exim's domain parsing function allows valid
14056 UTF-8 multicharacters to appear in domain name components, in addition to
14057 letters, digits, and hyphens. However, just setting this option is not
14058 enough; if you want to look up these domain names in the DNS, you must also
14059 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14060 suitable setting is:
14061 .code
14062 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14063   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14064 .endd
14065 Alternatively, you can just disable this feature by setting
14066 .code
14067 dns_check_names_pattern =
14068 .endd
14069 That is, set the option to an empty string so that no check is done.
14070
14071
14072 .option auth_advertise_hosts main "host list&!!" *
14073 .cindex "authentication" "advertising"
14074 .cindex "AUTH" "advertising"
14075 If any server authentication mechanisms are configured, Exim advertises them in
14076 response to an EHLO command only if the calling host matches this list.
14077 Otherwise, Exim does not advertise AUTH.
14078 Exim does not accept AUTH commands from clients to which it has not
14079 advertised the availability of AUTH. The advertising of individual
14080 authentication mechanisms can be controlled by the use of the
14081 &%server_advertise_condition%& generic authenticator option on the individual
14082 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14083
14084 Certain mail clients (for example, Netscape) require the user to provide a name
14085 and password for authentication if AUTH is advertised, even though it may
14086 not be needed (the host may accept messages from hosts on its local LAN without
14087 authentication, for example). The &%auth_advertise_hosts%& option can be used
14088 to make these clients more friendly by excluding them from the set of hosts to
14089 which Exim advertises AUTH.
14090
14091 .cindex "AUTH" "advertising when encrypted"
14092 If you want to advertise the availability of AUTH only when the connection
14093 is encrypted using TLS, you can make use of the fact that the value of this
14094 option is expanded, with a setting like this:
14095 .code
14096 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14097 .endd
14098 .vindex "&$tls_in_cipher$&"
14099 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14100 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14101 expansion is *, which matches all hosts.
14102
14103
14104 .option auto_thaw main time 0s
14105 .cindex "thawing messages"
14106 .cindex "unfreezing messages"
14107 If this option is set to a time greater than zero, a queue runner will try a
14108 new delivery attempt on any frozen message, other than a bounce message, if
14109 this much time has passed since it was frozen. This may result in the message
14110 being re-frozen if nothing has changed since the last attempt. It is a way of
14111 saying &"keep on trying, even though there are big problems"&.
14112
14113 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14114 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14115 thought to be very useful any more, and its use should probably be avoided.
14116
14117
14118 .option av_scanner main string "see below"
14119 This option is available if Exim is built with the content-scanning extension.
14120 It specifies which anti-virus scanner to use. The default value is:
14121 .code
14122 sophie:/var/run/sophie
14123 .endd
14124 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14125 before use. See section &<<SECTscanvirus>>& for further details.
14126
14127
14128 .option bi_command main string unset
14129 .oindex "&%-bi%&"
14130 This option supplies the name of a command that is run when Exim is called with
14131 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14132 just the command name, it is not a complete command line. If an argument is
14133 required, it must come from the &%-oA%& command line option.
14134
14135
14136 .option bounce_message_file main string unset
14137 .cindex "bounce message" "customizing"
14138 .cindex "customizing" "bounce message"
14139 This option defines a template file containing paragraphs of text to be used
14140 for constructing bounce messages.  Details of the file's contents are given in
14141 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14142
14143
14144 .option bounce_message_text main string unset
14145 When this option is set, its contents are included in the default bounce
14146 message immediately after &"This message was created automatically by mail
14147 delivery software."& It is not used if &%bounce_message_file%& is set.
14148
14149 .option bounce_return_body main boolean true
14150 .cindex "bounce message" "including body"
14151 This option controls whether the body of an incoming message is included in a
14152 bounce message when &%bounce_return_message%& is true. The default setting
14153 causes the entire message, both header and body, to be returned (subject to the
14154 value of &%bounce_return_size_limit%&). If this option is false, only the
14155 message header is included. In the case of a non-SMTP message containing an
14156 error that is detected during reception, only those header lines preceding the
14157 point at which the error was detected are returned.
14158 .cindex "bounce message" "including original"
14159
14160 .option bounce_return_linesize_limit main integer 998
14161 .cindex "size" "of bounce lines, limit"
14162 .cindex "bounce message" "line length limit"
14163 .cindex "limit" "bounce message line length"
14164 This option sets a limit in bytes on the line length of messages
14165 that are returned to senders due to delivery problems,
14166 when &%bounce_return_message%& is true.
14167 The default value corresponds to RFC limits.
14168 If the message being returned has lines longer than this value it is
14169 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14170
14171 The option also applies to bounces returned when an error is detected
14172 during reception of a messsage.
14173 In this case lines from the original are truncated.
14174
14175 The option does not apply to messages generated by an &(autoreply)& transport.
14176
14177
14178 .option bounce_return_message main boolean true
14179 If this option is set false, none of the original message is included in
14180 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14181 &%bounce_return_body%&.
14182
14183
14184 .option bounce_return_size_limit main integer 100K
14185 .cindex "size" "of bounce, limit"
14186 .cindex "bounce message" "size limit"
14187 .cindex "limit" "bounce message size"
14188 This option sets a limit in bytes on the size of messages that are returned to
14189 senders as part of bounce messages when &%bounce_return_message%& is true. The
14190 limit should be less than the value of the global &%message_size_limit%& and of
14191 any &%message_size_limit%& settings on transports, to allow for the bounce text
14192 that Exim generates. If this option is set to zero there is no limit.
14193
14194 When the body of any message that is to be included in a bounce message is
14195 greater than the limit, it is truncated, and a comment pointing this out is
14196 added at the top. The actual cutoff may be greater than the value given, owing
14197 to the use of buffering for transferring the message in chunks (typically 8K in
14198 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14199 messages.
14200
14201 .option bounce_sender_authentication main string unset
14202 .cindex "bounce message" "sender authentication"
14203 .cindex "authentication" "bounce message"
14204 .cindex "AUTH" "on bounce message"
14205 This option provides an authenticated sender address that is sent with any
14206 bounce messages generated by Exim that are sent over an authenticated SMTP
14207 connection. A typical setting might be:
14208 .code
14209 bounce_sender_authentication = mailer-daemon@my.domain.example
14210 .endd
14211 which would cause bounce messages to be sent using the SMTP command:
14212 .code
14213 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14214 .endd
14215 The value of &%bounce_sender_authentication%& must always be a complete email
14216 address.
14217
14218 .option callout_domain_negative_expire main time 3h
14219 .cindex "caching" "callout timeouts"
14220 .cindex "callout" "caching timeouts"
14221 This option specifies the expiry time for negative callout cache data for a
14222 domain. See section &<<SECTcallver>>& for details of callout verification, and
14223 section &<<SECTcallvercache>>& for details of the caching.
14224
14225
14226 .option callout_domain_positive_expire main time 7d
14227 This option specifies the expiry time for positive callout cache data for a
14228 domain. See section &<<SECTcallver>>& for details of callout verification, and
14229 section &<<SECTcallvercache>>& for details of the caching.
14230
14231
14232 .option callout_negative_expire main time 2h
14233 This option specifies the expiry time for negative callout cache data for an
14234 address. See section &<<SECTcallver>>& for details of callout verification, and
14235 section &<<SECTcallvercache>>& for details of the caching.
14236
14237
14238 .option callout_positive_expire main time 24h
14239 This option specifies the expiry time for positive callout cache data for an
14240 address. See section &<<SECTcallver>>& for details of callout verification, and
14241 section &<<SECTcallvercache>>& for details of the caching.
14242
14243
14244 .option callout_random_local_part main string&!! "see below"
14245 This option defines the &"random"& local part that can be used as part of
14246 callout verification. The default value is
14247 .code
14248 $primary_hostname-$tod_epoch-testing
14249 .endd
14250 See section &<<CALLaddparcall>>& for details of how this value is used.
14251
14252
14253 .option check_log_inodes main integer 0
14254 See &%check_spool_space%& below.
14255
14256
14257 .option check_log_space main integer 0
14258 See &%check_spool_space%& below.
14259
14260 .oindex "&%check_rfc2047_length%&"
14261 .cindex "RFC 2047" "disabling length check"
14262 .option check_rfc2047_length main boolean true
14263 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14264 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14265 word; strings to be encoded that exceed this length are supposed to use
14266 multiple encoded words. By default, Exim does not recognize encoded words that
14267 exceed the maximum length. However, it seems that some software, in violation
14268 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14269 set false, Exim recognizes encoded words of any length.
14270
14271
14272 .option check_spool_inodes main integer 0
14273 See &%check_spool_space%& below.
14274
14275
14276 .option check_spool_space main integer 0
14277 .cindex "checking disk space"
14278 .cindex "disk space, checking"
14279 .cindex "spool directory" "checking space"
14280 The four &%check_...%& options allow for checking of disk resources before a
14281 message is accepted.
14282
14283 .vindex "&$log_inodes$&"
14284 .vindex "&$log_space$&"
14285 .vindex "&$spool_inodes$&"
14286 .vindex "&$spool_space$&"
14287 When any of these options are set, they apply to all incoming messages. If you
14288 want to apply different checks to different kinds of message, you can do so by
14289 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14290 &$spool_space$& in an ACL with appropriate additional conditions.
14291
14292
14293 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14294 either value is greater than zero, for example:
14295 .code
14296 check_spool_space = 10M
14297 check_spool_inodes = 100
14298 .endd
14299 The spool partition is the one that contains the directory defined by
14300 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14301 transit.
14302
14303 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14304 files are written if either is greater than zero. These should be set only if
14305 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14306
14307 If there is less space or fewer inodes than requested, Exim refuses to accept
14308 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14309 error response to the MAIL command. If ESMTP is in use and there was a
14310 SIZE parameter on the MAIL command, its value is added to the
14311 &%check_spool_space%& value, and the check is performed even if
14312 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14313
14314 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14315 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14316
14317 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14318 failure a message is written to stderr and Exim exits with a non-zero code, as
14319 it obviously cannot send an error message of any kind.
14320
14321 .option daemon_smtp_ports main string &`smtp`&
14322 .cindex "port" "for daemon"
14323 .cindex "TCP/IP" "setting listening ports"
14324 This option specifies one or more default SMTP ports on which the Exim daemon
14325 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14326 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14327
14328 .option daemon_startup_retries main integer 9
14329 .cindex "daemon startup, retrying"
14330 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14331 the daemon at startup when it cannot immediately bind a listening socket
14332 (typically because the socket is already in use): &%daemon_startup_retries%&
14333 defines the number of retries after the first failure, and
14334 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14335
14336 .option daemon_startup_sleep main time 30s
14337 See &%daemon_startup_retries%&.
14338
14339 .option delay_warning main "time list" 24h
14340 .cindex "warning of delay"
14341 .cindex "delay warning, specifying"
14342 When a message is delayed, Exim sends a warning message to the sender at
14343 intervals specified by this option. The data is a colon-separated list of times
14344 after which to send warning messages. If the value of the option is an empty
14345 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14346 message has been on the queue for longer than the last time, the last interval
14347 between the times is used to compute subsequent warning times. For example,
14348 with
14349 .code
14350 delay_warning = 4h:8h:24h
14351 .endd
14352 the first message is sent after 4 hours, the second after 8 hours, and
14353 the third one after 24 hours. After that, messages are sent every 16 hours,
14354 because that is the interval between the last two times on the list. If you set
14355 just one time, it specifies the repeat interval. For example, with:
14356 .code
14357 delay_warning = 6h
14358 .endd
14359 messages are repeated every six hours. To stop warnings after a given time, set
14360 a very large time at the end of the list. For example:
14361 .code
14362 delay_warning = 2h:12h:99d
14363 .endd
14364 Note that the option is only evaluated at the time a delivery attempt fails,
14365 which depends on retry and queue-runner configuration.
14366 Typically retries will be configured more frequently than warning messages.
14367
14368 .option delay_warning_condition main string&!! "see below"
14369 .vindex "&$domain$&"
14370 The string is expanded at the time a warning message might be sent. If all the
14371 deferred addresses have the same domain, it is set in &$domain$& during the
14372 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14373 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14374 &"false"& (the comparison being done caselessly) then the warning message is
14375 not sent. The default is:
14376 .code
14377 delay_warning_condition = ${if or {\
14378   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14379   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14380   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14381   } {no}{yes}}
14382 .endd
14383 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14384 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14385 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14386 &"auto-replied"& in an &'Auto-Submitted:'& header.
14387
14388 .option deliver_drop_privilege main boolean false
14389 .cindex "unprivileged delivery"
14390 .cindex "delivery" "unprivileged"
14391 If this option is set true, Exim drops its root privilege at the start of a
14392 delivery process, and runs as the Exim user throughout. This severely restricts
14393 the kinds of local delivery that are possible, but is viable in certain types
14394 of configuration. There is a discussion about the use of root privilege in
14395 chapter &<<CHAPsecurity>>&.
14396
14397 .option deliver_queue_load_max main fixed-point unset
14398 .cindex "load average"
14399 .cindex "queue runner" "abandoning"
14400 When this option is set, a queue run is abandoned if the system load average
14401 becomes greater than the value of the option. The option has no effect on
14402 ancient operating systems on which Exim cannot determine the load average.
14403 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14404
14405
14406 .option delivery_date_remove main boolean true
14407 .cindex "&'Delivery-date:'& header line"
14408 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14409 message when it is delivered, in exactly the same way as &'Return-path:'& is
14410 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14411 should not be present in incoming messages, and this option causes them to be
14412 removed at the time the message is received, to avoid any problems that might
14413 occur when a delivered message is subsequently sent on to some other recipient.
14414
14415 .option disable_fsync main boolean false
14416 .cindex "&[fsync()]&, disabling"
14417 This option is available only if Exim was built with the compile-time option
14418 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14419 a runtime configuration generates an &"unknown option"& error. You should not
14420 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14421 really, really, really understand what you are doing. &'No pre-compiled
14422 distributions of Exim should ever make this option available.'&
14423
14424 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14425 updated files' data to be written to disc before continuing. Unexpected events
14426 such as crashes and power outages may cause data to be lost or scrambled.
14427 Here be Dragons. &*Beware.*&
14428
14429
14430 .option disable_ipv6 main boolean false
14431 .cindex "IPv6" "disabling"
14432 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14433 activities take place. AAAA records are never looked up, and any IPv6 addresses
14434 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14435 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14436 to handle IPv6 literal addresses.
14437
14438
14439 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14440 .cindex DKIM "controlling calls to the ACL"
14441 This option gives a list of DKIM domains for which the DKIM ACL is run.
14442 It is expanded after the message is received; by default it runs
14443 the ACL once for each signature in the message.
14444 See chapter &<<CHAPdkim>>&.
14445
14446
14447 .option dns_again_means_nonexist main "domain list&!!" unset
14448 .cindex "DNS" "&""try again""& response; overriding"
14449 DNS lookups give a &"try again"& response for the DNS errors
14450 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14451 keep trying to deliver a message, or to give repeated temporary errors to
14452 incoming mail. Sometimes the effect is caused by a badly set up name server and
14453 may persist for a long time. If a domain which exhibits this problem matches
14454 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14455 This option should be used with care. You can make it apply to reverse lookups
14456 by a setting such as this:
14457 .code
14458 dns_again_means_nonexist = *.in-addr.arpa
14459 .endd
14460 This option applies to all DNS lookups that Exim does. It also applies when the
14461 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14462 since these are most likely to be caused by DNS lookup problems. The
14463 &(dnslookup)& router has some options of its own for controlling what happens
14464 when lookups for MX or SRV records give temporary errors. These more specific
14465 options are applied after this global option.
14466
14467 .option dns_check_names_pattern main string "see below"
14468 .cindex "DNS" "pre-check of name syntax"
14469 When this option is set to a non-empty string, it causes Exim to check domain
14470 names for characters that are not allowed in host names before handing them to
14471 the DNS resolver, because some resolvers give temporary errors for names that
14472 contain unusual characters. If a domain name contains any unwanted characters,
14473 a &"not found"& result is forced, and the resolver is not called. The check is
14474 done by matching the domain name against a regular expression, which is the
14475 value of this option. The default pattern is
14476 .code
14477 dns_check_names_pattern = \
14478   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14479 .endd
14480 which permits only letters, digits, slashes, and hyphens in components, but
14481 they must start and end with a letter or digit. Slashes are not, in fact,
14482 permitted in host names, but they are found in certain NS records (which can be
14483 accessed in Exim by using a &%dnsdb%& lookup). If you set
14484 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14485 empty string.
14486
14487 .option dns_csa_search_limit main integer 5
14488 This option controls the depth of parental searching for CSA SRV records in the
14489 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14490
14491 .option dns_csa_use_reverse main boolean true
14492 This option controls whether or not an IP address, given as a CSA domain, is
14493 reversed and looked up in the reverse DNS, as described in more detail in
14494 section &<<SECTverifyCSA>>&.
14495
14496
14497 .option dns_dnssec_ok main integer -1
14498 .cindex "DNS" "resolver options"
14499 .cindex "DNS" "DNSSEC"
14500 If this option is set to a non-negative number then Exim will initialise the
14501 DNS resolver library to either use or not use DNSSEC, overriding the system
14502 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14503
14504 If the resolver library does not support DNSSEC then this option has no effect.
14505
14506
14507 .option dns_ipv4_lookup main "domain list&!!" unset
14508 .cindex "IPv6" "DNS lookup for AAAA records"
14509 .cindex "DNS" "IPv6 lookup for AAAA records"
14510 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14511 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14512 (A records) when trying to find IP addresses for hosts, unless the host's
14513 domain matches this list.
14514
14515 This is a fudge to help with name servers that give big delays or otherwise do
14516 not work for the AAAA record type. In due course, when the world's name
14517 servers have all been upgraded, there should be no need for this option.
14518
14519
14520 .option dns_retrans main time 0s
14521 .cindex "DNS" "resolver options"
14522 .cindex timeout "dns lookup"
14523 .cindex "DNS" timeout
14524 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14525 retransmission and retry parameters for DNS lookups. Values of zero (the
14526 defaults) leave the system default settings unchanged. The first value is the
14527 time between retries, and the second is the number of retries. It isn't
14528 totally clear exactly how these settings affect the total time a DNS lookup may
14529 take. I haven't found any documentation about timeouts on DNS lookups; these
14530 parameter values are available in the external resolver interface structure,
14531 but nowhere does it seem to describe how they are used or what you might want
14532 to set in them.
14533 See also the &%slow_lookup_log%& option.
14534
14535
14536 .option dns_retry main integer 0
14537 See &%dns_retrans%& above.
14538
14539
14540 .option dns_trust_aa main "domain list&!!" unset
14541 .cindex "DNS" "resolver options"
14542 .cindex "DNS" "DNSSEC"
14543 If this option is set then lookup results marked with the AA bit
14544 (Authoritative Answer) are trusted the same way as if they were
14545 DNSSEC-verified. The authority section's name of the answer must
14546 match with this expanded domain list.
14547
14548 Use this option only if you talk directly to a resolver that is
14549 authoritative for some zones and does not set the AD (Authentic Data)
14550 bit in the answer. Some DNS servers may have an configuration option to
14551 mark the answers from their own zones as verified (they set the AD bit).
14552 Others do not have this option. It is considered as poor practice using
14553 a resolver that is an authoritative server for some zones.
14554
14555 Use this option only if you really have to (e.g. if you want
14556 to use DANE for remote delivery to a server that is listed in the DNS
14557 zones that your resolver is authoritative for).
14558
14559 If the DNS answer packet has the AA bit set and contains resource record
14560 in the answer section, the name of the first NS record appearing in the
14561 authority section is compared against the list. If the answer packet is
14562 authoritative but the answer section is empty, the name of the first SOA
14563 record in the authoritative section is used instead.
14564
14565 .cindex "DNS" "resolver options"
14566 .option dns_use_edns0 main integer -1
14567 .cindex "DNS" "resolver options"
14568 .cindex "DNS" "EDNS0"
14569 If this option is set to a non-negative number then Exim will initialise the
14570 DNS resolver library to either use or not use EDNS0 extensions, overriding
14571 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14572 on.
14573
14574 If the resolver library does not support EDNS0 then this option has no effect.
14575
14576
14577 .option drop_cr main boolean false
14578 This is an obsolete option that is now a no-op. It used to affect the way Exim
14579 handled CR and LF characters in incoming messages. What happens now is
14580 described in section &<<SECTlineendings>>&.
14581
14582 .option dsn_advertise_hosts main "host list&!!" unset
14583 .cindex "bounce messages" "success"
14584 .cindex "DSN" "success"
14585 .cindex "Delivery Status Notification" "success"
14586 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14587 and accepted from, these hosts.
14588 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14589 and RET and ORCPT options on MAIL FROM commands.
14590 A NOTIFY=SUCCESS option requests success-DSN messages.
14591 A NOTIFY= option with no argument requests that no delay or failure DSNs
14592 are sent.
14593
14594 .option dsn_from main "string&!!" "see below"
14595 .cindex "&'From:'& header line" "in bounces"
14596 .cindex "bounce messages" "&'From:'& line, specifying"
14597 This option can be used to vary the contents of &'From:'& header lines in
14598 bounces and other automatically generated messages (&"Delivery Status
14599 Notifications"& &-- hence the name of the option). The default setting is:
14600 .code
14601 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14602 .endd
14603 The value is expanded every time it is needed. If the expansion fails, a
14604 panic is logged, and the default value is used.
14605
14606 .option envelope_to_remove main boolean true
14607 .cindex "&'Envelope-to:'& header line"
14608 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14609 message when it is delivered, in exactly the same way as &'Return-path:'& is
14610 handled. &'Envelope-to:'& records the original recipient address from the
14611 message's envelope that caused the delivery to happen. Such headers should not
14612 be present in incoming messages, and this option causes them to be removed at
14613 the time the message is received, to avoid any problems that might occur when a
14614 delivered message is subsequently sent on to some other recipient.
14615
14616
14617 .option errors_copy main "string list&!!" unset
14618 .cindex "bounce message" "copy to other address"
14619 .cindex "copy of bounce message"
14620 Setting this option causes Exim to send bcc copies of bounce messages that it
14621 generates to other addresses. &*Note*&: This does not apply to bounce messages
14622 coming from elsewhere. The value of the option is a colon-separated list of
14623 items. Each item consists of a pattern, terminated by white space, followed by
14624 a comma-separated list of email addresses. If a pattern contains spaces, it
14625 must be enclosed in double quotes.
14626
14627 Each pattern is processed in the same way as a single item in an address list
14628 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14629 the bounce message, the message is copied to the addresses on the list. The
14630 items are scanned in order, and once a matching one is found, no further items
14631 are examined. For example:
14632 .code
14633 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14634               rqps@mydomain   hostmaster@mydomain.example,\
14635                               postmaster@mydomain.example
14636 .endd
14637 .vindex "&$domain$&"
14638 .vindex "&$local_part$&"
14639 The address list is expanded before use. The expansion variables &$local_part$&
14640 and &$domain$& are set from the original recipient of the error message, and if
14641 there was any wildcard matching in the pattern, the expansion
14642 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14643 variables &$0$&, &$1$&, etc. are set in the normal way.
14644
14645
14646 .option errors_reply_to main string unset
14647 .cindex "bounce message" "&'Reply-to:'& in"
14648 By default, Exim's bounce and delivery warning messages contain the header line
14649 .display
14650 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14651 .endd
14652 .oindex &%quota_warn_message%&
14653 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14654 A warning message that is generated by the &%quota_warn_message%& option in an
14655 &(appendfile)& transport may contain its own &'From:'& header line that
14656 overrides the default.
14657
14658 Experience shows that people reply to bounce messages. If the
14659 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14660 and warning messages. For example:
14661 .code
14662 errors_reply_to = postmaster@my.domain.example
14663 .endd
14664 The value of the option is not expanded. It must specify a valid RFC 2822
14665 address. However, if a warning message that is generated by the
14666 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14667 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14668 not used.
14669
14670
14671 .new
14672 .option event_action main string&!! unset
14673 .cindex events
14674 This option declares a string to be expanded for Exim's events mechanism.
14675 For details see &<<CHAPevents>>&.
14676 .wen
14677
14678
14679 .option exim_group main string "compile-time configured"
14680 .cindex "gid (group id)" "Exim's own"
14681 .cindex "Exim group"
14682 This option changes the gid under which Exim runs when it gives up root
14683 privilege. The default value is compiled into the binary. The value of this
14684 option is used only when &%exim_user%& is also set. Unless it consists entirely
14685 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14686 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14687 security issues.
14688
14689
14690 .option exim_path main string "see below"
14691 .cindex "Exim binary, path name"
14692 This option specifies the path name of the Exim binary, which is used when Exim
14693 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14694 the directory configured at compile time by the BIN_DIRECTORY setting. It
14695 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14696 other place.
14697 &*Warning*&: Do not use a macro to define the value of this option, because
14698 you will break those Exim utilities that scan the configuration file to find
14699 where the binary is. (They then use the &%-bP%& option to extract option
14700 settings such as the value of &%spool_directory%&.)
14701
14702
14703 .option exim_user main string "compile-time configured"
14704 .cindex "uid (user id)" "Exim's own"
14705 .cindex "Exim user"
14706 This option changes the uid under which Exim runs when it gives up root
14707 privilege. The default value is compiled into the binary. Ownership of the run
14708 time configuration file and the use of the &%-C%& and &%-D%& command line
14709 options is checked against the values in the binary, not what is set here.
14710
14711 Unless it consists entirely of digits, the string is looked up using
14712 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14713 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14714 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14715
14716
14717 .option extra_local_interfaces main "string list" unset
14718 This option defines network interfaces that are to be considered local when
14719 routing, but which are not used for listening by the daemon. See section
14720 &<<SECTreclocipadd>>& for details.
14721
14722
14723 . Allow this long option name to split; give it unsplit as a fifth argument
14724 . for the automatic .oindex that is generated by .option.
14725
14726 .option "extract_addresses_remove_arguments" main boolean true &&&
14727          extract_addresses_remove_arguments
14728 .oindex "&%-t%&"
14729 .cindex "command line" "addresses with &%-t%&"
14730 .cindex "Sendmail compatibility" "&%-t%& option"
14731 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14732 are present on the command line when the &%-t%& option is used to build an
14733 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14734 line addresses are removed from the recipients list. This is also how Smail
14735 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14736 command line addresses are added to those obtained from the header lines. When
14737 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14738 argument headers. If it is set false, Exim adds rather than removes argument
14739 addresses.
14740
14741
14742 .option finduser_retries main integer 0
14743 .cindex "NIS, retrying user lookups"
14744 On systems running NIS or other schemes in which user and group information is
14745 distributed from a remote system, there can be times when &[getpwnam()]& and
14746 related functions fail, even when given valid data, because things time out.
14747 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14748 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14749 many extra times to find a user or a group, waiting for one second between
14750 retries.
14751
14752 .cindex "&_/etc/passwd_&" "multiple reading of"
14753 You should not set this option greater than zero if your user information is in
14754 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14755 search the file multiple times for non-existent users, and also cause delay.
14756
14757
14758
14759 .option freeze_tell main "string list, comma separated" unset
14760 .cindex "freezing messages" "sending a message when freezing"
14761 On encountering certain errors, or when configured to do so in a system filter,
14762 ACL, or special router, Exim freezes a message. This means that no further
14763 delivery attempts take place until an administrator thaws the message, or the
14764 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14765 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14766 warning message whenever it freezes something, unless the message it is
14767 freezing is a locally-generated bounce message. (Without this exception there
14768 is the possibility of looping.) The warning message is sent to the addresses
14769 supplied as the comma-separated value of this option. If several of the
14770 message's addresses cause freezing, only a single message is sent. If the
14771 freezing was automatic, the reason(s) for freezing can be found in the message
14772 log. If you configure freezing in a filter or ACL, you must arrange for any
14773 logging that you require.
14774
14775
14776 .option gecos_name main string&!! unset
14777 .cindex "HP-UX"
14778 .cindex "&""gecos""& field, parsing"
14779 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14780 password file to hold other information in addition to users' real names. Exim
14781 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14782 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14783 of the field are used unchanged, except that, if an ampersand is encountered,
14784 it is replaced by the user's login name with the first character forced to
14785 upper case, since this is a convention that is observed on many systems.
14786
14787 When these options are set, &%gecos_pattern%& is treated as a regular
14788 expression that is to be applied to the field (again with && replaced by the
14789 login name), and if it matches, &%gecos_name%& is expanded and used as the
14790 user's name.
14791
14792 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14793 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14794 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14795 name terminates at the first comma, the following can be used:
14796 .code
14797 gecos_pattern = ([^,]*)
14798 gecos_name = $1
14799 .endd
14800
14801 .option gecos_pattern main string unset
14802 See &%gecos_name%& above.
14803
14804
14805 .option gnutls_compat_mode main boolean unset
14806 This option controls whether GnuTLS is used in compatibility mode in an Exim
14807 server. This reduces security slightly, but improves interworking with older
14808 implementations of TLS.
14809
14810
14811 option gnutls_allow_auto_pkcs11 main boolean unset
14812 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14813 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14814
14815 See
14816 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14817 for documentation.
14818
14819
14820
14821 .option headers_charset main string "see below"
14822 This option sets a default character set for translating from encoded MIME
14823 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14824 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14825 ultimate default is ISO-8859-1. For more details see the description of header
14826 insertions in section &<<SECTexpansionitems>>&.
14827
14828
14829
14830 .option header_maxsize main integer "see below"
14831 .cindex "header section" "maximum size of"
14832 .cindex "limit" "size of message header section"
14833 This option controls the overall maximum size of a message's header
14834 section. The default is the value of HEADER_MAXSIZE in
14835 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14836 sections are rejected.
14837
14838
14839 .option header_line_maxsize main integer 0
14840 .cindex "header lines" "maximum size of"
14841 .cindex "limit" "size of one header line"
14842 This option limits the length of any individual header line in a message, after
14843 all the continuations have been joined together. Messages with individual
14844 header lines that are longer than the limit are rejected. The default value of
14845 zero means &"no limit"&.
14846
14847
14848
14849
14850 .option helo_accept_junk_hosts main "host list&!!" unset
14851 .cindex "HELO" "accepting junk data"
14852 .cindex "EHLO" "accepting junk data"
14853 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14854 mail, and gives an error response for invalid data. Unfortunately, there are
14855 some SMTP clients that send syntactic junk. They can be accommodated by setting
14856 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14857 if you want to do semantic checking.
14858 See also &%helo_allow_chars%& for a way of extending the permitted character
14859 set.
14860
14861
14862 .option helo_allow_chars main string unset
14863 .cindex "HELO" "underscores in"
14864 .cindex "EHLO" "underscores in"
14865 .cindex "underscore in EHLO/HELO"
14866 This option can be set to a string of rogue characters that are permitted in
14867 all EHLO and HELO names in addition to the standard letters, digits,
14868 hyphens, and dots. If you really must allow underscores, you can set
14869 .code
14870 helo_allow_chars = _
14871 .endd
14872 Note that the value is one string, not a list.
14873
14874
14875 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14876 .cindex "HELO" "forcing reverse lookup"
14877 .cindex "EHLO" "forcing reverse lookup"
14878 If the domain given by a client in a HELO or EHLO command matches this
14879 list, a reverse lookup is done in order to establish the host's true name. The
14880 default forces a lookup if the client host gives the server's name or any of
14881 its IP addresses (in brackets), something that broken clients have been seen to
14882 do.
14883
14884
14885 .option helo_try_verify_hosts main "host list&!!" unset
14886 .cindex "HELO verifying" "optional"
14887 .cindex "EHLO" "verifying, optional"
14888 By default, Exim just checks the syntax of HELO and EHLO commands (see
14889 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14890 to do more extensive checking of the data supplied by these commands. The ACL
14891 condition &`verify = helo`& is provided to make this possible.
14892 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14893 to force the check to occur. From release 4.53 onwards, this is no longer
14894 necessary. If the check has not been done before &`verify = helo`& is
14895 encountered, it is done at that time. Consequently, this option is obsolete.
14896 Its specification is retained here for backwards compatibility.
14897
14898 When an EHLO or HELO command is received, if the calling host matches
14899 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14900 EHLO command either:
14901
14902 .ilist
14903 is an IP literal matching the calling address of the host, or
14904 .next
14905 .cindex "DNS" "reverse lookup"
14906 .cindex "reverse DNS lookup"
14907 matches the host name that Exim obtains by doing a reverse lookup of the
14908 calling host address, or
14909 .next
14910 when looked up in DNS yields the calling host address.
14911 .endlist
14912
14913 However, the EHLO or HELO command is not rejected if any of the checks
14914 fail. Processing continues, but the result of the check is remembered, and can
14915 be detected later in an ACL by the &`verify = helo`& condition.
14916
14917 If DNS was used for successful verification, the variable
14918 .cindex "DNS" "DNSSEC"
14919 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14920
14921 .option helo_verify_hosts main "host list&!!" unset
14922 .cindex "HELO verifying" "mandatory"
14923 .cindex "EHLO" "verifying, mandatory"
14924 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14925 backwards compatibility. For hosts that match this option, Exim checks the host
14926 name given in the HELO or EHLO in the same way as for
14927 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14928 rejected with a 550 error, and entries are written to the main and reject logs.
14929 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14930 error.
14931
14932 .option hold_domains main "domain list&!!" unset
14933 .cindex "domain" "delaying delivery"
14934 .cindex "delivery" "delaying certain domains"
14935 This option allows mail for particular domains to be held on the queue
14936 manually. The option is overridden if a message delivery is forced with the
14937 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14938 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14939 item in &%hold_domains%&, no routing or delivery for that address is done, and
14940 it is deferred every time the message is looked at.
14941
14942 This option is intended as a temporary operational measure for delaying the
14943 delivery of mail while some problem is being sorted out, or some new
14944 configuration tested. If you just want to delay the processing of some
14945 domains until a queue run occurs, you should use &%queue_domains%& or
14946 &%queue_smtp_domains%&, not &%hold_domains%&.
14947
14948 A setting of &%hold_domains%& does not override Exim's code for removing
14949 messages from the queue if they have been there longer than the longest retry
14950 time in any retry rule. If you want to hold messages for longer than the normal
14951 retry times, insert a dummy retry rule with a long retry time.
14952
14953
14954 .option host_lookup main "host list&!!" unset
14955 .cindex "host name" "lookup, forcing"
14956 Exim does not look up the name of a calling host from its IP address unless it
14957 is required to compare against some host list, or the host matches
14958 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14959 option (which normally contains IP addresses rather than host names). The
14960 default configuration file contains
14961 .code
14962 host_lookup = *
14963 .endd
14964 which causes a lookup to happen for all hosts. If the expense of these lookups
14965 is felt to be too great, the setting can be changed or removed.
14966
14967 After a successful reverse lookup, Exim does a forward lookup on the name it
14968 has obtained, to verify that it yields the IP address that it started with. If
14969 this check fails, Exim behaves as if the name lookup failed.
14970
14971 .vindex "&$host_lookup_failed$&"
14972 .vindex "&$sender_host_name$&"
14973 After any kind of failure, the host name (in &$sender_host_name$&) remains
14974 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14975 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14976 &`verify = reverse_host_lookup`& in ACLs.
14977
14978
14979 .option host_lookup_order main "string list" &`bydns:byaddr`&
14980 This option specifies the order of different lookup methods when Exim is trying
14981 to find a host name from an IP address. The default is to do a DNS lookup
14982 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14983 if that fails. You can change the order of these lookups, or omit one entirely,
14984 if you want.
14985
14986 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14987 multiple PTR records in the DNS and the IP address is not listed in
14988 &_/etc/hosts_&. Different operating systems give different results in this
14989 case. That is why the default tries a DNS lookup first.
14990
14991
14992
14993 .option host_reject_connection main "host list&!!" unset
14994 .cindex "host" "rejecting connections from"
14995 If this option is set, incoming SMTP calls from the hosts listed are rejected
14996 as soon as the connection is made.
14997 This option is obsolete, and retained only for backward compatibility, because
14998 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14999 connections immediately.
15000
15001 The ability to give an immediate rejection (either by this option or using an
15002 ACL) is provided for use in unusual cases. Many hosts will just try again,
15003 sometimes without much delay. Normally, it is better to use an ACL to reject
15004 incoming messages at a later stage, such as after RCPT commands. See
15005 chapter &<<CHAPACL>>&.
15006
15007
15008 .option hosts_connection_nolog main "host list&!!" unset
15009 .cindex "host" "not logging connections from"
15010 This option defines a list of hosts for which connection logging does not
15011 happen, even though the &%smtp_connection%& log selector is set. For example,
15012 you might want not to log SMTP connections from local processes, or from
15013 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15014 the daemon; you should therefore strive to restrict its value to a short inline
15015 list of IP addresses and networks. To disable logging SMTP connections from
15016 local processes, you must create a host list with an empty item. For example:
15017 .code
15018 hosts_connection_nolog = :
15019 .endd
15020 If the &%smtp_connection%& log selector is not set, this option has no effect.
15021
15022
15023
15024 .new
15025 .option hosts_proxy main "host list&!!" unset
15026 .cindex proxy "proxy protocol"
15027 This option enables use of Proxy Protocol proxies for incoming
15028 connections.  For details see &<<SECTproxyInbound>>&.
15029 .wen
15030
15031
15032 .option hosts_treat_as_local main "domain list&!!" unset
15033 .cindex "local host" "domains treated as"
15034 .cindex "host" "treated as local"
15035 If this option is set, any host names that match the domain list are treated as
15036 if they were the local host when Exim is scanning host lists obtained from MX
15037 records
15038 or other sources. Note that the value of this option is a domain list, not a
15039 host list, because it is always used to check host names, not IP addresses.
15040
15041 This option also applies when Exim is matching the special items
15042 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15043 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15044 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15045 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15046 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15047 interfaces and recognizing the local host.
15048
15049
15050 .option ibase_servers main "string list" unset
15051 .cindex "InterBase" "server list"
15052 This option provides a list of InterBase servers and associated connection data,
15053 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15054 The option is available only if Exim has been built with InterBase support.
15055
15056
15057
15058 .option ignore_bounce_errors_after main time 10w
15059 .cindex "bounce message" "discarding"
15060 .cindex "discarding bounce message"
15061 This option affects the processing of bounce messages that cannot be delivered,
15062 that is, those that suffer a permanent delivery failure. (Bounce messages that
15063 suffer temporary delivery failures are of course retried in the usual way.)
15064
15065 After a permanent delivery failure, bounce messages are frozen,
15066 because there is no sender to whom they can be returned. When a frozen bounce
15067 message has been on the queue for more than the given time, it is unfrozen at
15068 the next queue run, and a further delivery is attempted. If delivery fails
15069 again, the bounce message is discarded. This makes it possible to keep failed
15070 bounce messages around for a shorter time than the normal maximum retry time
15071 for frozen messages. For example,
15072 .code
15073 ignore_bounce_errors_after = 12h
15074 .endd
15075 retries failed bounce message deliveries after 12 hours, discarding any further
15076 failures. If the value of this option is set to a zero time period, bounce
15077 failures are discarded immediately. Setting a very long time (as in the default
15078 value) has the effect of disabling this option. For ways of automatically
15079 dealing with other kinds of frozen message, see &%auto_thaw%& and
15080 &%timeout_frozen_after%&.
15081
15082
15083 .option ignore_fromline_hosts main "host list&!!" unset
15084 .cindex "&""From""& line"
15085 .cindex "UUCP" "&""From""& line"
15086 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15087 the headers of a message. By default this is treated as the start of the
15088 message's body, which means that any following headers are not recognized as
15089 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15090 match those hosts that insist on sending it. If the sender is actually a local
15091 process rather than a remote host, and is using &%-bs%& to inject the messages,
15092 &%ignore_fromline_local%& must be set to achieve this effect.
15093
15094
15095 .option ignore_fromline_local main boolean false
15096 See &%ignore_fromline_hosts%& above.
15097
15098 .new
15099 .option keep_environment main "string list" unset
15100 .cindex "environment" "values from"
15101 This option contains a string list of environment variables to keep.
15102 You have to trust these variables or you have to be sure that
15103 these variables do not impose any security risk. Keep in mind that
15104 during the startup phase Exim is running with an effective UID 0 in most
15105 installations. As the default value is an empty list, the default
15106 environment for using libraries, running embedded Perl code, or running
15107 external binaries is empty, and does not not even contain PATH or HOME.
15108
15109 Actually the list is interpreted as a list of patterns
15110 (&<<SECTlistexpand>>&), except that it is not expanded first.
15111
15112 WARNING: Macro substitution is still done first, so having a macro
15113 FOO and having FOO_HOME in your &%keep_environment%& option may have
15114 unexpected results. You may work around this using a regular expression
15115 that does not match the macro name: ^[F]OO_HOME$.
15116
15117 Current versions of Exim issue a warning during startupif you do not mention
15118 &%keep_environment%& or &%add_environment%& in your runtime configuration
15119 file.
15120 .wen
15121
15122
15123 .option keep_malformed main time 4d
15124 This option specifies the length of time to keep messages whose spool files
15125 have been corrupted in some way. This should, of course, never happen. At the
15126 next attempt to deliver such a message, it gets removed. The incident is
15127 logged.
15128
15129
15130 .option ldap_ca_cert_dir main string unset
15131 .cindex "LDAP", "TLS CA certificate directory"
15132 .cindex certificate "directory for LDAP"
15133 This option indicates which directory contains CA certificates for verifying
15134 a TLS certificate presented by an LDAP server.
15135 While Exim does not provide a default value, your SSL library may.
15136 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15137 and constrained to be a directory.
15138
15139
15140 .option ldap_ca_cert_file main string unset
15141 .cindex "LDAP", "TLS CA certificate file"
15142 .cindex certificate "file for LDAP"
15143 This option indicates which file contains CA certificates for verifying
15144 a TLS certificate presented by an LDAP server.
15145 While Exim does not provide a default value, your SSL library may.
15146 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15147 and constrained to be a file.
15148
15149
15150 .option ldap_cert_file main string unset
15151 .cindex "LDAP" "TLS client certificate file"
15152 .cindex certificate "file for LDAP"
15153 This option indicates which file contains an TLS client certificate which
15154 Exim should present to the LDAP server during TLS negotiation.
15155 Should be used together with &%ldap_cert_key%&.
15156
15157
15158 .option ldap_cert_key main string unset
15159 .cindex "LDAP" "TLS client key file"
15160 .cindex certificate "key for LDAP"
15161 This option indicates which file contains the secret/private key to use
15162 to prove identity to the LDAP server during TLS negotiation.
15163 Should be used together with &%ldap_cert_file%&, which contains the
15164 identity to be proven.
15165
15166
15167 .option ldap_cipher_suite main string unset
15168 .cindex "LDAP" "TLS cipher suite"
15169 This controls the TLS cipher-suite negotiation during TLS negotiation with
15170 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15171 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15172
15173
15174 .option ldap_default_servers main "string list" unset
15175 .cindex "LDAP" "default servers"
15176 This option provides a list of LDAP servers which are tried in turn when an
15177 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15178 details of LDAP queries. This option is available only when Exim has been built
15179 with LDAP support.
15180
15181
15182 .option ldap_require_cert main string unset.
15183 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15184 This should be one of the values "hard", "demand", "allow", "try" or "never".
15185 A value other than one of these is interpreted as "never".
15186 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15187 Although Exim does not set a default, the LDAP library probably defaults
15188 to hard/demand.
15189
15190
15191 .option ldap_start_tls main boolean false
15192 .cindex "LDAP" "whether or not to negotiate TLS"
15193 If set, Exim will attempt to negotiate TLS with the LDAP server when
15194 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15195 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15196 of SSL-on-connect.
15197 In the event of failure to negotiate TLS, the action taken is controlled
15198 by &%ldap_require_cert%&.
15199
15200
15201 .option ldap_version main integer unset
15202 .cindex "LDAP" "protocol version, forcing"
15203 This option can be used to force Exim to set a specific protocol version for
15204 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15205 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15206 the LDAP headers; otherwise it is 2. This option is available only when Exim
15207 has been built with LDAP support.
15208
15209
15210
15211 .option local_from_check main boolean true
15212 .cindex "&'Sender:'& header line" "disabling addition of"
15213 .cindex "&'From:'& header line" "disabling checking of"
15214 When a message is submitted locally (that is, not over a TCP/IP connection) by
15215 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15216 checks that the &'From:'& header line matches the login of the calling user and
15217 the domain specified by &%qualify_domain%&.
15218
15219 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15220 locally submitted message is automatically qualified by Exim, unless the
15221 &%-bnq%& command line option is used.
15222
15223 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15224 on the local part. If the &'From:'& header line does not match, Exim adds a
15225 &'Sender:'& header with an address constructed from the calling user's login
15226 and the default qualify domain.
15227
15228 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15229 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15230 &'Sender:'& header lines supplied by untrusted users, you must also set
15231 &%local_sender_retain%& to be true.
15232
15233 .cindex "envelope sender"
15234 These options affect only the header lines in the message. The envelope sender
15235 is still forced to be the login id at the qualify domain unless
15236 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15237
15238 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15239 request similar header line checking. See section &<<SECTthesenhea>>&, which
15240 has more details about &'Sender:'& processing.
15241
15242
15243
15244
15245 .option local_from_prefix main string unset
15246 When Exim checks the &'From:'& header line of locally submitted messages for
15247 matching the login id (see &%local_from_check%& above), it can be configured to
15248 ignore certain prefixes and suffixes in the local part of the address. This is
15249 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15250 appropriate lists, in the same form as the &%local_part_prefix%& and
15251 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15252 example, if
15253 .code
15254 local_from_prefix = *-
15255 .endd
15256 is set, a &'From:'& line containing
15257 .code
15258 From: anything-user@your.domain.example
15259 .endd
15260 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15261 matches the actual sender address that is constructed from the login name and
15262 qualify domain.
15263
15264
15265 .option local_from_suffix main string unset
15266 See &%local_from_prefix%& above.
15267
15268
15269 .option local_interfaces main "string list" "see below"
15270 This option controls which network interfaces are used by the daemon for
15271 listening; they are also used to identify the local host when routing. Chapter
15272 &<<CHAPinterfaces>>& contains a full description of this option and the related
15273 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15274 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15275 &%local_interfaces%& is
15276 .code
15277 local_interfaces = 0.0.0.0
15278 .endd
15279 when Exim is built without IPv6 support; otherwise it is
15280 .code
15281 local_interfaces = <; ::0 ; 0.0.0.0
15282 .endd
15283
15284 .option local_scan_timeout main time 5m
15285 .cindex "timeout" "for &[local_scan()]& function"
15286 .cindex "&[local_scan()]& function" "timeout"
15287 This timeout applies to the &[local_scan()]& function (see chapter
15288 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15289 the incoming message is rejected with a temporary error if it is an SMTP
15290 message. For a non-SMTP message, the message is dropped and Exim ends with a
15291 non-zero code. The incident is logged on the main and reject logs.
15292
15293
15294
15295 .option local_sender_retain main boolean false
15296 .cindex "&'Sender:'& header line" "retaining from local submission"
15297 When a message is submitted locally (that is, not over a TCP/IP connection) by
15298 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15299 do not want this to happen, you must set &%local_sender_retain%&, and you must
15300 also set &%local_from_check%& to be false (Exim will complain if you do not).
15301 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15302 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15303
15304
15305
15306
15307 .option localhost_number main string&!! unset
15308 .cindex "host" "locally unique number for"
15309 .cindex "message ids" "with multiple hosts"
15310 .vindex "&$localhost_number$&"
15311 Exim's message ids are normally unique only within the local host. If
15312 uniqueness among a set of hosts is required, each host must set a different
15313 value for the &%localhost_number%& option. The string is expanded immediately
15314 after reading the configuration file (so that a number can be computed from the
15315 host name, for example) and the result of the expansion must be a number in the
15316 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15317 systems). This is available in subsequent string expansions via the variable
15318 &$localhost_number$&. When &%localhost_number is set%&, the final two
15319 characters of the message id, instead of just being a fractional part of the
15320 time, are computed from the time and the local host number as described in
15321 section &<<SECTmessiden>>&.
15322
15323
15324
15325 .option log_file_path main "string list&!!" "set at compile time"
15326 .cindex "log" "file path for"
15327 This option sets the path which is used to determine the names of Exim's log
15328 files, or indicates that logging is to be to syslog, or both. It is expanded
15329 when Exim is entered, so it can, for example, contain a reference to the host
15330 name. If no specific path is set for the log files at compile or run time,
15331 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15332 they are written in a sub-directory called &_log_& in Exim's spool directory.
15333 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15334 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15335 used. If this string is fixed at your installation (contains no expansion
15336 variables) it is recommended that you do not set this option in the
15337 configuration file, but instead supply the path using LOG_FILE_PATH in
15338 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15339 early on &-- in particular, failure to read the configuration file.
15340
15341
15342 .option log_selector main string unset
15343 .cindex "log" "selectors"
15344 This option can be used to reduce or increase the number of things that Exim
15345 writes to its log files. Its argument is made up of names preceded by plus or
15346 minus characters. For example:
15347 .code
15348 log_selector = +arguments -retry_defer
15349 .endd
15350 A list of possible names and what they control is given in the chapter on
15351 logging, in section &<<SECTlogselector>>&.
15352
15353
15354 .option log_timezone main boolean false
15355 .cindex "log" "timezone for entries"
15356 .vindex "&$tod_log$&"
15357 .vindex "&$tod_zone$&"
15358 By default, the timestamps on log lines are in local time without the
15359 timezone. This means that if your timezone changes twice a year, the timestamps
15360 in log lines are ambiguous for an hour when the clocks go back. One way of
15361 avoiding this problem is to set the timezone to UTC. An alternative is to set
15362 &%log_timezone%& true. This turns on the addition of the timezone offset to
15363 timestamps in log lines. Turning on this option can add quite a lot to the size
15364 of log files because each line is extended by 6 characters. Note that the
15365 &$tod_log$& variable contains the log timestamp without the zone, but there is
15366 another variable called &$tod_zone$& that contains just the timezone offset.
15367
15368
15369 .option lookup_open_max main integer 25
15370 .cindex "too many open files"
15371 .cindex "open files, too many"
15372 .cindex "file" "too many open"
15373 .cindex "lookup" "maximum open files"
15374 .cindex "limit" "open files for lookups"
15375 This option limits the number of simultaneously open files for single-key
15376 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15377 Exim normally keeps these files open during routing, because often the same
15378 file is required several times. If the limit is reached, Exim closes the least
15379 recently used file. Note that if you are using the &'ndbm'& library, it
15380 actually opens two files for each logical DBM database, though it still counts
15381 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15382 open files"& errors with NDBM, you need to reduce the value of
15383 &%lookup_open_max%&.
15384
15385
15386 .option max_username_length main integer 0
15387 .cindex "length of login name"
15388 .cindex "user name" "maximum length"
15389 .cindex "limit" "user name length"
15390 Some operating systems are broken in that they truncate long arguments to
15391 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15392 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15393 an argument that is longer behaves as if &[getpwnam()]& failed.
15394
15395
15396 .option message_body_newlines main bool false
15397 .cindex "message body" "newlines in variables"
15398 .cindex "newline" "in message body variables"
15399 .vindex "&$message_body$&"
15400 .vindex "&$message_body_end$&"
15401 By default, newlines in the message body are replaced by spaces when setting
15402 the &$message_body$& and &$message_body_end$& expansion variables. If this
15403 option is set true, this no longer happens.
15404
15405
15406 .option message_body_visible main integer 500
15407 .cindex "body of message" "visible size"
15408 .cindex "message body" "visible size"
15409 .vindex "&$message_body$&"
15410 .vindex "&$message_body_end$&"
15411 This option specifies how much of a message's body is to be included in the
15412 &$message_body$& and &$message_body_end$& expansion variables.
15413
15414
15415 .option message_id_header_domain main string&!! unset
15416 .cindex "&'Message-ID:'& header line"
15417 If this option is set, the string is expanded and used as the right hand side
15418 (domain) of the &'Message-ID:'& header that Exim creates if a
15419 locally-originated incoming message does not have one. &"Locally-originated"&
15420 means &"not received over TCP/IP."&
15421 Otherwise, the primary host name is used.
15422 Only letters, digits, dot and hyphen are accepted; any other characters are
15423 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15424 empty string, the option is ignored.
15425
15426
15427 .option message_id_header_text main string&!! unset
15428 If this variable is set, the string is expanded and used to augment the text of
15429 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15430 message does not have one. The text of this header is required by RFC 2822 to
15431 take the form of an address. By default, Exim uses its internal message id as
15432 the local part, and the primary host name as the domain. If this option is set,
15433 it is expanded, and provided the expansion is not forced to fail, and does not
15434 yield an empty string, the result is inserted into the header immediately
15435 before the @, separated from the internal message id by a dot. Any characters
15436 that are illegal in an address are automatically converted into hyphens. This
15437 means that variables such as &$tod_log$& can be used, because the spaces and
15438 colons will become hyphens.
15439
15440
15441 .option message_logs main boolean true
15442 .cindex "message logs" "disabling"
15443 .cindex "log" "message log; disabling"
15444 If this option is turned off, per-message log files are not created in the
15445 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15446 Exim, by reducing the number of files involved in handling a message from a
15447 minimum of four (header spool file, body spool file, delivery journal, and
15448 per-message log) to three. The other major I/O activity is Exim's main log,
15449 which is not affected by this option.
15450
15451
15452 .option message_size_limit main string&!! 50M
15453 .cindex "message" "size limit"
15454 .cindex "limit" "message size"
15455 .cindex "size" "of message, limit"
15456 This option limits the maximum size of message that Exim will process. The
15457 value is expanded for each incoming connection so, for example, it can be made
15458 to depend on the IP address of the remote host for messages arriving via
15459 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15460 optionally followed by K or M.
15461
15462 &*Note*&: This limit cannot be made to depend on a message's sender or any
15463 other properties of an individual message, because it has to be advertised in
15464 the server's response to EHLO. String expansion failure causes a temporary
15465 error. A value of zero means no limit, but its use is not recommended. See also
15466 &%bounce_return_size_limit%&.
15467
15468 Incoming SMTP messages are failed with a 552 error if the limit is
15469 exceeded; locally-generated messages either get a stderr message or a delivery
15470 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15471 an oversized message is logged in both the main and the reject logs. See also
15472 the generic transport option &%message_size_limit%&, which limits the size of
15473 message that an individual transport can process.
15474
15475 If you use a virus-scanner and set this option to to a value larger than the
15476 maximum size that your virus-scanner is configured to support, you may get
15477 failures triggered by large mails.  The right size to configure for the
15478 virus-scanner depends upon what data is passed and the options in use but it's
15479 probably safest to just set it to a little larger than this value.  E.g., with a
15480 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15481 some problems may result.
15482
15483 A value of 0 will disable size limit checking; Exim will still advertise the
15484 SIZE extension in an EHLO response, but without a limit, so as to permit
15485 SMTP clients to still indicate the message size along with the MAIL verb.
15486
15487
15488 .option move_frozen_messages main boolean false
15489 .cindex "frozen messages" "moving"
15490 This option, which is available only if Exim has been built with the setting
15491 .code
15492 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15493 .endd
15494 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15495 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15496 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15497 standard utilities for handling such moved messages, and they do not show up in
15498 lists generated by &%-bp%& or by the Exim monitor.
15499
15500
15501 .option mua_wrapper main boolean false
15502 Setting this option true causes Exim to run in a very restrictive mode in which
15503 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15504 contains a full description of this facility.
15505
15506
15507
15508 .option mysql_servers main "string list" unset
15509 .cindex "MySQL" "server list"
15510 This option provides a list of MySQL servers and associated connection data, to
15511 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15512 option is available only if Exim has been built with MySQL support.
15513
15514
15515 .option never_users main "string list&!!" unset
15516 This option is expanded just once, at the start of Exim's processing. Local
15517 message deliveries are normally run in processes that are setuid to the
15518 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15519 It is usually desirable to prevent any deliveries from running as root, as a
15520 safety precaution.
15521
15522 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15523 list of users that must not be used for local deliveries. This list is fixed in
15524 the binary and cannot be overridden by the configuration file. By default, it
15525 contains just the single user name &"root"&. The &%never_users%& runtime option
15526 can be used to add more users to the fixed list.
15527
15528 If a message is to be delivered as one of the users on the fixed list or the
15529 &%never_users%& list, an error occurs, and delivery is deferred. A common
15530 example is
15531 .code
15532 never_users = root:daemon:bin
15533 .endd
15534 Including root is redundant if it is also on the fixed list, but it does no
15535 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15536 transport driver.
15537
15538
15539 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15540 .cindex "OpenSSL "compatibility options"
15541 This option allows an administrator to adjust the SSL options applied
15542 by OpenSSL to connections.  It is given as a space-separated list of items,
15543 each one to be +added or -subtracted from the current value.
15544
15545 This option is only available if Exim is built against OpenSSL.  The values
15546 available for this option vary according to the age of your OpenSSL install.
15547 The &"all"& value controls a subset of flags which are available, typically
15548 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15549 list the values known on your system and Exim should support all the
15550 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15551 names lose the leading &"SSL_OP_"& and are lower-cased.
15552
15553 Note that adjusting the options can have severe impact upon the security of
15554 SSL as used by Exim.  It is possible to disable safety checks and shoot
15555 yourself in the foot in various unpleasant ways.  This option should not be
15556 adjusted lightly.  An unrecognised item will be detected at startup, by
15557 invoking Exim with the &%-bV%& flag.
15558
15559 The option affects Exim operating both as a server and as a client.
15560
15561 Historical note: prior to release 4.80, Exim defaulted this value to
15562 "+dont_insert_empty_fragments", which may still be needed for compatibility
15563 with some clients, but which lowers security by increasing exposure to
15564 some now infamous attacks.
15565
15566 Examples:
15567 .code
15568 # Make both old MS and old Eudora happy:
15569 openssl_options = -all +microsoft_big_sslv3_buffer \
15570                        +dont_insert_empty_fragments
15571
15572 # Disable older protocol versions:
15573 openssl_options = +no_sslv2 +no_sslv3
15574 .endd
15575
15576 Possible options may include:
15577 .ilist
15578 &`all`&
15579 .next
15580 &`allow_unsafe_legacy_renegotiation`&
15581 .next
15582 &`cipher_server_preference`&
15583 .next
15584 &`dont_insert_empty_fragments`&
15585 .next
15586 &`ephemeral_rsa`&
15587 .next
15588 &`legacy_server_connect`&
15589 .next
15590 &`microsoft_big_sslv3_buffer`&
15591 .next
15592 &`microsoft_sess_id_bug`&
15593 .next
15594 &`msie_sslv2_rsa_padding`&
15595 .next
15596 &`netscape_challenge_bug`&
15597 .next
15598 &`netscape_reuse_cipher_change_bug`&
15599 .next
15600 &`no_compression`&
15601 .next
15602 &`no_session_resumption_on_renegotiation`&
15603 .next
15604 &`no_sslv2`&
15605 .next
15606 &`no_sslv3`&
15607 .next
15608 &`no_ticket`&
15609 .next
15610 &`no_tlsv1`&
15611 .next
15612 &`no_tlsv1_1`&
15613 .next
15614 &`no_tlsv1_2`&
15615 .next
15616 &`safari_ecdhe_ecdsa_bug`&
15617 .next
15618 &`single_dh_use`&
15619 .next
15620 &`single_ecdh_use`&
15621 .next
15622 &`ssleay_080_client_dh_bug`&
15623 .next
15624 &`sslref2_reuse_cert_type_bug`&
15625 .next
15626 &`tls_block_padding_bug`&
15627 .next
15628 &`tls_d5_bug`&
15629 .next
15630 &`tls_rollback_bug`&
15631 .endlist
15632
15633 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15634 all clients connecting using the MacOS SecureTransport TLS facility prior
15635 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15636 to negotiate TLS then this option value might help, provided that your OpenSSL
15637 release is new enough to contain this work-around.  This may be a situation
15638 where you have to upgrade OpenSSL to get buggy clients working.
15639
15640
15641 .option oracle_servers main "string list" unset
15642 .cindex "Oracle" "server list"
15643 This option provides a list of Oracle servers and associated connection data,
15644 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15645 The option is available only if Exim has been built with Oracle support.
15646
15647
15648 .option percent_hack_domains main "domain list&!!" unset
15649 .cindex "&""percent hack""&"
15650 .cindex "source routing" "in email address"
15651 .cindex "address" "source-routed"
15652 The &"percent hack"& is the convention whereby a local part containing a
15653 percent sign is re-interpreted as a new email address, with the percent
15654 replaced by @. This is sometimes called &"source routing"&, though that term is
15655 also applied to RFC 2822 addresses that begin with an @ character. If this
15656 option is set, Exim implements the percent facility for those domains listed,
15657 but no others. This happens before an incoming SMTP address is tested against
15658 an ACL.
15659
15660 &*Warning*&: The &"percent hack"& has often been abused by people who are
15661 trying to get round relaying restrictions. For this reason, it is best avoided
15662 if at all possible. Unfortunately, a number of less security-conscious MTAs
15663 implement it unconditionally. If you are running Exim on a gateway host, and
15664 routing mail through to internal MTAs without processing the local parts, it is
15665 a good idea to reject recipient addresses with percent characters in their
15666 local parts. Exim's default configuration does this.
15667
15668
15669 .option perl_at_start main boolean false
15670 This option is available only when Exim is built with an embedded Perl
15671 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15672
15673
15674 .option perl_startup main string unset
15675 This option is available only when Exim is built with an embedded Perl
15676 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15677
15678
15679 .option pgsql_servers main "string list" unset
15680 .cindex "PostgreSQL lookup type" "server list"
15681 This option provides a list of PostgreSQL servers and associated connection
15682 data, to be used in conjunction with &(pgsql)& lookups (see section
15683 &<<SECID72>>&). The option is available only if Exim has been built with
15684 PostgreSQL support.
15685
15686
15687 .option pid_file_path main string&!! "set at compile time"
15688 .cindex "daemon" "pid file path"
15689 .cindex "pid file, path for"
15690 This option sets the name of the file to which the Exim daemon writes its
15691 process id. The string is expanded, so it can contain, for example, references
15692 to the host name:
15693 .code
15694 pid_file_path = /var/log/$primary_hostname/exim.pid
15695 .endd
15696 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15697 spool directory.
15698 The value set by the option can be overridden by the &%-oP%& command line
15699 option. A pid file is not written if a &"non-standard"& daemon is run by means
15700 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15701
15702
15703 .option pipelining_advertise_hosts main "host list&!!" *
15704 .cindex "PIPELINING" "suppressing advertising"
15705 This option can be used to suppress the advertisement of the SMTP
15706 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15707 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15708 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15709 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15710 that clients will use it; &"out of order"& commands that are &"expected"& do
15711 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15712
15713
15714 .option prdr_enable main boolean false
15715 .cindex "PRDR" "enabling on server"
15716 This option can be used to enable the Per-Recipient Data Response extension
15717 to SMTP, defined by Eric Hall.
15718 If the option is set, PRDR is advertised by Exim when operating as a server.
15719 If the client requests PRDR, and more than one recipient, for a message
15720 an additional ACL is called for each recipient after the message content
15721 is received.  See section &<<SECTPRDRACL>>&.
15722
15723 .option preserve_message_logs main boolean false
15724 .cindex "message logs" "preserving"
15725 If this option is set, message log files are not deleted when messages are
15726 completed. Instead, they are moved to a sub-directory of the spool directory
15727 called &_msglog.OLD_&, where they remain available for statistical or debugging
15728 purposes. This is a dangerous option to set on systems with any appreciable
15729 volume of mail. Use with care!
15730
15731
15732 .option primary_hostname main string "see below"
15733 .cindex "name" "of local host"
15734 .cindex "host" "name of local"
15735 .cindex "local host" "name of"
15736 .vindex "&$primary_hostname$&"
15737 This specifies the name of the current host. It is used in the default EHLO or
15738 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15739 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15740 The value is also used by default in some SMTP response messages from an Exim
15741 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15742
15743 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15744 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15745 contains only one component, Exim passes it to &[gethostbyname()]& (or
15746 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15747 version. The variable &$primary_hostname$& contains the host name, whether set
15748 explicitly by this option, or defaulted.
15749
15750
15751 .option print_topbitchars main boolean false
15752 .cindex "printing characters"
15753 .cindex "8-bit characters"
15754 By default, Exim considers only those characters whose codes lie in the range
15755 32&--126 to be printing characters. In a number of circumstances (for example,
15756 when writing log entries) non-printing characters are converted into escape
15757 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15758 is set, code values of 128 and above are also considered to be printing
15759 characters.
15760
15761 This option also affects the header syntax checks performed by the
15762 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15763 the user's full name when constructing From: and Sender: addresses (as
15764 described in section &<<SECTconstr>>&). Setting this option can cause
15765 Exim to generate eight bit message headers that do not conform to the
15766 standards.
15767
15768
15769 .option process_log_path main string unset
15770 .cindex "process log path"
15771 .cindex "log" "process log"
15772 .cindex "&'exiwhat'&"
15773 This option sets the name of the file to which an Exim process writes its
15774 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15775 utility script. If this option is unset, the file called &_exim-process.info_&
15776 in Exim's spool directory is used. The ability to specify the name explicitly
15777 can be useful in environments where two different Exims are running, using
15778 different spool directories.
15779
15780
15781 .option prod_requires_admin main boolean true
15782 .oindex "&%-M%&"
15783 .oindex "&%-R%&"
15784 .oindex "&%-q%&"
15785 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15786 admin user unless &%prod_requires_admin%& is set false. See also
15787 &%queue_list_requires_admin%&.
15788
15789
15790 .option qualify_domain main string "see below"
15791 .cindex "domain" "for qualifying addresses"
15792 .cindex "address" "qualification"
15793 This option specifies the domain name that is added to any envelope sender
15794 addresses that do not have a domain qualification. It also applies to
15795 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15796 are accepted by default only for locally-generated messages. Qualification is
15797 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15798 locally-generated messages, unless the &%-bnq%& command line option is used.
15799
15800 Messages from external sources must always contain fully qualified addresses,
15801 unless the sending host matches &%sender_unqualified_hosts%& or
15802 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15803 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15804 necessary. Internally, Exim always works with fully qualified envelope
15805 addresses. If &%qualify_domain%& is not set, it defaults to the
15806 &%primary_hostname%& value.
15807
15808
15809 .option qualify_recipient main string "see below"
15810 This option allows you to specify a different domain for qualifying recipient
15811 addresses to the one that is used for senders. See &%qualify_domain%& above.
15812
15813
15814
15815 .option queue_domains main "domain list&!!" unset
15816 .cindex "domain" "specifying non-immediate delivery"
15817 .cindex "queueing incoming messages"
15818 .cindex "message" "queueing certain domains"
15819 This option lists domains for which immediate delivery is not required.
15820 A delivery process is started whenever a message is received, but only those
15821 domains that do not match are processed. All other deliveries wait until the
15822 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15823
15824
15825 .option queue_list_requires_admin main boolean true
15826 .oindex "&%-bp%&"
15827 The &%-bp%& command-line option, which lists the messages that are on the
15828 queue, requires the caller to be an admin user unless
15829 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15830
15831
15832 .option queue_only main boolean false
15833 .cindex "queueing incoming messages"
15834 .cindex "message" "queueing unconditionally"
15835 If &%queue_only%& is set, a delivery process is not automatically started
15836 whenever a message is received. Instead, the message waits on the queue for the
15837 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15838 delivered immediately when certain conditions (such as heavy load) occur.
15839
15840 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15841 and &%-odi%& command line options override &%queue_only%& unless
15842 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15843 &%queue_only_load%&, and &%smtp_accept_queue%&.
15844
15845
15846 .option queue_only_file main string unset
15847 .cindex "queueing incoming messages"
15848 .cindex "message" "queueing by file existence"
15849 This option can be set to a colon-separated list of absolute path names, each
15850 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15851 it tests for the existence of each listed path using a call to &[stat()]&. For
15852 each path that exists, the corresponding queueing option is set.
15853 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15854 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15855 .code
15856 queue_only_file = smtp/some/file
15857 .endd
15858 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15859 &_/some/file_& exists.
15860
15861
15862 .option queue_only_load main fixed-point unset
15863 .cindex "load average"
15864 .cindex "queueing incoming messages"
15865 .cindex "message" "queueing by load"
15866 If the system load average is higher than this value, incoming messages from
15867 all sources are queued, and no automatic deliveries are started. If this
15868 happens during local or remote SMTP input, all subsequent messages received on
15869 the same SMTP connection are queued by default, whatever happens to the load in
15870 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15871 false.
15872
15873 Deliveries will subsequently be performed by queue runner processes. This
15874 option has no effect on ancient operating systems on which Exim cannot
15875 determine the load average. See also &%deliver_queue_load_max%& and
15876 &%smtp_load_reserve%&.
15877
15878
15879 .option queue_only_load_latch main boolean true
15880 .cindex "load average" "re-evaluating per message"
15881 When this option is true (the default), once one message has been queued
15882 because the load average is higher than the value set by &%queue_only_load%&,
15883 all subsequent messages received on the same SMTP connection are also queued.
15884 This is a deliberate choice; even though the load average may fall below the
15885 threshold, it doesn't seem right to deliver later messages on the same
15886 connection when not delivering earlier ones. However, there are special
15887 circumstances such as very long-lived connections from scanning appliances
15888 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15889 should be set false. This causes the value of the load average to be
15890 re-evaluated for each message.
15891
15892
15893 .option queue_only_override main boolean true
15894 .cindex "queueing incoming messages"
15895 When this option is true, the &%-od%&&'x'& command line options override the
15896 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15897 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15898 to override; they are accepted, but ignored.
15899
15900
15901 .option queue_run_in_order main boolean false
15902 .cindex "queue runner" "processing messages in order"
15903 If this option is set, queue runs happen in order of message arrival instead of
15904 in an arbitrary order. For this to happen, a complete list of the entire queue
15905 must be set up before the deliveries start. When the queue is all held in a
15906 single directory (the default), a single list is created for both the ordered
15907 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15908 single list is not created when &%queue_run_in_order%& is false. In this case,
15909 the sub-directories are processed one at a time (in a random order), and this
15910 avoids setting up one huge list for the whole queue. Thus, setting
15911 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15912 when the queue is large, because of the extra work in setting up the single,
15913 large list. In most situations, &%queue_run_in_order%& should not be set.
15914
15915
15916
15917 .option queue_run_max main integer 5
15918 .cindex "queue runner" "maximum number of"
15919 This controls the maximum number of queue runner processes that an Exim daemon
15920 can run simultaneously. This does not mean that it starts them all at once,
15921 but rather that if the maximum number are still running when the time comes to
15922 start another one, it refrains from starting another one. This can happen with
15923 very large queues and/or very sluggish deliveries. This option does not,
15924 however, interlock with other processes, so additional queue runners can be
15925 started by other means, or by killing and restarting the daemon.
15926
15927 Setting this option to zero does not suppress queue runs; rather, it disables
15928 the limit, allowing any number of simultaneous queue runner processes to be
15929 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15930 the daemon's command line.
15931
15932 .option queue_smtp_domains main "domain list&!!" unset
15933 .cindex "queueing incoming messages"
15934 .cindex "message" "queueing remote deliveries"
15935 When this option is set, a delivery process is started whenever a message is
15936 received, routing is performed, and local deliveries take place.
15937 However, if any SMTP deliveries are required for domains that match
15938 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15939 message waits on the queue for the next queue run. Since routing of the message
15940 has taken place, Exim knows to which remote hosts it must be delivered, and so
15941 when the queue run happens, multiple messages for the same host are delivered
15942 over a single SMTP connection. The &%-odqs%& command line option causes all
15943 SMTP deliveries to be queued in this way, and is equivalent to setting
15944 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15945 &%queue_domains%&.
15946
15947
15948 .option receive_timeout main time 0s
15949 .cindex "timeout" "for non-SMTP input"
15950 This option sets the timeout for accepting a non-SMTP message, that is, the
15951 maximum time that Exim waits when reading a message on the standard input. If
15952 the value is zero, it will wait for ever. This setting is overridden by the
15953 &%-or%& command line option. The timeout for incoming SMTP messages is
15954 controlled by &%smtp_receive_timeout%&.
15955
15956 .option received_header_text main string&!! "see below"
15957 .cindex "customizing" "&'Received:'& header"
15958 .cindex "&'Received:'& header line" "customizing"
15959 This string defines the contents of the &'Received:'& message header that is
15960 added to each message, except for the timestamp, which is automatically added
15961 on at the end (preceded by a semicolon). The string is expanded each time it is
15962 used. If the expansion yields an empty string, no &'Received:'& header line is
15963 added to the message. Otherwise, the string should start with the text
15964 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15965 header lines. The default setting is:
15966
15967 .code
15968 received_header_text = Received: \
15969   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15970   {${if def:sender_ident \
15971   {from ${quote_local_part:$sender_ident} }}\
15972   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15973   by $primary_hostname \
15974   ${if def:received_protocol {with $received_protocol}} \
15975   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15976   (Exim $version_number)\n\t\
15977   ${if def:sender_address \
15978   {(envelope-from <$sender_address>)\n\t}}\
15979   id $message_exim_id\
15980   ${if def:received_for {\n\tfor $received_for}}
15981 .endd
15982
15983 The reference to the TLS cipher is omitted when Exim is built without TLS
15984 support. The use of conditional expansions ensures that this works for both
15985 locally generated messages and messages received from remote hosts, giving
15986 header lines such as the following:
15987 .code
15988 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15989 by marley.carol.example with esmtp (Exim 4.00)
15990 (envelope-from <bob@carol.example>)
15991 id 16IOWa-00019l-00
15992 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15993 Received: by scrooge.carol.example with local (Exim 4.00)
15994 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15995 .endd
15996 Until the body of the message has been received, the timestamp is the time when
15997 the message started to be received. Once the body has arrived, and all policy
15998 checks have taken place, the timestamp is updated to the time at which the
15999 message was accepted.
16000
16001
16002 .option received_headers_max main integer 30
16003 .cindex "loop" "prevention"
16004 .cindex "mail loop prevention"
16005 .cindex "&'Received:'& header line" "counting"
16006 When a message is to be delivered, the number of &'Received:'& headers is
16007 counted, and if it is greater than this parameter, a mail loop is assumed to
16008 have occurred, the delivery is abandoned, and an error message is generated.
16009 This applies to both local and remote deliveries.
16010
16011
16012 .option recipient_unqualified_hosts main "host list&!!" unset
16013 .cindex "unqualified addresses"
16014 .cindex "host" "unqualified addresses from"
16015 This option lists those hosts from which Exim is prepared to accept unqualified
16016 recipient addresses in message envelopes. The addresses are made fully
16017 qualified by the addition of the &%qualify_recipient%& value. This option also
16018 affects message header lines. Exim does not reject unqualified recipient
16019 addresses in headers, but it qualifies them only if the message came from a
16020 host that matches &%recipient_unqualified_hosts%&,
16021 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16022 option was not set.
16023
16024
16025 .option recipients_max main integer 0
16026 .cindex "limit" "number of recipients"
16027 .cindex "recipient" "maximum number"
16028 If this option is set greater than zero, it specifies the maximum number of
16029 original recipients for any message. Additional recipients that are generated
16030 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16031 all recipients over the limit; earlier recipients are delivered as normal.
16032 Non-SMTP messages with too many recipients are failed, and no deliveries are
16033 done.
16034
16035 .cindex "RCPT" "maximum number of incoming"
16036 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16037 RCPT commands in a single message.
16038
16039
16040 .option recipients_max_reject main boolean false
16041 If this option is set true, Exim rejects SMTP messages containing too many
16042 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16043 error to the eventual DATA command. Otherwise (the default) it gives a 452
16044 error to the surplus RCPT commands and accepts the message on behalf of the
16045 initial set of recipients. The remote server should then re-send the message
16046 for the remaining recipients at a later time.
16047
16048
16049 .option remote_max_parallel main integer 2
16050 .cindex "delivery" "parallelism for remote"
16051 This option controls parallel delivery of one message to a number of remote
16052 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16053 does all the remote deliveries for a message one by one. Otherwise, if a single
16054 message has to be delivered to more than one remote host, or if several copies
16055 have to be sent to the same remote host, up to &%remote_max_parallel%&
16056 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16057 deliveries are required, the maximum number of processes are started, and as
16058 each one finishes, another is begun. The order of starting processes is the
16059 same as if sequential delivery were being done, and can be controlled by the
16060 &%remote_sort_domains%& option. If parallel delivery takes place while running
16061 with debugging turned on, the debugging output from each delivery process is
16062 tagged with its process id.
16063
16064 This option controls only the maximum number of parallel deliveries for one
16065 message in one Exim delivery process. Because Exim has no central queue
16066 manager, there is no way of controlling the total number of simultaneous
16067 deliveries if the configuration allows a delivery attempt as soon as a message
16068 is received.
16069
16070 .cindex "number of deliveries"
16071 .cindex "delivery" "maximum number of"
16072 If you want to control the total number of deliveries on the system, you
16073 need to set the &%queue_only%& option. This ensures that all incoming messages
16074 are added to the queue without starting a delivery process. Then set up an Exim
16075 daemon to start queue runner processes at appropriate intervals (probably
16076 fairly often, for example, every minute), and limit the total number of queue
16077 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16078 delivers only one message at a time, the maximum number of deliveries that can
16079 then take place at once is &%queue_run_max%& multiplied by
16080 &%remote_max_parallel%&.
16081
16082 If it is purely remote deliveries you want to control, use
16083 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16084 doing the SMTP routing before queueing, so that several messages for the same
16085 host will eventually get delivered down the same connection.
16086
16087
16088 .option remote_sort_domains main "domain list&!!" unset
16089 .cindex "sorting remote deliveries"
16090 .cindex "delivery" "sorting remote"
16091 When there are a number of remote deliveries for a message, they are sorted by
16092 domain into the order given by this list. For example,
16093 .code
16094 remote_sort_domains = *.cam.ac.uk:*.uk
16095 .endd
16096 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16097 then to those in the &%uk%& domain, then to any others.
16098
16099
16100 .option retry_data_expire main time 7d
16101 .cindex "hints database" "data expiry"
16102 This option sets a &"use before"& time on retry information in Exim's hints
16103 database. Any older retry data is ignored. This means that, for example, once a
16104 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16105 past failures.
16106
16107
16108 .option retry_interval_max main time 24h
16109 .cindex "retry" "limit on interval"
16110 .cindex "limit" "on retry interval"
16111 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16112 intervals between delivery attempts for messages that cannot be delivered
16113 straight away. This option sets an overall limit to the length of time between
16114 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16115 the default value.
16116
16117
16118 .option return_path_remove main boolean true
16119 .cindex "&'Return-path:'& header line" "removing"
16120 RFC 2821, section 4.4, states that an SMTP server must insert a
16121 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16122 The &'Return-path:'& header preserves the sender address as received in the
16123 MAIL command. This description implies that this header should not be present
16124 in an incoming message. If &%return_path_remove%& is true, any existing
16125 &'Return-path:'& headers are removed from messages at the time they are
16126 received. Exim's transports have options for adding &'Return-path:'& headers at
16127 the time of delivery. They are normally used only for final local deliveries.
16128
16129
16130 .option return_size_limit main integer 100K
16131 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16132
16133
16134 .option rfc1413_hosts main "host list&!!" @[]
16135 .cindex "RFC 1413"
16136 .cindex "host" "for RFC 1413 calls"
16137 RFC 1413 identification calls are made to any client host which matches
16138 an item in the list.
16139 The default value specifies just this host, being any local interface
16140 for the system.
16141
16142 .option rfc1413_query_timeout main time 0s
16143 .cindex "RFC 1413" "query timeout"
16144 .cindex "timeout" "for RFC 1413 call"
16145 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16146 no RFC 1413 calls are ever made.
16147
16148
16149 .option sender_unqualified_hosts main "host list&!!" unset
16150 .cindex "unqualified addresses"
16151 .cindex "host" "unqualified addresses from"
16152 This option lists those hosts from which Exim is prepared to accept unqualified
16153 sender addresses. The addresses are made fully qualified by the addition of
16154 &%qualify_domain%&. This option also affects message header lines. Exim does
16155 not reject unqualified addresses in headers that contain sender addresses, but
16156 it qualifies them only if the message came from a host that matches
16157 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16158 using TCP/IP), and the &%-bnq%& option was not set.
16159
16160 .option set_environment main "string list" empty
16161 .cindex "environment"
16162 This option allows to set individual environment variables that the
16163 currently linked libraries and programs in child processes use. The
16164 default list is empty,
16165
16166
16167 .option slow_lookup_log main integer 0
16168 .cindex "logging" "slow lookups"
16169 .cindex "dns" "logging slow lookups"
16170 This option controls logging of slow lookups.
16171 If the value is nonzero it is taken as a number of milliseconds
16172 and lookups taking longer than this are logged.
16173 Currently this applies only to DNS lookups.
16174
16175
16176
16177 .option smtp_accept_keepalive main boolean true
16178 .cindex "keepalive" "on incoming connection"
16179 This option controls the setting of the SO_KEEPALIVE option on incoming
16180 TCP/IP socket connections. When set, it causes the kernel to probe idle
16181 connections periodically, by sending packets with &"old"& sequence numbers. The
16182 other end of the connection should send an acknowledgment if the connection is
16183 still okay or a reset if the connection has been aborted. The reason for doing
16184 this is that it has the beneficial effect of freeing up certain types of
16185 connection that can get stuck when the remote host is disconnected without
16186 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16187 hours to detect unreachable hosts.
16188
16189
16190
16191 .option smtp_accept_max main integer 20
16192 .cindex "limit" "incoming SMTP connections"
16193 .cindex "SMTP" "incoming connection count"
16194 .cindex "inetd"
16195 This option specifies the maximum number of simultaneous incoming SMTP calls
16196 that Exim will accept. It applies only to the listening daemon; there is no
16197 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16198 value is set to zero, no limit is applied. However, it is required to be
16199 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16200 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16201
16202 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16203 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16204 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16205 and &%smtp_load_reserve%& are then checked before accepting the connection.
16206
16207
16208 .option smtp_accept_max_nonmail main integer 10
16209 .cindex "limit" "non-mail SMTP commands"
16210 .cindex "SMTP" "limiting non-mail commands"
16211 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16212 the connection if there are too many. This option defines &"too many"&. The
16213 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16214 client looping sending EHLO, for example. The check is applied only if the
16215 client host matches &%smtp_accept_max_nonmail_hosts%&.
16216
16217 When a new message is expected, one occurrence of RSET is not counted. This
16218 allows a client to send one RSET between messages (this is not necessary,
16219 but some clients do it). Exim also allows one uncounted occurrence of HELO
16220 or EHLO, and one occurrence of STARTTLS between messages. After
16221 starting up a TLS session, another EHLO is expected, and so it too is not
16222 counted. The first occurrence of AUTH in a connection, or immediately
16223 following STARTTLS is not counted. Otherwise, all commands other than
16224 MAIL, RCPT, DATA, and QUIT are counted.
16225
16226
16227 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16228 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16229 check by setting this option. The default value makes it apply to all hosts. By
16230 changing the value, you can exclude any badly-behaved hosts that you have to
16231 live with.
16232
16233
16234 . Allow this long option name to split; give it unsplit as a fifth argument
16235 . for the automatic .oindex that is generated by .option.
16236 . We insert " &~&~" which is both pretty nasty visually and results in
16237 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16238 . zero-width-space, which would be nicer visually and results in (at least)
16239 . html that Firefox will split on when it's forced to reflow (rather than
16240 . inserting a horizontal scrollbar).  However, the text is still not
16241 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16242 . the option name to split.
16243
16244 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16245          smtp_accept_max_per_connection
16246 .cindex "SMTP" "limiting incoming message count"
16247 .cindex "limit" "messages per SMTP connection"
16248 The value of this option limits the number of MAIL commands that Exim is
16249 prepared to accept over a single SMTP connection, whether or not each command
16250 results in the transfer of a message. After the limit is reached, a 421
16251 response is given to subsequent MAIL commands. This limit is a safety
16252 precaution against a client that goes mad (incidents of this type have been
16253 seen).
16254
16255
16256 .option smtp_accept_max_per_host main string&!! unset
16257 .cindex "limit" "SMTP connections from one host"
16258 .cindex "host" "limiting SMTP connections from"
16259 This option restricts the number of simultaneous IP connections from a single
16260 host (strictly, from a single IP address) to the Exim daemon. The option is
16261 expanded, to enable different limits to be applied to different hosts by
16262 reference to &$sender_host_address$&. Once the limit is reached, additional
16263 connection attempts from the same host are rejected with error code 421. This
16264 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16265 of zero imposes no limit. If this option is set greater than zero, it is
16266 required that &%smtp_accept_max%& be non-zero.
16267
16268 &*Warning*&: When setting this option you should not use any expansion
16269 constructions that take an appreciable amount of time. The expansion and test
16270 happen in the main daemon loop, in order to reject additional connections
16271 without forking additional processes (otherwise a denial-of-service attack
16272 could cause a vast number or processes to be created). While the daemon is
16273 doing this processing, it cannot accept any other incoming connections.
16274
16275
16276
16277 .option smtp_accept_queue main integer 0
16278 .cindex "SMTP" "incoming connection count"
16279 .cindex "queueing incoming messages"
16280 .cindex "message" "queueing by SMTP connection count"
16281 If the number of simultaneous incoming SMTP connections being handled via the
16282 listening daemon exceeds this value, messages received by SMTP are just placed
16283 on the queue; no delivery processes are started automatically. The count is
16284 fixed at the start of an SMTP connection. It cannot be updated in the
16285 subprocess that receives messages, and so the queueing or not queueing applies
16286 to all messages received in the same connection.
16287
16288 A value of zero implies no limit, and clearly any non-zero value is useful only
16289 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16290 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16291 various &%-od%&&'x'& command line options.
16292
16293
16294 . See the comment on smtp_accept_max_per_connection
16295
16296 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16297          smtp_accept_queue_per_connection
16298 .cindex "queueing incoming messages"
16299 .cindex "message" "queueing by message count"
16300 This option limits the number of delivery processes that Exim starts
16301 automatically when receiving messages via SMTP, whether via the daemon or by
16302 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16303 and the number of messages received in a single SMTP session exceeds this
16304 number, subsequent messages are placed on the queue, but no delivery processes
16305 are started. This helps to limit the number of Exim processes when a server
16306 restarts after downtime and there is a lot of mail waiting for it on other
16307 systems. On large systems, the default should probably be increased, and on
16308 dial-in client systems it should probably be set to zero (that is, disabled).
16309
16310
16311 .option smtp_accept_reserve main integer 0
16312 .cindex "SMTP" "incoming call count"
16313 .cindex "host" "reserved"
16314 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16315 number of SMTP connections that are reserved for connections from the hosts
16316 that are specified in &%smtp_reserve_hosts%&. The value set in
16317 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16318 restricted to this number of connections; the option specifies a minimum number
16319 of connection slots for them, not a maximum. It is a guarantee that this group
16320 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16321 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16322 individual host.
16323
16324 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16325 set to 5, once there are 45 active connections (from any hosts), new
16326 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16327 provided the other criteria for acceptance are met.
16328
16329
16330 .option smtp_active_hostname main string&!! unset
16331 .cindex "host" "name in SMTP responses"
16332 .cindex "SMTP" "host name in responses"
16333 .vindex "&$primary_hostname$&"
16334 This option is provided for multi-homed servers that want to masquerade as
16335 several different hosts. At the start of an incoming SMTP connection, its value
16336 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16337 responses. For example, it is used as domain name in the response to an
16338 incoming HELO or EHLO command.
16339
16340 .vindex "&$smtp_active_hostname$&"
16341 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16342 is saved with any messages that are received. It is therefore available for use
16343 in routers and transports when the message is later delivered.
16344
16345 If this option is unset, or if its expansion is forced to fail, or if the
16346 expansion results in an empty string, the value of &$primary_hostname$& is
16347 used. Other expansion failures cause a message to be written to the main and
16348 panic logs, and the SMTP command receives a temporary error. Typically, the
16349 value of &%smtp_active_hostname%& depends on the incoming interface address.
16350 For example:
16351 .code
16352 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16353   {cox.mydomain}{box.mydomain}}
16354 .endd
16355
16356 Although &$smtp_active_hostname$& is primarily concerned with incoming
16357 messages, it is also used as the default for HELO commands in callout
16358 verification if there is no remote transport from which to obtain a
16359 &%helo_data%& value.
16360
16361 .option smtp_banner main string&!! "see below"
16362 .cindex "SMTP" "welcome banner"
16363 .cindex "banner for SMTP"
16364 .cindex "welcome banner for SMTP"
16365 .cindex "customizing" "SMTP banner"
16366 This string, which is expanded every time it is used, is output as the initial
16367 positive response to an SMTP connection. The default setting is:
16368 .code
16369 smtp_banner = $smtp_active_hostname ESMTP Exim \
16370   $version_number $tod_full
16371 .endd
16372 Failure to expand the string causes a panic error. If you want to create a
16373 multiline response to the initial SMTP connection, use &"\n"& in the string at
16374 appropriate points, but not at the end. Note that the 220 code is not included
16375 in this string. Exim adds it automatically (several times in the case of a
16376 multiline response).
16377
16378
16379 .option smtp_check_spool_space main boolean true
16380 .cindex "checking disk space"
16381 .cindex "disk space, checking"
16382 .cindex "spool directory" "checking space"
16383 When this option is set, if an incoming SMTP session encounters the SIZE
16384 option on a MAIL command, it checks that there is enough space in the
16385 spool directory's partition to accept a message of that size, while still
16386 leaving free the amount specified by &%check_spool_space%& (even if that value
16387 is zero). If there isn't enough space, a temporary error code is returned.
16388
16389
16390 .option smtp_connect_backlog main integer 20
16391 .cindex "connection backlog"
16392 .cindex "SMTP" "connection backlog"
16393 .cindex "backlog of connections"
16394 This option specifies a maximum number of waiting SMTP connections. Exim passes
16395 this value to the TCP/IP system when it sets up its listener. Once this number
16396 of connections are waiting for the daemon's attention, subsequent connection
16397 attempts are refused at the TCP/IP level. At least, that is what the manuals
16398 say; in some circumstances such connection attempts have been observed to time
16399 out instead. For large systems it is probably a good idea to increase the
16400 value (to 50, say). It also gives some protection against denial-of-service
16401 attacks by SYN flooding.
16402
16403
16404 .option smtp_enforce_sync main boolean true
16405 .cindex "SMTP" "synchronization checking"
16406 .cindex "synchronization checking in SMTP"
16407 The SMTP protocol specification requires the client to wait for a response from
16408 the server at certain points in the dialogue. Without PIPELINING these
16409 synchronization points are after every command; with PIPELINING they are
16410 fewer, but they still exist.
16411
16412 Some spamming sites send out a complete set of SMTP commands without waiting
16413 for any response. Exim protects against this by rejecting a message if the
16414 client has sent further input when it should not have. The error response &"554
16415 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16416 for this error cannot be perfect because of transmission delays (unexpected
16417 input may be on its way but not yet received when Exim checks). However, it
16418 does detect many instances.
16419
16420 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16421 If you want to disable the check selectively (for example, only for certain
16422 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16423 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16424
16425
16426
16427 .option smtp_etrn_command main string&!! unset
16428 .cindex "ETRN" "command to be run"
16429 .vindex "&$domain$&"
16430 If this option is set, the given command is run whenever an SMTP ETRN
16431 command is received from a host that is permitted to issue such commands (see
16432 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16433 are independently expanded. The expansion variable &$domain$& is set to the
16434 argument of the ETRN command, and no syntax checking is done on it. For
16435 example:
16436 .code
16437 smtp_etrn_command = /etc/etrn_command $domain \
16438                     $sender_host_address
16439 .endd
16440 A new process is created to run the command, but Exim does not wait for it to
16441 complete. Consequently, its status cannot be checked. If the command cannot be
16442 run, a line is written to the panic log, but the ETRN caller still receives
16443 a 250 success response. Exim is normally running under its own uid when
16444 receiving SMTP, so it is not possible for it to change the uid before running
16445 the command.
16446
16447
16448 .option smtp_etrn_serialize main boolean true
16449 .cindex "ETRN" "serializing"
16450 When this option is set, it prevents the simultaneous execution of more than
16451 one identical command as a result of ETRN in an SMTP connection. See
16452 section &<<SECTETRN>>& for details.
16453
16454
16455 .option smtp_load_reserve main fixed-point unset
16456 .cindex "load average"
16457 If the system load average ever gets higher than this, incoming SMTP calls are
16458 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16459 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16460 the load is over the limit. The option has no effect on ancient operating
16461 systems on which Exim cannot determine the load average. See also
16462 &%deliver_queue_load_max%& and &%queue_only_load%&.
16463
16464
16465
16466 .option smtp_max_synprot_errors main integer 3
16467 .cindex "SMTP" "limiting syntax and protocol errors"
16468 .cindex "limit" "SMTP syntax and protocol errors"
16469 Exim rejects SMTP commands that contain syntax or protocol errors. In
16470 particular, a syntactically invalid email address, as in this command:
16471 .code
16472 RCPT TO:<abc xyz@a.b.c>
16473 .endd
16474 causes immediate rejection of the command, before any other tests are done.
16475 (The ACL cannot be run if there is no valid address to set up for it.) An
16476 example of a protocol error is receiving RCPT before MAIL. If there are
16477 too many syntax or protocol errors in one SMTP session, the connection is
16478 dropped. The limit is set by this option.
16479
16480 .cindex "PIPELINING" "expected errors"
16481 When the PIPELINING extension to SMTP is in use, some protocol errors are
16482 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16483 Exim assumes that PIPELINING will be used if it advertises it (see
16484 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16485 not count towards the limit.
16486
16487
16488
16489 .option smtp_max_unknown_commands main integer 3
16490 .cindex "SMTP" "limiting unknown commands"
16491 .cindex "limit" "unknown SMTP commands"
16492 If there are too many unrecognized commands in an incoming SMTP session, an
16493 Exim server drops the connection. This is a defence against some kinds of abuse
16494 that subvert web
16495 clients
16496 into making connections to SMTP ports; in these circumstances, a number of
16497 non-SMTP command lines are sent first.
16498
16499
16500
16501 .option smtp_ratelimit_hosts main "host list&!!" unset
16502 .cindex "SMTP" "rate limiting"
16503 .cindex "limit" "rate of message arrival"
16504 .cindex "RCPT" "rate limiting"
16505 Some sites find it helpful to be able to limit the rate at which certain hosts
16506 can send them messages, and the rate at which an individual message can specify
16507 recipients.
16508
16509 Exim has two rate-limiting facilities. This section describes the older
16510 facility, which can limit rates within a single connection. The newer
16511 &%ratelimit%& ACL condition can limit rates across all connections. See section
16512 &<<SECTratelimiting>>& for details of the newer facility.
16513
16514 When a host matches &%smtp_ratelimit_hosts%&, the values of
16515 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16516 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16517 respectively. Each option, if set, must contain a set of four comma-separated
16518 values:
16519
16520 .ilist
16521 A threshold, before which there is no rate limiting.
16522 .next
16523 An initial time delay. Unlike other times in Exim, numbers with decimal
16524 fractional parts are allowed here.
16525 .next
16526 A factor by which to increase the delay each time.
16527 .next
16528 A maximum value for the delay. This should normally be less than 5 minutes,
16529 because after that time, the client is liable to timeout the SMTP command.
16530 .endlist
16531
16532 For example, these settings have been used successfully at the site which
16533 first suggested this feature, for controlling mail from their customers:
16534 .code
16535 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16536 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16537 .endd
16538 The first setting specifies delays that are applied to MAIL commands after
16539 two have been received over a single connection. The initial delay is 0.5
16540 seconds, increasing by a factor of 1.05 each time. The second setting applies
16541 delays to RCPT commands when more than four occur in a single message.
16542
16543
16544 .option smtp_ratelimit_mail main string unset
16545 See &%smtp_ratelimit_hosts%& above.
16546
16547
16548 .option smtp_ratelimit_rcpt main string unset
16549 See &%smtp_ratelimit_hosts%& above.
16550
16551
16552 .option smtp_receive_timeout main time&!! 5m
16553 .cindex "timeout" "for SMTP input"
16554 .cindex "SMTP" "input timeout"
16555 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16556 input, including batch SMTP. If a line of input (either an SMTP command or a
16557 data line) is not received within this time, the SMTP connection is dropped and
16558 the message is abandoned.
16559 A line is written to the log containing one of the following messages:
16560 .code
16561 SMTP command timeout on connection from...
16562 SMTP data timeout on connection from...
16563 .endd
16564 The former means that Exim was expecting to read an SMTP command; the latter
16565 means that it was in the DATA phase, reading the contents of a message.
16566
16567 If the first character of the option is a &"$"& the option is
16568 expanded before use and may depend on
16569 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16570
16571
16572 .oindex "&%-os%&"
16573 The value set by this option can be overridden by the
16574 &%-os%& command-line option. A setting of zero time disables the timeout, but
16575 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16576 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16577 timeout is controlled by &%receive_timeout%& and &%-or%&.
16578
16579
16580 .option smtp_reserve_hosts main "host list&!!" unset
16581 This option defines hosts for which SMTP connections are reserved; see
16582 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16583
16584
16585 .option smtp_return_error_details main boolean false
16586 .cindex "SMTP" "details policy failures"
16587 .cindex "policy control" "rejection, returning details"
16588 In the default state, Exim uses bland messages such as
16589 &"Administrative prohibition"& when it rejects SMTP commands for policy
16590 reasons. Many sysadmins like this because it gives away little information
16591 to spammers. However, some other sysadmins who are applying strict checking
16592 policies want to give out much fuller information about failures. Setting
16593 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16594 example, instead of &"Administrative prohibition"&, it might give:
16595 .code
16596 550-Rejected after DATA: '>' missing at end of address:
16597 550 failing address in "From" header is: <user@dom.ain
16598 .endd
16599
16600
16601 .new
16602 .option smtputf8_advertise_hosts main "host list&!!" *
16603 .cindex "SMTPUTF8" "advertising"
16604 When Exim is built with support for internationalised mail names,
16605 the availability therof is advertised in
16606 response to EHLO only to those client hosts that match this option. See
16607 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16608 .wen
16609
16610
16611 .option spamd_address main string "see below"
16612 This option is available when Exim is compiled with the content-scanning
16613 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16614 The default value is
16615 .code
16616 127.0.0.1 783
16617 .endd
16618 See section &<<SECTscanspamass>>& for more details.
16619
16620
16621
16622 .option split_spool_directory main boolean false
16623 .cindex "multiple spool directories"
16624 .cindex "spool directory" "split"
16625 .cindex "directories, multiple"
16626 If this option is set, it causes Exim to split its input directory into 62
16627 subdirectories, each with a single alphanumeric character as its name. The
16628 sixth character of the message id is used to allocate messages to
16629 subdirectories; this is the least significant base-62 digit of the time of
16630 arrival of the message.
16631
16632 Splitting up the spool in this way may provide better performance on systems
16633 where there are long mail queues, by reducing the number of files in any one
16634 directory. The msglog directory is also split up in a similar way to the input
16635 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16636 are still placed in the single directory &_msglog.OLD_&.
16637
16638 It is not necessary to take any special action for existing messages when
16639 changing &%split_spool_directory%&. Exim notices messages that are in the
16640 &"wrong"& place, and continues to process them. If the option is turned off
16641 after a period of being on, the subdirectories will eventually empty and be
16642 automatically deleted.
16643
16644 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16645 changes. Instead of creating a list of all messages in the queue, and then
16646 trying to deliver each one in turn, it constructs a list of those in one
16647 sub-directory and tries to deliver them, before moving on to the next
16648 sub-directory. The sub-directories are processed in a random order. This
16649 spreads out the scanning of the input directories, and uses less memory. It is
16650 particularly beneficial when there are lots of messages on the queue. However,
16651 if &%queue_run_in_order%& is set, none of this new processing happens. The
16652 entire queue has to be scanned and sorted before any deliveries can start.
16653
16654
16655 .option spool_directory main string&!! "set at compile time"
16656 .cindex "spool directory" "path to"
16657 This defines the directory in which Exim keeps its spool, that is, the messages
16658 it is waiting to deliver. The default value is taken from the compile-time
16659 configuration setting, if there is one. If not, this option must be set. The
16660 string is expanded, so it can contain, for example, a reference to
16661 &$primary_hostname$&.
16662
16663 If the spool directory name is fixed on your installation, it is recommended
16664 that you set it at build time rather than from this option, particularly if the
16665 log files are being written to the spool directory (see &%log_file_path%&).
16666 Otherwise log files cannot be used for errors that are detected early on, such
16667 as failures in the configuration file.
16668
16669 By using this option to override the compiled-in path, it is possible to run
16670 tests of Exim without using the standard spool.
16671
16672 .option sqlite_lock_timeout main time 5s
16673 .cindex "sqlite lookup type" "lock timeout"
16674 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16675 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16676
16677 .option strict_acl_vars main boolean false
16678 .cindex "&ACL;" "variables, handling unset"
16679 This option controls what happens if a syntactically valid but undefined ACL
16680 variable is referenced. If it is false (the default), an empty string
16681 is substituted; if it is true, an error is generated. See section
16682 &<<SECTaclvariables>>& for details of ACL variables.
16683
16684 .option strip_excess_angle_brackets main boolean false
16685 .cindex "angle brackets, excess"
16686 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16687 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16688 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16689 passed on to another MTA, the excess angle brackets are not passed on. If this
16690 option is not set, multiple pairs of angle brackets cause a syntax error.
16691
16692
16693 .option strip_trailing_dot main boolean false
16694 .cindex "trailing dot on domain"
16695 .cindex "dot" "trailing on domain"
16696 If this option is set, a trailing dot at the end of a domain in an address is
16697 ignored. If this is in the envelope and the message is passed on to another
16698 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16699 domain causes a syntax error.
16700 However, addresses in header lines are checked only when an ACL requests header
16701 syntax checking.
16702
16703
16704 .option syslog_duplication main boolean true
16705 .cindex "syslog" "duplicate log lines; suppressing"
16706 When Exim is logging to syslog, it writes the log lines for its three
16707 separate logs at different syslog priorities so that they can in principle
16708 be separated on the logging hosts. Some installations do not require this
16709 separation, and in those cases, the duplication of certain log lines is a
16710 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16711 particular log line is written to syslog. For lines that normally go to
16712 both the main log and the reject log, the reject log version (possibly
16713 containing message header lines) is written, at LOG_NOTICE priority.
16714 Lines that normally go to both the main and the panic log are written at
16715 the LOG_ALERT priority.
16716
16717
16718 .option syslog_facility main string unset
16719 .cindex "syslog" "facility; setting"
16720 This option sets the syslog &"facility"& name, used when Exim is logging to
16721 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16722 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16723 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16724 details of Exim's logging.
16725
16726
16727
16728 .option syslog_processname main string &`exim`&
16729 .cindex "syslog" "process name; setting"
16730 This option sets the syslog &"ident"& name, used when Exim is logging to
16731 syslog. The value must be no longer than 32 characters. See chapter
16732 &<<CHAPlog>>& for details of Exim's logging.
16733
16734
16735
16736 .option syslog_timestamp main boolean true
16737 .cindex "syslog" "timestamps"
16738 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16739 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16740 details of Exim's logging.
16741
16742
16743 .option system_filter main string&!! unset
16744 .cindex "filter" "system filter"
16745 .cindex "system filter" "specifying"
16746 .cindex "Sieve filter" "not available for system filter"
16747 This option specifies an Exim filter file that is applied to all messages at
16748 the start of each delivery attempt, before any routing is done. System filters
16749 must be Exim filters; they cannot be Sieve filters. If the system filter
16750 generates any deliveries to files or pipes, or any new mail messages, the
16751 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16752 which transports are to be used. Details of this facility are given in chapter
16753 &<<CHAPsystemfilter>>&.
16754
16755
16756 .option system_filter_directory_transport main string&!! unset
16757 .vindex "&$address_file$&"
16758 This sets the name of the transport driver that is to be used when the
16759 &%save%& command in a system message filter specifies a path ending in &"/"&,
16760 implying delivery of each message into a separate file in some directory.
16761 During the delivery, the variable &$address_file$& contains the path name.
16762
16763
16764 .option system_filter_file_transport main string&!! unset
16765 .cindex "file" "transport for system filter"
16766 This sets the name of the transport driver that is to be used when the &%save%&
16767 command in a system message filter specifies a path not ending in &"/"&. During
16768 the delivery, the variable &$address_file$& contains the path name.
16769
16770 .option system_filter_group main string unset
16771 .cindex "gid (group id)" "system filter"
16772 This option is used only when &%system_filter_user%& is also set. It sets the
16773 gid under which the system filter is run, overriding any gid that is associated
16774 with the user. The value may be numerical or symbolic.
16775
16776 .option system_filter_pipe_transport main string&!! unset
16777 .cindex "&(pipe)& transport" "for system filter"
16778 .vindex "&$address_pipe$&"
16779 This specifies the transport driver that is to be used when a &%pipe%& command
16780 is used in a system filter. During the delivery, the variable &$address_pipe$&
16781 contains the pipe command.
16782
16783
16784 .option system_filter_reply_transport main string&!! unset
16785 .cindex "&(autoreply)& transport" "for system filter"
16786 This specifies the transport driver that is to be used when a &%mail%& command
16787 is used in a system filter.
16788
16789
16790 .option system_filter_user main string unset
16791 .cindex "uid (user id)" "system filter"
16792 If this option is set to root, the system filter is run in the main Exim
16793 delivery process, as root.  Otherwise, the system filter runs in a separate
16794 process, as the given user, defaulting to the Exim run-time user.
16795 Unless the string consists entirely of digits, it
16796 is looked up in the password data. Failure to find the named user causes a
16797 configuration error. The gid is either taken from the password data, or
16798 specified by &%system_filter_group%&. When the uid is specified numerically,
16799 &%system_filter_group%& is required to be set.
16800
16801 If the system filter generates any pipe, file, or reply deliveries, the uid
16802 under which the filter is run is used when transporting them, unless a
16803 transport option overrides.
16804
16805
16806 .option tcp_nodelay main boolean true
16807 .cindex "daemon" "TCP_NODELAY on sockets"
16808 .cindex "Nagle algorithm"
16809 .cindex "TCP_NODELAY on listening sockets"
16810 If this option is set false, it stops the Exim daemon setting the
16811 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16812 turns off the &"Nagle algorithm"&, which is a way of improving network
16813 performance in interactive (character-by-character) situations. Turning it off
16814 should improve Exim's performance a bit, so that is what happens by default.
16815 However, it appears that some broken clients cannot cope, and time out. Hence
16816 this option. It affects only those sockets that are set up for listening by the
16817 daemon. Sockets created by the smtp transport for delivering mail always set
16818 TCP_NODELAY.
16819
16820
16821 .option timeout_frozen_after main time 0s
16822 .cindex "frozen messages" "timing out"
16823 .cindex "timeout" "frozen messages"
16824 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16825 message of any kind that has been on the queue for longer than the given time
16826 is automatically cancelled at the next queue run. If the frozen message is a
16827 bounce message, it is just discarded; otherwise, a bounce is sent to the
16828 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16829 If you want to timeout frozen bounce messages earlier than other kinds of
16830 frozen message, see &%ignore_bounce_errors_after%&.
16831
16832 &*Note:*& the default value of zero means no timeouts; with this setting,
16833 frozen messages remain on the queue forever (except for any frozen bounce
16834 messages that are released by &%ignore_bounce_errors_after%&).
16835
16836
16837 .option timezone main string unset
16838 .cindex "timezone, setting"
16839 .cindex "environment" "values from"
16840 The value of &%timezone%& is used to set the environment variable TZ while
16841 running Exim (if it is different on entry). This ensures that all timestamps
16842 created by Exim are in the required timezone. If you want all your timestamps
16843 to be in UTC (aka GMT) you should set
16844 .code
16845 timezone = UTC
16846 .endd
16847 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16848 or, if that is not set, from the value of the TZ environment variable when Exim
16849 is built. If &%timezone%& is set to the empty string, either at build or run
16850 time, any existing TZ variable is removed from the environment when Exim
16851 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16852 unfortunately not all, operating systems.
16853
16854
16855 .new
16856 .option tls_advertise_hosts main "host list&!!" *
16857 .wen
16858 .cindex "TLS" "advertising"
16859 .cindex "encryption" "on SMTP connection"
16860 .cindex "SMTP" "encrypted connection"
16861 When Exim is built with support for TLS encrypted connections, the availability
16862 of the STARTTLS command to set up an encrypted session is advertised in
16863 response to EHLO only to those client hosts that match this option. See
16864 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16865 .new
16866 Note that the default value requires that a certificate be supplied
16867 using the &%tls_certificate%& option.  If no certificate is available then
16868 the &%tls_advertise_hosts%& option should be set empty.
16869 .wen
16870
16871
16872 .option tls_certificate main string&!! unset
16873 .cindex "TLS" "server certificate; location of"
16874 .cindex "certificate" "server, location of"
16875 The value of this option is expanded, and must then be the absolute path to a
16876 file which contains the server's certificates. The server's private key is also
16877 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16878 &<<CHAPTLS>>& for further details.
16879
16880 &*Note*&: The certificates defined by this option are used only when Exim is
16881 receiving incoming messages as a server. If you want to supply certificates for
16882 use when sending messages as a client, you must set the &%tls_certificate%&
16883 option in the relevant &(smtp)& transport.
16884
16885 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16886 if the OpenSSL build supports TLS extensions and the TLS client sends the
16887 Server Name Indication extension, then this option and others documented in
16888 &<<SECTtlssni>>& will be re-expanded.
16889
16890 .option tls_crl main string&!! unset
16891 .cindex "TLS" "server certificate revocation list"
16892 .cindex "certificate" "revocation list for server"
16893 This option specifies a certificate revocation list. The expanded value must
16894 be the name of a file that contains a CRL in PEM format.
16895
16896 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16897
16898
16899 .option tls_dh_max_bits main integer 2236
16900 .cindex "TLS" "D-H bit count"
16901 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16902 the chosen TLS library.  That value might prove to be too high for
16903 interoperability.  This option provides a maximum clamp on the value
16904 suggested, trading off security for interoperability.
16905
16906 The value must be at least 1024.
16907
16908 The value 2236 was chosen because, at time of adding the option, it was the
16909 hard-coded maximum value supported by the NSS cryptographic library, as used
16910 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16911
16912 If you prefer more security and are willing to break some clients, raise this
16913 number.
16914
16915 Note that the value passed to GnuTLS for *generating* a new prime may be a
16916 little less than this figure, because GnuTLS is inexact and may produce a
16917 larger prime than requested.
16918
16919
16920 .option tls_dhparam main string&!! unset
16921 .cindex "TLS" "D-H parameters for server"
16922 The value of this option is expanded and indicates the source of DH parameters
16923 to be used by Exim.
16924
16925 If it is a filename starting with a &`/`&, then it names a file from which DH
16926 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16927 PKCS#3 representation of the DH prime.  If the file does not exist, for
16928 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16929 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16930 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16931 and treated as though the &%tls_dhparam%& were set to "none".
16932
16933 If this option expands to the string "none", then no DH parameters will be
16934 loaded by Exim.
16935
16936 If this option expands to the string "historic" and Exim is using GnuTLS, then
16937 Exim will attempt to load a file from inside the spool directory.  If the file
16938 does not exist, Exim will attempt to create it.
16939 See section &<<SECTgnutlsparam>>& for further details.
16940
16941 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16942 a default DH prime; the default is the 2048 bit prime described in section
16943 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16944 in IKE is assigned number 23.
16945
16946 Otherwise, the option must expand to the name used by Exim for any of a number
16947 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16948 "ike" followed by the number used by IKE, of "default" which corresponds to
16949 "ike23".
16950
16951 The available primes are:
16952 &`ike1`&, &`ike2`&, &`ike5`&,
16953 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16954 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16955
16956 Some of these will be too small to be accepted by clients.
16957 Some may be too large to be accepted by clients.
16958
16959 The TLS protocol does not negotiate an acceptable size for this; clients tend
16960 to hard-drop connections if what is offered by the server is unacceptable,
16961 whether too large or too small, and there's no provision for the client to
16962 tell the server what these constraints are.  Thus, as a server operator, you
16963 need to make an educated guess as to what is most likely to work for your
16964 userbase.
16965
16966 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16967 is most likely to maximise interoperability.  The upper bound comes from
16968 applications using the Mozilla Network Security Services (NSS) library, which
16969 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16970 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16971 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16972 acceptable bound from 1024 to 2048.
16973
16974
16975 .option tls_eccurve main string&!! prime256v1
16976 .cindex TLS "EC cryptography"
16977 If built with a recent-enough version of OpenSSL,
16978 this option selects a EC curve for use by Exim.
16979
16980 Curve names of the form &'prime256v1'& are accepted.
16981 For even more-recent library versions, names of the form &'P-512'&
16982 are also accepted, plus the special value &'auto'&
16983 which tells the library to choose.
16984
16985 If the option is set to an empty string, no EC curves will be enabled.
16986
16987
16988 .option tls_ocsp_file main string&!! unset
16989 .cindex TLS "certificate status"
16990 .cindex TLS "OCSP proof file"
16991 This option
16992 must if set expand to the absolute path to a file which contains a current
16993 status proof for the server's certificate, as obtained from the
16994 Certificate Authority.
16995
16996 .new
16997 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16998 .wen
16999
17000
17001 .option tls_on_connect_ports main "string list" unset
17002 .cindex SSMTP
17003 .cindex SMTPS
17004 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17005 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17006 set up without waiting for the client to issue a STARTTLS command. For
17007 further details, see section &<<SECTsupobssmt>>&.
17008
17009
17010
17011 .option tls_privatekey main string&!! unset
17012 .cindex "TLS" "server private key; location of"
17013 The value of this option is expanded, and must then be the absolute path to a
17014 file which contains the server's private key. If this option is unset, or if
17015 the expansion is forced to fail, or the result is an empty string, the private
17016 key is assumed to be in the same file as the server's certificates. See chapter
17017 &<<CHAPTLS>>& for further details.
17018
17019 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17020
17021
17022 .option tls_remember_esmtp main boolean false
17023 .cindex "TLS" "esmtp state; remembering"
17024 .cindex "TLS" "broken clients"
17025 If this option is set true, Exim violates the RFCs by remembering that it is in
17026 &"esmtp"& state after successfully negotiating a TLS session. This provides
17027 support for broken clients that fail to send a new EHLO after starting a
17028 TLS session.
17029
17030
17031 .option tls_require_ciphers main string&!! unset
17032 .cindex "TLS" "requiring specific ciphers"
17033 .cindex "cipher" "requiring specific"
17034 This option controls which ciphers can be used for incoming TLS connections.
17035 The &(smtp)& transport has an option of the same name for controlling outgoing
17036 connections. This option is expanded for each connection, so can be varied for
17037 different clients if required. The value of this option must be a list of
17038 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17039 in somewhat different ways. If GnuTLS is being used, the client controls the
17040 preference order of the available ciphers. Details are given in sections
17041 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17042
17043
17044 .option tls_try_verify_hosts main "host list&!!" unset
17045 .cindex "TLS" "client certificate verification"
17046 .cindex "certificate" "verification of client"
17047 See &%tls_verify_hosts%& below.
17048
17049
17050 .option tls_verify_certificates main string&!! system
17051 .cindex "TLS" "client certificate verification"
17052 .cindex "certificate" "verification of client"
17053 The value of this option is expanded, and must then be either the
17054 word "system"
17055 or the absolute path to
17056 a file or directory containing permitted certificates for clients that
17057 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17058
17059 The "system" value for the option will use a
17060 system default location compiled into the SSL library.
17061 This is not available for GnuTLS versions preceding 3.0.20,
17062 and will be taken as empty; an explicit location
17063 must be specified.
17064
17065 The use of a directory for the option value is not available for GnuTLS versions
17066 preceding 3.3.6 and a single file must be used.
17067
17068 With OpenSSL the certificates specified
17069 explicitly
17070 either by file or directory
17071 are added to those given by the system default location.
17072
17073 These certificates should be for the certificate authorities trusted, rather
17074 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17075 the value is a file then the certificates are sent by Exim as a server to
17076 connecting clients, defining the list of accepted certificate authorities.
17077 Thus the values defined should be considered public data.  To avoid this,
17078 use the explicit directory version.
17079
17080 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17081
17082 A forced expansion failure or setting to an empty string is equivalent to
17083 being unset.
17084
17085
17086 .option tls_verify_hosts main "host list&!!" unset
17087 .cindex "TLS" "client certificate verification"
17088 .cindex "certificate" "verification of client"
17089 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17090 certificates from clients. The expected certificates are defined by
17091 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17092 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17093 &%tls_verify_certificates%& is not set.
17094
17095 Any client that matches &%tls_verify_hosts%& is constrained by
17096 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17097 present one of the listed certificates. If it does not, the connection is
17098 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17099 the host to use TLS. It can still send SMTP commands through unencrypted
17100 connections. Forcing a client to use TLS has to be done separately using an
17101 ACL to reject inappropriate commands when the connection is not encrypted.
17102
17103 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17104 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17105 certificate and checks it against &%tls_verify_certificates%&, but does not
17106 abort the connection if there is no certificate or if it does not match. This
17107 state can be detected in an ACL, which makes it possible to implement policies
17108 such as &"accept for relay only if a verified certificate has been received,
17109 but accept for local delivery if encrypted, even without a verified
17110 certificate"&.
17111
17112 Client hosts that match neither of these lists are not asked to present
17113 certificates.
17114
17115
17116 .option trusted_groups main "string list&!!" unset
17117 .cindex "trusted groups"
17118 .cindex "groups" "trusted"
17119 This option is expanded just once, at the start of Exim's processing. If this
17120 option is set, any process that is running in one of the listed groups, or
17121 which has one of them as a supplementary group, is trusted. The groups can be
17122 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17123 details of what trusted callers are permitted to do. If neither
17124 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17125 are trusted.
17126
17127 .option trusted_users main "string list&!!" unset
17128 .cindex "trusted users"
17129 .cindex "user" "trusted"
17130 This option is expanded just once, at the start of Exim's processing. If this
17131 option is set, any process that is running as one of the listed users is
17132 trusted. The users can be specified numerically or by name. See section
17133 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17134 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17135 Exim user are trusted.
17136
17137 .option unknown_login main string&!! unset
17138 .cindex "uid (user id)" "unknown caller"
17139 .vindex "&$caller_uid$&"
17140 This is a specialized feature for use in unusual configurations. By default, if
17141 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17142 gives up. The &%unknown_login%& option can be used to set a login name to be
17143 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17144 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17145 is used for the user's real name (gecos field), unless this has been set by the
17146 &%-F%& option.
17147
17148 .option unknown_username main string unset
17149 See &%unknown_login%&.
17150
17151 .option untrusted_set_sender main "address list&!!" unset
17152 .cindex "trusted users"
17153 .cindex "sender" "setting by untrusted user"
17154 .cindex "untrusted user setting sender"
17155 .cindex "user" "untrusted setting sender"
17156 .cindex "envelope sender"
17157 When an untrusted user submits a message to Exim using the standard input, Exim
17158 normally creates an envelope sender address from the user's login and the
17159 default qualification domain. Data from the &%-f%& option (for setting envelope
17160 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17161 is used) is ignored.
17162
17163 However, untrusted users are permitted to set an empty envelope sender address,
17164 to declare that a message should never generate any bounces. For example:
17165 .code
17166 exim -f '<>' user@domain.example
17167 .endd
17168 .vindex "&$sender_ident$&"
17169 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17170 other envelope sender addresses in a controlled way. When it is set, untrusted
17171 users are allowed to set envelope sender addresses that match any of the
17172 patterns in the list. Like all address lists, the string is expanded. The
17173 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17174 users to setting senders that start with their login ids
17175 followed by a hyphen
17176 by a setting like this:
17177 .code
17178 untrusted_set_sender = ^$sender_ident-
17179 .endd
17180 If you want to allow untrusted users to set envelope sender addresses without
17181 restriction, you can use
17182 .code
17183 untrusted_set_sender = *
17184 .endd
17185 The &%untrusted_set_sender%& option applies to all forms of local input, but
17186 only to the setting of the envelope sender. It does not permit untrusted users
17187 to use the other options which trusted user can use to override message
17188 parameters. Furthermore, it does not stop Exim from removing an existing
17189 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17190 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17191 overriding these actions. The handling of the &'Sender:'& header is also
17192 described in section &<<SECTthesenhea>>&.
17193
17194 The log line for a message's arrival shows the envelope sender following
17195 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17196 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17197 envelope sender address, the user's login is shown in parentheses after the
17198 sender address.
17199
17200
17201 .option uucp_from_pattern main string "see below"
17202 .cindex "&""From""& line"
17203 .cindex "UUCP" "&""From""& line"
17204 Some applications that pass messages to an MTA via a command line interface use
17205 an initial line starting with &"From&~"& to pass the envelope sender. In
17206 particular, this is used by UUCP software. Exim recognizes such a line by means
17207 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17208 matches, the sender address is constructed by expanding the contents of
17209 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17210 default pattern recognizes lines in the following two forms:
17211 .code
17212 From ph10 Fri Jan  5 12:35 GMT 1996
17213 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17214 .endd
17215 The pattern can be seen by running
17216 .code
17217 exim -bP uucp_from_pattern
17218 .endd
17219 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17220 year in the second case. The first word after &"From&~"& is matched in the
17221 regular expression by a parenthesized subpattern. The default value for
17222 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17223 (&"ph10"& in the example above) as the message's sender. See also
17224 &%ignore_fromline_hosts%&.
17225
17226
17227 .option uucp_from_sender main string&!! &`$1`&
17228 See &%uucp_from_pattern%& above.
17229
17230
17231 .option warn_message_file main string unset
17232 .cindex "warning of delay" "customizing the message"
17233 .cindex "customizing" "warning message"
17234 This option defines a template file containing paragraphs of text to be used
17235 for constructing the warning message which is sent by Exim when a message has
17236 been on the queue for a specified amount of time, as specified by
17237 &%delay_warning%&. Details of the file's contents are given in chapter
17238 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17239
17240
17241 .option write_rejectlog main boolean true
17242 .cindex "reject log" "disabling"
17243 If this option is set false, Exim no longer writes anything to the reject log.
17244 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17245 .ecindex IIDconfima
17246 .ecindex IIDmaiconf
17247
17248
17249
17250
17251 . ////////////////////////////////////////////////////////////////////////////
17252 . ////////////////////////////////////////////////////////////////////////////
17253
17254 .chapter "Generic options for routers" "CHAProutergeneric"
17255 .scindex IIDgenoprou1 "options" "generic; for routers"
17256 .scindex IIDgenoprou2 "generic options" "router"
17257 This chapter describes the generic options that apply to all routers.
17258 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17259
17260 For a general description of how a router operates, see sections
17261 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17262 which the preconditions are tested. The order of expansion of the options that
17263 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17264 &%headers_remove%&, &%transport%&.
17265
17266
17267
17268 .option address_data routers string&!! unset
17269 .cindex "router" "data attached to address"
17270 The string is expanded just before the router is run, that is, after all the
17271 precondition tests have succeeded. If the expansion is forced to fail, the
17272 router declines, the value of &%address_data%& remains unchanged, and the
17273 &%more%& option controls what happens next. Other expansion failures cause
17274 delivery of the address to be deferred.
17275
17276 .vindex "&$address_data$&"
17277 When the expansion succeeds, the value is retained with the address, and can be
17278 accessed using the variable &$address_data$& in the current router, subsequent
17279 routers, and the eventual transport.
17280
17281 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17282 that runs a user's filter file, the contents of &$address_data$& are accessible
17283 in the filter. This is not normally a problem, because such data is usually
17284 either not confidential or it &"belongs"& to the current user, but if you do
17285 put confidential data into &$address_data$& you need to remember this point.
17286
17287 Even if the router declines or passes, the value of &$address_data$& remains
17288 with the address, though it can be changed by another &%address_data%& setting
17289 on a subsequent router. If a router generates child addresses, the value of
17290 &$address_data$& propagates to them. This also applies to the special kind of
17291 &"child"& that is generated by a router with the &%unseen%& option.
17292
17293 The idea of &%address_data%& is that you can use it to look up a lot of data
17294 for the address once, and then pick out parts of the data later. For example,
17295 you could use a single LDAP lookup to return a string of the form
17296 .code
17297 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17298 .endd
17299 In the transport you could pick out the mailbox by a setting such as
17300 .code
17301 file = ${extract{mailbox}{$address_data}}
17302 .endd
17303 This makes the configuration file less messy, and also reduces the number of
17304 lookups (though Exim does cache lookups).
17305
17306 .vindex "&$sender_address_data$&"
17307 .vindex "&$address_data$&"
17308 The &%address_data%& facility is also useful as a means of passing information
17309 from one router to another, and from a router to a transport. In addition, if
17310 &$address_data$& is set by a router when verifying a recipient address from an
17311 ACL, it remains available for use in the rest of the ACL statement. After
17312 verifying a sender, the value is transferred to &$sender_address_data$&.
17313
17314
17315
17316 .option address_test routers&!? boolean true
17317 .oindex "&%-bt%&"
17318 .cindex "router" "skipping when address testing"
17319 If this option is set false, the router is skipped when routing is being tested
17320 by means of the &%-bt%& command line option. This can be a convenience when
17321 your first router sends messages to an external scanner, because it saves you
17322 having to set the &"already scanned"& indicator when testing real address
17323 routing.
17324
17325
17326
17327 .option cannot_route_message routers string&!! unset
17328 .cindex "router" "customizing &""cannot route""& message"
17329 .cindex "customizing" "&""cannot route""& message"
17330 This option specifies a text message that is used when an address cannot be
17331 routed because Exim has run out of routers. The default message is
17332 &"Unrouteable address"&. This option is useful only on routers that have
17333 &%more%& set false, or on the very last router in a configuration, because the
17334 value that is used is taken from the last router that is considered. This
17335 includes a router that is skipped because its preconditions are not met, as
17336 well as a router that declines. For example, using the default configuration,
17337 you could put:
17338 .code
17339 cannot_route_message = Remote domain not found in DNS
17340 .endd
17341 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17342 and
17343 .code
17344 cannot_route_message = Unknown local user
17345 .endd
17346 on the final router that checks for local users. If string expansion fails for
17347 this option, the default message is used. Unless the expansion failure was
17348 explicitly forced, a message about the failure is written to the main and panic
17349 logs, in addition to the normal message about the routing failure.
17350
17351
17352 .option caseful_local_part routers boolean false
17353 .cindex "case of local parts"
17354 .cindex "router" "case of local parts"
17355 By default, routers handle the local parts of addresses in a case-insensitive
17356 manner, though the actual case is preserved for transmission with the message.
17357 If you want the case of letters to be significant in a router, you must set
17358 this option true. For individual router options that contain address or local
17359 part lists (for example, &%local_parts%&), case-sensitive matching can be
17360 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17361 more details.
17362
17363 .vindex "&$local_part$&"
17364 .vindex "&$original_local_part$&"
17365 .vindex "&$parent_local_part$&"
17366 The value of the &$local_part$& variable is forced to lower case while a
17367 router is running unless &%caseful_local_part%& is set. When a router assigns
17368 an address to a transport, the value of &$local_part$& when the transport runs
17369 is the same as it was in the router. Similarly, when a router generates child
17370 addresses by aliasing or forwarding, the values of &$original_local_part$&
17371 and &$parent_local_part$& are those that were used by the redirecting router.
17372
17373 This option applies to the processing of an address by a router. When a
17374 recipient address is being processed in an ACL, there is a separate &%control%&
17375 modifier that can be used to specify case-sensitive processing within the ACL
17376 (see section &<<SECTcontrols>>&).
17377
17378
17379
17380 .option check_local_user routers&!? boolean false
17381 .cindex "local user, checking in router"
17382 .cindex "router" "checking for local user"
17383 .cindex "&_/etc/passwd_&"
17384 .vindex "&$home$&"
17385 When this option is true, Exim checks that the local part of the recipient
17386 address (with affixes removed if relevant) is the name of an account on the
17387 local system. The check is done by calling the &[getpwnam()]& function rather
17388 than trying to read &_/etc/passwd_& directly. This means that other methods of
17389 holding password data (such as NIS) are supported. If the local part is a local
17390 user, &$home$& is set from the password data, and can be tested in other
17391 preconditions that are evaluated after this one (the order of evaluation is
17392 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17393 overridden by &%router_home_directory%&. If the local part is not a local user,
17394 the router is skipped.
17395
17396 If you want to check that the local part is either the name of a local user
17397 or matches something else, you cannot combine &%check_local_user%& with a
17398 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17399 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17400 setting to achieve this. For example:
17401 .code
17402 local_parts = passwd;$local_part : lsearch;/etc/other/users
17403 .endd
17404 Note, however, that the side effects of &%check_local_user%& (such as setting
17405 up a home directory) do not occur when a &(passwd)& lookup is used in a
17406 &%local_parts%& (or any other) precondition.
17407
17408
17409
17410 .option condition routers&!? string&!! unset
17411 .cindex "router" "customized precondition"
17412 This option specifies a general precondition test that has to succeed for the
17413 router to be called. The &%condition%& option is the last precondition to be
17414 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17415 result is a forced failure, or an empty string, or one of the strings &"0"& or
17416 &"no"& or &"false"& (checked without regard to the case of the letters), the
17417 router is skipped, and the address is offered to the next one.
17418
17419 If the result is any other value, the router is run (as this is the last
17420 precondition to be evaluated, all the other preconditions must be true).
17421
17422 This option is unusual in that multiple &%condition%& options may be present.
17423 All &%condition%& options must succeed.
17424
17425 The &%condition%& option provides a means of applying custom conditions to the
17426 running of routers. Note that in the case of a simple conditional expansion,
17427 the default expansion values are exactly what is wanted. For example:
17428 .code
17429 condition = ${if >{$message_age}{600}}
17430 .endd
17431 Because of the default behaviour of the string expansion, this is equivalent to
17432 .code
17433 condition = ${if >{$message_age}{600}{true}{}}
17434 .endd
17435
17436 A multiple condition example, which succeeds:
17437 .code
17438 condition = ${if >{$message_age}{600}}
17439 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17440 condition = foobar
17441 .endd
17442
17443 If the expansion fails (other than forced failure) delivery is deferred. Some
17444 of the other precondition options are common special cases that could in fact
17445 be specified using &%condition%&.
17446
17447 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17448 are far older, and use one set of semantics.  ACLs are newer and when
17449 they were created, the ACL &%condition%& process was given far stricter
17450 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17451 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17452 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17453 Router rules processing behavior.
17454
17455 This is best illustrated in an example:
17456 .code
17457 # If used in an ACL condition will fail with a syntax error, but
17458 # in a router condition any extra characters are treated as a string
17459
17460 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17461 true {yes} {no}}
17462
17463 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17464  {yes} {no}}
17465 .endd
17466 In each example above, the &%if%& statement actually ends after
17467 &"{google.com}}"&.  Since no true or false braces were defined, the
17468 default &%if%& behavior is to return a boolean true or a null answer
17469 (which evaluates to false). The rest of the line is then treated as a
17470 string. So the first example resulted in the boolean answer &"true"&
17471 with the string &" {yes} {no}}"& appended to it. The second example
17472 resulted in the null output (indicating false) with the string
17473 &" {yes} {no}}"& appended to it.
17474
17475 In fact you can put excess forward braces in too.  In the router
17476 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17477 mean something, like after a &"$"& or when required as part of a
17478 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17479 string characters.
17480
17481 Thus, in a Router, the above expansion strings will both always evaluate
17482 true, as the result of expansion is a non-empty string which doesn't
17483 match an explicit false value.  This can be tricky to debug.  By
17484 contrast, in an ACL either of those strings will always result in an
17485 expansion error because the result doesn't look sufficiently boolean.
17486
17487
17488 .option debug_print routers string&!! unset
17489 .cindex "testing" "variables in drivers"
17490 If this option is set and debugging is enabled (see the &%-d%& command line
17491 option) or in address-testing mode (see the &%-bt%& command line option),
17492 the string is expanded and included in the debugging output.
17493 If expansion of the string fails, the error message is written to the debugging
17494 output, and Exim carries on processing.
17495 This option is provided to help with checking out the values of variables and
17496 so on when debugging router configurations. For example, if a &%condition%&
17497 option appears not to be working, &%debug_print%& can be used to output the
17498 variables it references. The output happens after checks for &%domains%&,
17499 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17500 are tested. A newline is added to the text if it does not end with one.
17501 The variable &$router_name$& contains the name of the router.
17502
17503
17504
17505 .option disable_logging routers boolean false
17506 If this option is set true, nothing is logged for any routing errors
17507 or for any deliveries caused by this router. You should not set this option
17508 unless you really, really know what you are doing. See also the generic
17509 transport option of the same name.
17510
17511 .option dnssec_request_domains routers "domain list&!!" unset
17512 .cindex "MX record" "security"
17513 .cindex "DNSSEC" "MX lookup"
17514 .cindex "security" "MX lookup"
17515 .cindex "DNS" "DNSSEC"
17516 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17517 the dnssec request bit set.
17518 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17519
17520 .option dnssec_require_domains routers "domain list&!!" unset
17521 .cindex "MX record" "security"
17522 .cindex "DNSSEC" "MX lookup"
17523 .cindex "security" "MX lookup"
17524 .cindex "DNS" "DNSSEC"
17525 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17526 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17527 (AD bit) set will be ignored and logged as a host-lookup failure.
17528 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17529
17530
17531 .option domains routers&!? "domain list&!!" unset
17532 .cindex "router" "restricting to specific domains"
17533 .vindex "&$domain_data$&"
17534 If this option is set, the router is skipped unless the current domain matches
17535 the list. If the match is achieved by means of a file lookup, the data that the
17536 lookup returned for the domain is placed in &$domain_data$& for use in string
17537 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17538 a list of the order in which preconditions are evaluated.
17539
17540
17541
17542 .option driver routers string unset
17543 This option must always be set. It specifies which of the available routers is
17544 to be used.
17545
17546
17547 .option dsn_lasthop routers boolean false
17548 .cindex "DSN" "success"
17549 .cindex "Delivery Status Notification" "success"
17550 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17551 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17552 instead send a success DSN as if the next hop does not support DSN.
17553 Not effective on redirect routers.
17554
17555
17556
17557 .option errors_to routers string&!! unset
17558 .cindex "envelope sender"
17559 .cindex "router" "changing address for errors"
17560 If a router successfully handles an address, it may assign the address to a
17561 transport for delivery or it may generate child addresses. In both cases, if
17562 there is a delivery problem during later processing, the resulting bounce
17563 message is sent to the address that results from expanding this string,
17564 provided that the address verifies successfully. The &%errors_to%& option is
17565 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17566
17567 The &%errors_to%& setting associated with an address can be overridden if it
17568 subsequently passes through other routers that have their own &%errors_to%&
17569 settings, or if the message is delivered by a transport with a &%return_path%&
17570 setting.
17571
17572 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17573 the expansion fails to verify, the errors address associated with the incoming
17574 address is used. At top level, this is the envelope sender. A non-forced
17575 expansion failure causes delivery to be deferred.
17576
17577 If an address for which &%errors_to%& has been set ends up being delivered over
17578 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17579 any bounces that are generated by other MTAs on the delivery route are also
17580 sent there. You can set &%errors_to%& to the empty string by either of these
17581 settings:
17582 .code
17583 errors_to =
17584 errors_to = ""
17585 .endd
17586 An expansion item that yields an empty string has the same effect. If you do
17587 this, a locally detected delivery error for addresses processed by this router
17588 no longer gives rise to a bounce message; the error is discarded. If the
17589 address is delivered to a remote host, the return path is set to &`<>`&, unless
17590 overridden by the &%return_path%& option on the transport.
17591
17592 .vindex "&$address_data$&"
17593 If for some reason you want to discard local errors, but use a non-empty
17594 MAIL command for remote delivery, you can preserve the original return
17595 path in &$address_data$& in the router, and reinstate it in the transport by
17596 setting &%return_path%&.
17597
17598 The most common use of &%errors_to%& is to direct mailing list bounces to the
17599 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17600 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17601
17602
17603
17604 .option expn routers&!? boolean true
17605 .cindex "address" "testing"
17606 .cindex "testing" "addresses"
17607 .cindex "EXPN" "router skipping"
17608 .cindex "router" "skipping for EXPN"
17609 If this option is turned off, the router is skipped when testing an address
17610 as a result of processing an SMTP EXPN command. You might, for example,
17611 want to turn it off on a router for users' &_.forward_& files, while leaving it
17612 on for the system alias file.
17613 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17614 are evaluated.
17615
17616 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17617 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17618 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17619
17620
17621
17622 .option fail_verify routers boolean false
17623 .cindex "router" "forcing verification failure"
17624 Setting this option has the effect of setting both &%fail_verify_sender%& and
17625 &%fail_verify_recipient%& to the same value.
17626
17627
17628
17629 .option fail_verify_recipient routers boolean false
17630 If this option is true and an address is accepted by this router when
17631 verifying a recipient, verification fails.
17632
17633
17634
17635 .option fail_verify_sender routers boolean false
17636 If this option is true and an address is accepted by this router when
17637 verifying a sender, verification fails.
17638
17639
17640
17641 .option fallback_hosts routers "string list" unset
17642 .cindex "router" "fallback hosts"
17643 .cindex "fallback" "hosts specified on router"
17644 String expansion is not applied to this option. The argument must be a
17645 colon-separated list of host names or IP addresses. The list separator can be
17646 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17647 each name or address. In fact, the format of each item is exactly the same as
17648 defined for the list of hosts in a &(manualroute)& router (see section
17649 &<<SECTformatonehostitem>>&).
17650
17651 If a router queues an address for a remote transport, this host list is
17652 associated with the address, and used instead of the transport's fallback host
17653 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17654 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17655 transport for further details.
17656
17657
17658 .option group routers string&!! "see below"
17659 .cindex "gid (group id)" "local delivery"
17660 .cindex "local transports" "uid and gid"
17661 .cindex "transport" "local"
17662 .cindex "router" "setting group"
17663 When a router queues an address for a transport, and the transport does not
17664 specify a group, the group given here is used when running the delivery
17665 process.
17666 The group may be specified numerically or by name. If expansion fails, the
17667 error is logged and delivery is deferred.
17668 The default is unset, unless &%check_local_user%& is set, when the default
17669 is taken from the password information. See also &%initgroups%& and &%user%&
17670 and the discussion in chapter &<<CHAPenvironment>>&.
17671
17672
17673
17674 .option headers_add routers list&!! unset
17675 .cindex "header lines" "adding"
17676 .cindex "router" "adding header lines"
17677 This option specifies a list of text headers,
17678 newline-separated (by default, changeable in the usual way),
17679 that is associated with any addresses that are accepted by the router.
17680 Each item is separately expanded, at routing time.  However, this
17681 option has no effect when an address is just being verified. The way in which
17682 the text is used to add header lines at transport time is described in section
17683 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17684 message is in the process of being transported. This means that references to
17685 header lines in string expansions in the transport's configuration do not
17686 &"see"& the added header lines.
17687
17688 The &%headers_add%& option is expanded after &%errors_to%&, but before
17689 &%headers_remove%& and &%transport%&. If an item is empty, or if
17690 an item expansion is forced to fail, the item has no effect. Other expansion
17691 failures are treated as configuration errors.
17692
17693 Unlike most options, &%headers_add%& can be specified multiple times
17694 for a router; all listed headers are added.
17695
17696 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17697 router that has the &%one_time%& option set.
17698
17699 .cindex "duplicate addresses"
17700 .oindex "&%unseen%&"
17701 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17702 additions are deleted when the address is passed on to subsequent routers.
17703 For a &%redirect%& router, if a generated address is the same as the incoming
17704 address, this can lead to duplicate addresses with different header
17705 modifications. Exim does not do duplicate deliveries (except, in certain
17706 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17707 which of the duplicates is discarded, so this ambiguous situation should be
17708 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17709
17710
17711
17712 .option headers_remove routers list&!! unset
17713 .cindex "header lines" "removing"
17714 .cindex "router" "removing header lines"
17715 This option specifies a list of text headers,
17716 colon-separated (by default, changeable in the usual way),
17717 that is associated with any addresses that are accepted by the router.
17718 Each item is separately expanded, at routing time.  However, this
17719 option has no effect when an address is just being verified. The way in which
17720 the text is used to remove header lines at transport time is described in
17721 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17722 the message is in the process of being transported. This means that references
17723 to header lines in string expansions in the transport's configuration still
17724 &"see"& the original header lines.
17725
17726 The &%headers_remove%& option is expanded after &%errors_to%& and
17727 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17728 the item has no effect. Other expansion failures are treated as configuration
17729 errors.
17730
17731 Unlike most options, &%headers_remove%& can be specified multiple times
17732 for a router; all listed headers are removed.
17733
17734 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17735 router that has the &%one_time%& option set.
17736
17737 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17738 removal requests are deleted when the address is passed on to subsequent
17739 routers, and this can lead to problems with duplicates -- see the similar
17740 warning for &%headers_add%& above.
17741
17742 &*Warning 3*&: Because of the separate expansion of the list items,
17743 items that contain a list separator must have it doubled.
17744 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17745
17746
17747
17748 .option ignore_target_hosts routers "host list&!!" unset
17749 .cindex "IP address" "discarding"
17750 .cindex "router" "discarding IP addresses"
17751 Although this option is a host list, it should normally contain IP address
17752 entries rather than names. If any host that is looked up by the router has an
17753 IP address that matches an item in this list, Exim behaves as if that IP
17754 address did not exist. This option allows you to cope with rogue DNS entries
17755 like
17756 .code
17757 remote.domain.example.  A  127.0.0.1
17758 .endd
17759 by setting
17760 .code
17761 ignore_target_hosts = 127.0.0.1
17762 .endd
17763 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17764 discarded in this way, the router declines. In a conventional configuration, an
17765 attempt to mail to such a domain would normally provoke the &"unrouteable
17766 domain"& error, and an attempt to verify an address in the domain would fail.
17767 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17768 router declines if presented with one of the listed addresses.
17769
17770 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17771 means of the first or the second of the following settings, respectively:
17772 .code
17773 ignore_target_hosts = 0.0.0.0/0
17774 ignore_target_hosts = <; 0::0/0
17775 .endd
17776 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17777 in the second line matches all IPv6 addresses.
17778
17779 This option may also be useful for ignoring link-local and site-local IPv6
17780 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17781 is expanded before use as a list, it is possible to make it dependent on the
17782 domain that is being routed.
17783
17784 .vindex "&$host_address$&"
17785 During its expansion, &$host_address$& is set to the IP address that is being
17786 checked.
17787
17788 .option initgroups routers boolean false
17789 .cindex "additional groups"
17790 .cindex "groups" "additional"
17791 .cindex "local transports" "uid and gid"
17792 .cindex "transport" "local"
17793 If the router queues an address for a transport, and this option is true, and
17794 the uid supplied by the router is not overridden by the transport, the
17795 &[initgroups()]& function is called when running the transport to ensure that
17796 any additional groups associated with the uid are set up. See also &%group%&
17797 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17798
17799
17800
17801 .option local_part_prefix routers&!? "string list" unset
17802 .cindex "router" "prefix for local part"
17803 .cindex "prefix" "for local part, used in router"
17804 If this option is set, the router is skipped unless the local part starts with
17805 one of the given strings, or &%local_part_prefix_optional%& is true. See
17806 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17807 evaluated.
17808
17809 The list is scanned from left to right, and the first prefix that matches is
17810 used. A limited form of wildcard is available; if the prefix begins with an
17811 asterisk, it matches the longest possible sequence of arbitrary characters at
17812 the start of the local part. An asterisk should therefore always be followed by
17813 some character that does not occur in normal local parts.
17814 .cindex "multiple mailboxes"
17815 .cindex "mailbox" "multiple"
17816 Wildcarding can be used to set up multiple user mailboxes, as described in
17817 section &<<SECTmulbox>>&.
17818
17819 .vindex "&$local_part$&"
17820 .vindex "&$local_part_prefix$&"
17821 During the testing of the &%local_parts%& option, and while the router is
17822 running, the prefix is removed from the local part, and is available in the
17823 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17824 the router accepts the address, this remains true during subsequent delivery by
17825 a transport. In particular, the local part that is transmitted in the RCPT
17826 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17827 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17828 the relevant transport.
17829
17830 When an address is being verified, &%local_part_prefix%& affects only the
17831 behaviour of the router. If the callout feature of verification is in use, this
17832 means that the full address, including the prefix, will be used during the
17833 callout.
17834
17835 The prefix facility is commonly used to handle local parts of the form
17836 &%owner-something%&. Another common use is to support local parts of the form
17837 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17838 to tell a user their forwarding is broken &-- by placing a router like this one
17839 immediately before the router that handles &_.forward_& files:
17840 .code
17841 real_localuser:
17842   driver = accept
17843   local_part_prefix = real-
17844   check_local_user
17845   transport = local_delivery
17846 .endd
17847 For security, it would probably be a good idea to restrict the use of this
17848 router to locally-generated messages, using a condition such as this:
17849 .code
17850   condition = ${if match {$sender_host_address}\
17851                          {\N^(|127\.0\.0\.1)$\N}}
17852 .endd
17853
17854 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17855 both conditions must be met if not optional. Care must be taken if wildcards
17856 are used in both a prefix and a suffix on the same router. Different
17857 separator characters must be used to avoid ambiguity.
17858
17859
17860 .option local_part_prefix_optional routers boolean false
17861 See &%local_part_prefix%& above.
17862
17863
17864
17865 .option local_part_suffix routers&!? "string list" unset
17866 .cindex "router" "suffix for local part"
17867 .cindex "suffix for local part" "used in router"
17868 This option operates in the same way as &%local_part_prefix%&, except that the
17869 local part must end (rather than start) with the given string, the
17870 &%local_part_suffix_optional%& option determines whether the suffix is
17871 mandatory, and the wildcard * character, if present, must be the last
17872 character of the suffix. This option facility is commonly used to handle local
17873 parts of the form &%something-request%& and multiple user mailboxes of the form
17874 &%username-foo%&.
17875
17876
17877 .option local_part_suffix_optional routers boolean false
17878 See &%local_part_suffix%& above.
17879
17880
17881
17882 .option local_parts routers&!? "local part list&!!" unset
17883 .cindex "router" "restricting to specific local parts"
17884 .cindex "local part" "checking in router"
17885 The router is run only if the local part of the address matches the list.
17886 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17887 are evaluated, and
17888 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17889 string is expanded, it is possible to make it depend on the domain, for
17890 example:
17891 .code
17892 local_parts = dbm;/usr/local/specials/$domain
17893 .endd
17894 .vindex "&$local_part_data$&"
17895 If the match is achieved by a lookup, the data that the lookup returned
17896 for the local part is placed in the variable &$local_part_data$& for use in
17897 expansions of the router's private options. You might use this option, for
17898 example, if you have a large number of local virtual domains, and you want to
17899 send all postmaster mail to the same place without having to set up an alias in
17900 each virtual domain:
17901 .code
17902 postmaster:
17903   driver = redirect
17904   local_parts = postmaster
17905   data = postmaster@real.domain.example
17906 .endd
17907
17908
17909 .option log_as_local routers boolean "see below"
17910 .cindex "log" "delivery line"
17911 .cindex "delivery" "log line format"
17912 Exim has two logging styles for delivery, the idea being to make local
17913 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17914 recipient address is given just as the local part, without a domain. The use of
17915 this style is controlled by this option. It defaults to true for the &(accept)&
17916 router, and false for all the others. This option applies only when a
17917 router assigns an address to a transport. It has no effect on routers that
17918 redirect addresses.
17919
17920
17921
17922 .option more routers boolean&!! true
17923 The result of string expansion for this option must be a valid boolean value,
17924 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17925 result causes an error, and delivery is deferred. If the expansion is forced to
17926 fail, the default value for the option (true) is used. Other failures cause
17927 delivery to be deferred.
17928
17929 If this option is set false, and the router declines to handle the address, no
17930 further routers are tried, routing fails, and the address is bounced.
17931 .oindex "&%self%&"
17932 However, if the router explicitly passes an address to the following router by
17933 means of the setting
17934 .code
17935 self = pass
17936 .endd
17937 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17938 does not affect the behaviour if one of the precondition tests fails. In that
17939 case, the address is always passed to the next router.
17940
17941 Note that &%address_data%& is not considered to be a precondition. If its
17942 expansion is forced to fail, the router declines, and the value of &%more%&
17943 controls what happens next.
17944
17945
17946 .option pass_on_timeout routers boolean false
17947 .cindex "timeout" "of router"
17948 .cindex "router" "timeout"
17949 If a router times out during a host lookup, it normally causes deferral of the
17950 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17951 router, overriding &%no_more%&. This may be helpful for systems that are
17952 intermittently connected to the Internet, or those that want to pass to a smart
17953 host any messages that cannot immediately be delivered.
17954
17955 There are occasional other temporary errors that can occur while doing DNS
17956 lookups. They are treated in the same way as a timeout, and this option
17957 applies to all of them.
17958
17959
17960
17961 .option pass_router routers string unset
17962 .cindex "router" "go to after &""pass""&"
17963 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17964 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17965 routing to continue, and overriding a false setting of &%more%&. When one of
17966 these routers returns &"pass"&, the address is normally handed on to the next
17967 router in sequence. This can be changed by setting &%pass_router%& to the name
17968 of another router. However (unlike &%redirect_router%&) the named router must
17969 be below the current router, to avoid loops. Note that this option applies only
17970 to the special case of &"pass"&. It does not apply when a router returns
17971 &"decline"& because it cannot handle an address.
17972
17973
17974
17975 .option redirect_router routers string unset
17976 .cindex "router" "start at after redirection"
17977 Sometimes an administrator knows that it is pointless to reprocess addresses
17978 generated from alias or forward files with the same router again. For
17979 example, if an alias file translates real names into login ids there is no
17980 point searching the alias file a second time, especially if it is a large file.
17981
17982 The &%redirect_router%& option can be set to the name of any router instance.
17983 It causes the routing of any generated addresses to start at the named router
17984 instead of at the first router. This option has no effect if the router in
17985 which it is set does not generate new addresses.
17986
17987
17988
17989 .option require_files routers&!? "string list&!!" unset
17990 .cindex "file" "requiring for router"
17991 .cindex "router" "requiring file existence"
17992 This option provides a general mechanism for predicating the running of a
17993 router on the existence or non-existence of certain files or directories.
17994 Before running a router, as one of its precondition tests, Exim works its way
17995 through the &%require_files%& list, expanding each item separately.
17996
17997 Because the list is split before expansion, any colons in expansion items must
17998 be doubled, or the facility for using a different list separator must be used.
17999 If any expansion is forced to fail, the item is ignored. Other expansion
18000 failures cause routing of the address to be deferred.
18001
18002 If any expanded string is empty, it is ignored. Otherwise, except as described
18003 below, each string must be a fully qualified file path, optionally preceded by
18004 &"!"&. The paths are passed to the &[stat()]& function to test for the
18005 existence of the files or directories. The router is skipped if any paths not
18006 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18007
18008 .cindex "NFS"
18009 If &[stat()]& cannot determine whether a file exists or not, delivery of
18010 the message is deferred. This can happen when NFS-mounted filesystems are
18011 unavailable.
18012
18013 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18014 options, so you cannot use it to check for the existence of a file in which to
18015 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18016 full list of the order in which preconditions are evaluated.) However, as
18017 these options are all expanded, you can use the &%exists%& expansion condition
18018 to make such tests. The &%require_files%& option is intended for checking files
18019 that the router may be going to use internally, or which are needed by a
18020 transport (for example &_.procmailrc_&).
18021
18022 During delivery, the &[stat()]& function is run as root, but there is a
18023 facility for some checking of the accessibility of a file by another user.
18024 This is not a proper permissions check, but just a &"rough"& check that
18025 operates as follows:
18026
18027 If an item in a &%require_files%& list does not contain any forward slash
18028 characters, it is taken to be the user (and optional group, separated by a
18029 comma) to be checked for subsequent files in the list. If no group is specified
18030 but the user is specified symbolically, the gid associated with the uid is
18031 used. For example:
18032 .code
18033 require_files = mail:/some/file
18034 require_files = $local_part:$home/.procmailrc
18035 .endd
18036 If a user or group name in a &%require_files%& list does not exist, the
18037 &%require_files%& condition fails.
18038
18039 Exim performs the check by scanning along the components of the file path, and
18040 checking the access for the given uid and gid. It checks for &"x"& access on
18041 directories, and &"r"& access on the final file. Note that this means that file
18042 access control lists, if the operating system has them, are ignored.
18043
18044 &*Warning 1*&: When the router is being run to verify addresses for an
18045 incoming SMTP message, Exim is not running as root, but under its own uid. This
18046 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18047 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18048 user is not permitted to read one of the directories on the file's path.
18049
18050 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18051 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18052 without root access. In this case, if a check for access by a particular user
18053 is requested, Exim creates a subprocess that runs as that user, and tries the
18054 check again in that process.
18055
18056 The default action for handling an unresolved EACCES is to consider it to
18057 be caused by a configuration error, and routing is deferred because the
18058 existence or non-existence of the file cannot be determined. However, in some
18059 circumstances it may be desirable to treat this condition as if the file did
18060 not exist. If the file name (or the exclamation mark that precedes the file
18061 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18062 as if the file did not exist. For example:
18063 .code
18064 require_files = +/some/file
18065 .endd
18066 If the router is not an essential part of verification (for example, it
18067 handles users' &_.forward_& files), another solution is to set the &%verify%&
18068 option false so that the router is skipped when verifying.
18069
18070
18071
18072 .option retry_use_local_part routers boolean "see below"
18073 .cindex "hints database" "retry keys"
18074 .cindex "local part" "in retry keys"
18075 When a delivery suffers a temporary routing failure, a retry record is created
18076 in Exim's hints database. For addresses whose routing depends only on the
18077 domain, the key for the retry record should not involve the local part, but for
18078 other addresses, both the domain and the local part should be included.
18079 Usually, remote routing is of the former kind, and local routing is of the
18080 latter kind.
18081
18082 This option controls whether the local part is used to form the key for retry
18083 hints for addresses that suffer temporary errors while being handled by this
18084 router. The default value is true for any router that has &%check_local_user%&
18085 set, and false otherwise. Note that this option does not apply to hints keys
18086 for transport delays; they are controlled by a generic transport option of the
18087 same name.
18088
18089 The setting of &%retry_use_local_part%& applies only to the router on which it
18090 appears. If the router generates child addresses, they are routed
18091 independently; this setting does not become attached to them.
18092
18093
18094
18095 .option router_home_directory routers string&!! unset
18096 .cindex "router" "home directory for"
18097 .cindex "home directory" "for router"
18098 .vindex "&$home$&"
18099 This option sets a home directory for use while the router is running. (Compare
18100 &%transport_home_directory%&, which sets a home directory for later
18101 transporting.) In particular, if used on a &(redirect)& router, this option
18102 sets a value for &$home$& while a filter is running. The value is expanded;
18103 forced expansion failure causes the option to be ignored &-- other failures
18104 cause the router to defer.
18105
18106 Expansion of &%router_home_directory%& happens immediately after the
18107 &%check_local_user%& test (if configured), before any further expansions take
18108 place.
18109 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18110 are evaluated.)
18111 While the router is running, &%router_home_directory%& overrides the value of
18112 &$home$& that came from &%check_local_user%&.
18113
18114 When a router accepts an address and assigns it to a local transport (including
18115 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18116 delivery), the home directory setting for the transport is taken from the first
18117 of these values that is set:
18118
18119 .ilist
18120 The &%home_directory%& option on the transport;
18121 .next
18122 The &%transport_home_directory%& option on the router;
18123 .next
18124 The password data if &%check_local_user%& is set on the router;
18125 .next
18126 The &%router_home_directory%& option on the router.
18127 .endlist
18128
18129 In other words, &%router_home_directory%& overrides the password data for the
18130 router, but not for the transport.
18131
18132
18133
18134 .option self routers string freeze
18135 .cindex "MX record" "pointing to local host"
18136 .cindex "local host" "MX pointing to"
18137 This option applies to those routers that use a recipient address to find a
18138 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18139 and &(manualroute)& routers.
18140 Certain configurations of the &(queryprogram)& router can also specify a list
18141 of remote hosts.
18142 Usually such routers are configured to send the message to a remote host via an
18143 &(smtp)& transport. The &%self%& option specifies what happens when the first
18144 host on the list turns out to be the local host.
18145 The way in which Exim checks for the local host is described in section
18146 &<<SECTreclocipadd>>&.
18147
18148 Normally this situation indicates either an error in Exim's configuration (for
18149 example, the router should be configured not to process this domain), or an
18150 error in the DNS (for example, the MX should not point to this host). For this
18151 reason, the default action is to log the incident, defer the address, and
18152 freeze the message. The following alternatives are provided for use in special
18153 cases:
18154
18155 .vlist
18156 .vitem &%defer%&
18157 Delivery of the message is tried again later, but the message is not frozen.
18158
18159 .vitem "&%reroute%&: <&'domain'&>"
18160 The domain is changed to the given domain, and the address is passed back to
18161 be reprocessed by the routers. No rewriting of headers takes place. This
18162 behaviour is essentially a redirection.
18163
18164 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18165 The domain is changed to the given domain, and the address is passed back to be
18166 reprocessed by the routers. Any headers that contain the original domain are
18167 rewritten.
18168
18169 .vitem &%pass%&
18170 .oindex "&%more%&"
18171 .vindex "&$self_hostname$&"
18172 The router passes the address to the next router, or to the router named in the
18173 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18174 subsequent routing and delivery, the variable &$self_hostname$& contains the
18175 name of the local host that the router encountered. This can be used to
18176 distinguish between different cases for hosts with multiple names. The
18177 combination
18178 .code
18179 self = pass
18180 no_more
18181 .endd
18182 ensures that only those addresses that routed to the local host are passed on.
18183 Without &%no_more%&, addresses that were declined for other reasons would also
18184 be passed to the next router.
18185
18186 .vitem &%fail%&
18187 Delivery fails and an error report is generated.
18188
18189 .vitem &%send%&
18190 .cindex "local host" "sending to"
18191 The anomaly is ignored and the address is queued for the transport. This
18192 setting should be used with extreme caution. For an &(smtp)& transport, it
18193 makes sense only in cases where the program that is listening on the SMTP port
18194 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18195 different configuration file that handles the domain in another way.
18196 .endlist
18197
18198
18199
18200 .option senders routers&!? "address list&!!" unset
18201 .cindex "router" "checking senders"
18202 If this option is set, the router is skipped unless the message's sender
18203 address matches something on the list.
18204 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18205 are evaluated.
18206
18207 There are issues concerning verification when the running of routers is
18208 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18209 setting, it sets the sender to the null string. When using the &%-bt%& option
18210 to check a configuration file, it is necessary also to use the &%-f%& option to
18211 set an appropriate sender. For incoming mail, the sender is unset when
18212 verifying the sender, but is available when verifying any recipients. If the
18213 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18214 matters.
18215
18216
18217 .option translate_ip_address routers string&!! unset
18218 .cindex "IP address" "translating"
18219 .cindex "packet radio"
18220 .cindex "router" "IP address translation"
18221 There exist some rare networking situations (for example, packet radio) where
18222 it is helpful to be able to translate IP addresses generated by normal routing
18223 mechanisms into other IP addresses, thus performing a kind of manual IP
18224 routing. This should be done only if the normal IP routing of the TCP/IP stack
18225 is inadequate or broken. Because this is an extremely uncommon requirement, the
18226 code to support this option is not included in the Exim binary unless
18227 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18228
18229 .vindex "&$host_address$&"
18230 The &%translate_ip_address%& string is expanded for every IP address generated
18231 by the router, with the generated address set in &$host_address$&. If the
18232 expansion is forced to fail, no action is taken.
18233 For any other expansion error, delivery of the message is deferred.
18234 If the result of the expansion is an IP address, that replaces the original
18235 address; otherwise the result is assumed to be a host name &-- this is looked
18236 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18237 produce one or more replacement IP addresses. For example, to subvert all IP
18238 addresses in some specific networks, this could be added to a router:
18239 .code
18240 translate_ip_address = \
18241   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18242     {$value}fail}}
18243 .endd
18244 The file would contain lines like
18245 .code
18246 10.2.3.128/26    some.host
18247 10.8.4.34/26     10.44.8.15
18248 .endd
18249 You should not make use of this facility unless you really understand what you
18250 are doing.
18251
18252
18253
18254 .option transport routers string&!! unset
18255 This option specifies the transport to be used when a router accepts an address
18256 and sets it up for delivery. A transport is never needed if a router is used
18257 only for verification. The value of the option is expanded at routing time,
18258 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18259 and result must be the name of one of the configured transports. If it is not,
18260 delivery is deferred.
18261
18262 The &%transport%& option is not used by the &(redirect)& router, but it does
18263 have some private options that set up transports for pipe and file deliveries
18264 (see chapter &<<CHAPredirect>>&).
18265
18266
18267
18268 .option transport_current_directory routers string&!! unset
18269 .cindex "current directory for local transport"
18270 This option associates a current directory with any address that is routed
18271 to a local transport. This can happen either because a transport is
18272 explicitly configured for the router, or because it generates a delivery to a
18273 file or a pipe. During the delivery process (that is, at transport time), this
18274 option string is expanded and is set as the current directory, unless
18275 overridden by a setting on the transport.
18276 If the expansion fails for any reason, including forced failure, an error is
18277 logged, and delivery is deferred.
18278 See chapter &<<CHAPenvironment>>& for details of the local delivery
18279 environment.
18280
18281
18282
18283
18284 .option transport_home_directory routers string&!! "see below"
18285 .cindex "home directory" "for local transport"
18286 This option associates a home directory with any address that is routed to a
18287 local transport. This can happen either because a transport is explicitly
18288 configured for the router, or because it generates a delivery to a file or a
18289 pipe. During the delivery process (that is, at transport time), the option
18290 string is expanded and is set as the home directory, unless overridden by a
18291 setting of &%home_directory%& on the transport.
18292 If the expansion fails for any reason, including forced failure, an error is
18293 logged, and delivery is deferred.
18294
18295 If the transport does not specify a home directory, and
18296 &%transport_home_directory%& is not set for the router, the home directory for
18297 the transport is taken from the password data if &%check_local_user%& is set for
18298 the router. Otherwise it is taken from &%router_home_directory%& if that option
18299 is set; if not, no home directory is set for the transport.
18300
18301 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18302 environment.
18303
18304
18305
18306
18307 .option unseen routers boolean&!! false
18308 .cindex "router" "carrying on after success"
18309 The result of string expansion for this option must be a valid boolean value,
18310 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18311 result causes an error, and delivery is deferred. If the expansion is forced to
18312 fail, the default value for the option (false) is used. Other failures cause
18313 delivery to be deferred.
18314
18315 When this option is set true, routing does not cease if the router accepts the
18316 address. Instead, a copy of the incoming address is passed to the next router,
18317 overriding a false setting of &%more%&. There is little point in setting
18318 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18319 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18320 sometimes true and sometimes false).
18321
18322 .cindex "copy of message (&%unseen%& option)"
18323 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18324 qualifier in filter files. It can be used to cause copies of messages to be
18325 delivered to some other destination, while also carrying out a normal delivery.
18326 In effect, the current address is made into a &"parent"& that has two children
18327 &-- one that is delivered as specified by this router, and a clone that goes on
18328 to be routed further. For this reason, &%unseen%& may not be combined with the
18329 &%one_time%& option in a &(redirect)& router.
18330
18331 &*Warning*&: Header lines added to the address (or specified for removal) by
18332 this router or by previous routers affect the &"unseen"& copy of the message
18333 only. The clone that continues to be processed by further routers starts with
18334 no added headers and none specified for removal. For a &%redirect%& router, if
18335 a generated address is the same as the incoming address, this can lead to
18336 duplicate addresses with different header modifications. Exim does not do
18337 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18338 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18339 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18340 &%redirect%& router may be of help.
18341
18342 Unlike the handling of header modifications, any data that was set by the
18343 &%address_data%& option in the current or previous routers &'is'& passed on to
18344 subsequent routers.
18345
18346
18347 .option user routers string&!! "see below"
18348 .cindex "uid (user id)" "local delivery"
18349 .cindex "local transports" "uid and gid"
18350 .cindex "transport" "local"
18351 .cindex "router" "user for filter processing"
18352 .cindex "filter" "user for processing"
18353 When a router queues an address for a transport, and the transport does not
18354 specify a user, the user given here is used when running the delivery process.
18355 The user may be specified numerically or by name. If expansion fails, the
18356 error is logged and delivery is deferred.
18357 This user is also used by the &(redirect)& router when running a filter file.
18358 The default is unset, except when &%check_local_user%& is set. In this case,
18359 the default is taken from the password information. If the user is specified as
18360 a name, and &%group%& is not set, the group associated with the user is used.
18361 See also &%initgroups%& and &%group%& and the discussion in chapter
18362 &<<CHAPenvironment>>&.
18363
18364
18365
18366 .option verify routers&!? boolean true
18367 Setting this option has the effect of setting &%verify_sender%& and
18368 &%verify_recipient%& to the same value.
18369
18370
18371 .option verify_only routers&!? boolean false
18372 .cindex "EXPN" "with &%verify_only%&"
18373 .oindex "&%-bv%&"
18374 .cindex "router" "used only when verifying"
18375 If this option is set, the router is used only when verifying an address,
18376 delivering in cutthrough mode or
18377 testing with the &%-bv%& option, not when actually doing a delivery, testing
18378 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18379 restricted to verifying only senders or recipients by means of
18380 &%verify_sender%& and &%verify_recipient%&.
18381
18382 &*Warning*&: When the router is being run to verify addresses for an incoming
18383 SMTP message, Exim is not running as root, but under its own uid. If the router
18384 accesses any files, you need to make sure that they are accessible to the Exim
18385 user or group.
18386
18387
18388 .option verify_recipient routers&!? boolean true
18389 If this option is false, the router is skipped when verifying recipient
18390 addresses,
18391 delivering in cutthrough mode
18392 or testing recipient verification using &%-bv%&.
18393 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18394 are evaluated.
18395 See also the &$verify_mode$& variable.
18396
18397
18398 .option verify_sender routers&!? boolean true
18399 If this option is false, the router is skipped when verifying sender addresses
18400 or testing sender verification using &%-bvs%&.
18401 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18402 are evaluated.
18403 See also the &$verify_mode$& variable.
18404 .ecindex IIDgenoprou1
18405 .ecindex IIDgenoprou2
18406
18407
18408
18409
18410
18411
18412 . ////////////////////////////////////////////////////////////////////////////
18413 . ////////////////////////////////////////////////////////////////////////////
18414
18415 .chapter "The accept router" "CHID4"
18416 .cindex "&(accept)& router"
18417 .cindex "routers" "&(accept)&"
18418 The &(accept)& router has no private options of its own. Unless it is being
18419 used purely for verification (see &%verify_only%&) a transport is required to
18420 be defined by the generic &%transport%& option. If the preconditions that are
18421 specified by generic options are met, the router accepts the address and queues
18422 it for the given transport. The most common use of this router is for setting
18423 up deliveries to local mailboxes. For example:
18424 .code
18425 localusers:
18426   driver = accept
18427   domains = mydomain.example
18428   check_local_user
18429   transport = local_delivery
18430 .endd
18431 The &%domains%& condition in this example checks the domain of the address, and
18432 &%check_local_user%& checks that the local part is the login of a local user.
18433 When both preconditions are met, the &(accept)& router runs, and queues the
18434 address for the &(local_delivery)& transport.
18435
18436
18437
18438
18439
18440
18441 . ////////////////////////////////////////////////////////////////////////////
18442 . ////////////////////////////////////////////////////////////////////////////
18443
18444 .chapter "The dnslookup router" "CHAPdnslookup"
18445 .scindex IIDdnsrou1 "&(dnslookup)& router"
18446 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18447 The &(dnslookup)& router looks up the hosts that handle mail for the
18448 recipient's domain in the DNS. A transport must always be set for this router,
18449 unless &%verify_only%& is set.
18450
18451 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18452 SRV records. If none are found, or if SRV support is not configured,
18453 MX records are looked up. If no MX records exist, address records are sought.
18454 However, &%mx_domains%& can be set to disable the direct use of address
18455 records.
18456
18457 MX records of equal priority are sorted by Exim into a random order. Exim then
18458 looks for address records for the host names obtained from MX or SRV records.
18459 When a host has more than one IP address, they are sorted into a random order,
18460 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18461 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18462 generic option, the router declines.
18463
18464 Unless they have the highest priority (lowest MX value), MX records that point
18465 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18466 are discarded, together with any other MX records of equal or lower priority.
18467
18468 .cindex "MX record" "pointing to local host"
18469 .cindex "local host" "MX pointing to"
18470 .oindex "&%self%&" "in &(dnslookup)& router"
18471 If the host pointed to by the highest priority MX record, or looked up as an
18472 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18473 happens is controlled by the generic &%self%& option.
18474
18475
18476 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18477 There have been problems with DNS servers when SRV records are looked up.
18478 Some misbehaving servers return a DNS error or timeout when a non-existent
18479 SRV record is sought. Similar problems have in the past been reported for
18480 MX records. The global &%dns_again_means_nonexist%& option can help with this
18481 problem, but it is heavy-handed because it is a global option.
18482
18483 For this reason, there are two options, &%srv_fail_domains%& and
18484 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18485 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18486 an attempt to look up an SRV or MX record causes one of these results, and the
18487 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18488 such record"&. In the case of an SRV lookup, this means that the router
18489 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18490 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18491 case routing fails.
18492
18493
18494 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18495 .cindex "&(dnslookup)& router" "declines"
18496 There are a few cases where a &(dnslookup)& router will decline to accept
18497 an address; if such a router is expected to handle "all remaining non-local
18498 domains", then it is important to set &%no_more%&.
18499
18500 The router will defer rather than decline if the domain
18501 is found in the &%fail_defer_domains%& router option.
18502
18503 Reasons for a &(dnslookup)& router to decline currently include:
18504 .ilist
18505 The domain does not exist in DNS
18506 .next
18507 The domain exists but the MX record's host part is just "."; this is a common
18508 convention (borrowed from SRV) used to indicate that there is no such service
18509 for this domain and to not fall back to trying A/AAAA records.
18510 .next
18511 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18512 .next
18513 MX record points to a non-existent host.
18514 .next
18515 MX record points to an IP address and the main section option
18516 &%allow_mx_to_ip%& is not set.
18517 .next
18518 MX records exist and point to valid hosts, but all hosts resolve only to
18519 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18520 .next
18521 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18522 &%dns_check_names_pattern%& for handling one variant of this)
18523 .next
18524 &%check_secondary_mx%& is set on this router but the local host can
18525 not be found in the MX records (see below)
18526 .endlist
18527
18528
18529
18530
18531 .section "Private options for dnslookup" "SECID118"
18532 .cindex "options" "&(dnslookup)& router"
18533 The private options for the &(dnslookup)& router are as follows:
18534
18535 .option check_secondary_mx dnslookup boolean false
18536 .cindex "MX record" "checking for secondary"
18537 If this option is set, the router declines unless the local host is found in
18538 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18539 process domains for which the local host is a secondary mail exchanger
18540 differently to other domains. The way in which Exim decides whether a host is
18541 the local host is described in section &<<SECTreclocipadd>>&.
18542
18543
18544 .option check_srv dnslookup string&!! unset
18545 .cindex "SRV record" "enabling use of"
18546 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18547 addition to MX and address records. The support is disabled by default. To
18548 enable SRV support, set the &%check_srv%& option to the name of the service
18549 required. For example,
18550 .code
18551 check_srv = smtp
18552 .endd
18553 looks for SRV records that refer to the normal smtp service. The option is
18554 expanded, so the service name can vary from message to message or address
18555 to address. This might be helpful if SRV records are being used for a
18556 submission service. If the expansion is forced to fail, the &%check_srv%&
18557 option is ignored, and the router proceeds to look for MX records in the
18558 normal way.
18559
18560 When the expansion succeeds, the router searches first for SRV records for
18561 the given service (it assumes TCP protocol). A single SRV record with a
18562 host name that consists of just a single dot indicates &"no such service for
18563 this domain"&; if this is encountered, the router declines. If other kinds of
18564 SRV record are found, they are used to construct a host list for delivery
18565 according to the rules of RFC 2782. MX records are not sought in this case.
18566
18567 When no SRV records are found, MX records (and address records) are sought in
18568 the traditional way. In other words, SRV records take precedence over MX
18569 records, just as MX records take precedence over address records. Note that
18570 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18571 defined it. It is apparently believed that MX records are sufficient for email
18572 and that SRV records should not be used for this purpose. However, SRV records
18573 have an additional &"weight"& feature which some people might find useful when
18574 trying to split an SMTP load between hosts of different power.
18575
18576 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18577 when there is a DNS lookup error.
18578
18579
18580
18581
18582 .option fail_defer_domains dnslookup "domain list&!!" unset
18583 .cindex "MX record" "not found"
18584 DNS lookups for domains matching &%fail_defer_domains%&
18585 which find no matching record will cause the router to defer
18586 rather than the default behaviour of decline.
18587 This maybe be useful for queueing messages for a newly created
18588 domain while the DNS configuration is not ready.
18589 However, it will result in any message with mistyped domains
18590 also being queued.
18591
18592
18593 .option mx_domains dnslookup "domain list&!!" unset
18594 .cindex "MX record" "required to exist"
18595 .cindex "SRV record" "required to exist"
18596 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18597 record in order to be recognized. (The name of this option could be improved.)
18598 For example, if all the mail hosts in &'fict.example'& are known to have MX
18599 records, except for those in &'discworld.fict.example'&, you could use this
18600 setting:
18601 .code
18602 mx_domains = ! *.discworld.fict.example : *.fict.example
18603 .endd
18604 This specifies that messages addressed to a domain that matches the list but
18605 has no MX record should be bounced immediately instead of being routed using
18606 the address record.
18607
18608
18609 .option mx_fail_domains dnslookup "domain list&!!" unset
18610 If the DNS lookup for MX records for one of the domains in this list causes a
18611 DNS lookup error, Exim behaves as if no MX records were found. See section
18612 &<<SECTprowitdnsloo>>& for more discussion.
18613
18614
18615
18616
18617 .option qualify_single dnslookup boolean true
18618 .cindex "DNS" "resolver options"
18619 .cindex "DNS" "qualifying single-component names"
18620 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18621 lookups. Typically, but not standardly, this causes the resolver to qualify
18622 single-component names with the default domain. For example, on a machine
18623 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18624 &'thesaurus.ref.example'& inside the resolver. For details of what your
18625 resolver actually does, consult your man pages for &'resolver'& and
18626 &'resolv.conf'&.
18627
18628
18629
18630 .option rewrite_headers dnslookup boolean true
18631 .cindex "rewriting" "header lines"
18632 .cindex "header lines" "rewriting"
18633 If the domain name in the address that is being processed is not fully
18634 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18635 an address is specified as &'dormouse@teaparty'&, the domain might be
18636 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18637 occur as a result of setting the &%widen_domains%& option. If
18638 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18639 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18640 header lines of the message are rewritten with the full domain name.
18641
18642 This option should be turned off only when it is known that no message is
18643 ever going to be sent outside an environment where the abbreviation makes
18644 sense.
18645
18646 When an MX record is looked up in the DNS and matches a wildcard record, name
18647 servers normally return a record containing the name that has been looked up,
18648 making it impossible to detect whether a wildcard was present or not. However,
18649 some name servers have recently been seen to return the wildcard entry. If the
18650 name returned by a DNS lookup begins with an asterisk, it is not used for
18651 header rewriting.
18652
18653
18654 .option same_domain_copy_routing dnslookup boolean false
18655 .cindex "address" "copying routing"
18656 Addresses with the same domain are normally routed by the &(dnslookup)& router
18657 to the same list of hosts. However, this cannot be presumed, because the router
18658 options and preconditions may refer to the local part of the address. By
18659 default, therefore, Exim routes each address in a message independently. DNS
18660 servers run caches, so repeated DNS lookups are not normally expensive, and in
18661 any case, personal messages rarely have more than a few recipients.
18662
18663 If you are running mailing lists with large numbers of subscribers at the same
18664 domain, and you are using a &(dnslookup)& router which is independent of the
18665 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18666 lookups for identical domains in one message. In this case, when &(dnslookup)&
18667 routes an address to a remote transport, any other unrouted addresses in the
18668 message that have the same domain are automatically given the same routing
18669 without processing them independently,
18670 provided the following conditions are met:
18671
18672 .ilist
18673 No router that processed the address specified &%headers_add%& or
18674 &%headers_remove%&.
18675 .next
18676 The router did not change the address in any way, for example, by &"widening"&
18677 the domain.
18678 .endlist
18679
18680
18681
18682
18683 .option search_parents dnslookup boolean false
18684 .cindex "DNS" "resolver options"
18685 When this option is true, the resolver option RES_DNSRCH is set for DNS
18686 lookups. This is different from the &%qualify_single%& option in that it
18687 applies to domains containing dots. Typically, but not standardly, it causes
18688 the resolver to search for the name in the current domain and in parent
18689 domains. For example, on a machine in the &'fict.example'& domain, if looking
18690 up &'teaparty.wonderland'& failed, the resolver would try
18691 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18692 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18693
18694 Setting this option true can cause problems in domains that have a wildcard MX
18695 record, because any domain that does not have its own MX record matches the
18696 local wildcard.
18697
18698
18699
18700 .option srv_fail_domains dnslookup "domain list&!!" unset
18701 If the DNS lookup for SRV records for one of the domains in this list causes a
18702 DNS lookup error, Exim behaves as if no SRV records were found. See section
18703 &<<SECTprowitdnsloo>>& for more discussion.
18704
18705
18706
18707
18708 .option widen_domains dnslookup "string list" unset
18709 .cindex "domain" "partial; widening"
18710 If a DNS lookup fails and this option is set, each of its strings in turn is
18711 added onto the end of the domain, and the lookup is tried again. For example,
18712 if
18713 .code
18714 widen_domains = fict.example:ref.example
18715 .endd
18716 is set and a lookup of &'klingon.dictionary'& fails,
18717 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18718 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18719 and &%search_parents%& options can cause some widening to be undertaken inside
18720 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18721 when verifying, unless &%rewrite_headers%& is false (not the default).
18722
18723
18724 .section "Effect of qualify_single and search_parents" "SECID119"
18725 When a domain from an envelope recipient is changed by the resolver as a result
18726 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18727 corresponding address in the message's header lines unless &%rewrite_headers%&
18728 is set false. Exim then re-routes the address, using the full domain.
18729
18730 These two options affect only the DNS lookup that takes place inside the router
18731 for the domain of the address that is being routed. They do not affect lookups
18732 such as that implied by
18733 .code
18734 domains = @mx_any
18735 .endd
18736 that may happen while processing a router precondition before the router is
18737 entered. No widening ever takes place for these lookups.
18738 .ecindex IIDdnsrou1
18739 .ecindex IIDdnsrou2
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749 . ////////////////////////////////////////////////////////////////////////////
18750 . ////////////////////////////////////////////////////////////////////////////
18751
18752 .chapter "The ipliteral router" "CHID5"
18753 .cindex "&(ipliteral)& router"
18754 .cindex "domain literal" "routing"
18755 .cindex "routers" "&(ipliteral)&"
18756 This router has no private options. Unless it is being used purely for
18757 verification (see &%verify_only%&) a transport is required to be defined by the
18758 generic &%transport%& option. The router accepts the address if its domain part
18759 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18760 router handles the address
18761 .code
18762 root@[192.168.1.1]
18763 .endd
18764 by setting up delivery to the host with that IP address. IPv4 domain literals
18765 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18766 are similar, but the address is preceded by &`ipv6:`&. For example:
18767 .code
18768 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18769 .endd
18770 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18771 grounds that sooner or later somebody will try it.
18772
18773 .oindex "&%self%&" "in &(ipliteral)& router"
18774 If the IP address matches something in &%ignore_target_hosts%&, the router
18775 declines. If an IP literal turns out to refer to the local host, the generic
18776 &%self%& option determines what happens.
18777
18778 The RFCs require support for domain literals; however, their use is
18779 controversial in today's Internet. If you want to use this router, you must
18780 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18781 Exim will not recognize the domain literal syntax in addresses.
18782
18783
18784
18785 . ////////////////////////////////////////////////////////////////////////////
18786 . ////////////////////////////////////////////////////////////////////////////
18787
18788 .chapter "The iplookup router" "CHID6"
18789 .cindex "&(iplookup)& router"
18790 .cindex "routers" "&(iplookup)&"
18791 The &(iplookup)& router was written to fulfil a specific requirement in
18792 Cambridge University (which in fact no longer exists). For this reason, it is
18793 not included in the binary of Exim by default. If you want to include it, you
18794 must set
18795 .code
18796 ROUTER_IPLOOKUP=yes
18797 .endd
18798 in your &_Local/Makefile_& configuration file.
18799
18800 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18801 connection to one or more specific hosts. The host can then return the same or
18802 a different address &-- in effect rewriting the recipient address in the
18803 message's envelope. The new address is then passed on to subsequent routers. If
18804 this process fails, the address can be passed on to other routers, or delivery
18805 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18806 must not be specified for it.
18807
18808 .cindex "options" "&(iplookup)& router"
18809 .option hosts iplookup string unset
18810 This option must be supplied. Its value is a colon-separated list of host
18811 names. The hosts are looked up using &[gethostbyname()]&
18812 (or &[getipnodebyname()]& when available)
18813 and are tried in order until one responds to the query. If none respond, what
18814 happens is controlled by &%optional%&.
18815
18816
18817 .option optional iplookup boolean false
18818 If &%optional%& is true, if no response is obtained from any host, the address
18819 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18820 delivery to the address is deferred.
18821
18822
18823 .option port iplookup integer 0
18824 .cindex "port" "&(iplookup)& router"
18825 This option must be supplied. It specifies the port number for the TCP or UDP
18826 call.
18827
18828
18829 .option protocol iplookup string udp
18830 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18831 protocols is to be used.
18832
18833
18834 .option query iplookup string&!! "see below"
18835 This defines the content of the query that is sent to the remote hosts. The
18836 default value is:
18837 .code
18838 $local_part@$domain $local_part@$domain
18839 .endd
18840 The repetition serves as a way of checking that a response is to the correct
18841 query in the default case (see &%response_pattern%& below).
18842
18843
18844 .option reroute iplookup string&!! unset
18845 If this option is not set, the rerouted address is precisely the byte string
18846 returned by the remote host, up to the first white space, if any. If set, the
18847 string is expanded to form the rerouted address. It can include parts matched
18848 in the response by &%response_pattern%& by means of numeric variables such as
18849 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18850 whether or not a pattern is in use. In all cases, the rerouted address must end
18851 up in the form &'local_part@domain'&.
18852
18853
18854 .option response_pattern iplookup string unset
18855 This option can be set to a regular expression that is applied to the string
18856 returned from the remote host. If the pattern does not match the response, the
18857 router declines. If &%response_pattern%& is not set, no checking of the
18858 response is done, unless the query was defaulted, in which case there is a
18859 check that the text returned after the first white space is the original
18860 address. This checks that the answer that has been received is in response to
18861 the correct question. For example, if the response is just a new domain, the
18862 following could be used:
18863 .code
18864 response_pattern = ^([^@]+)$
18865 reroute = $local_part@$1
18866 .endd
18867
18868 .option timeout iplookup time 5s
18869 This specifies the amount of time to wait for a response from the remote
18870 machine. The same timeout is used for the &[connect()]& function for a TCP
18871 call. It does not apply to UDP.
18872
18873
18874
18875
18876 . ////////////////////////////////////////////////////////////////////////////
18877 . ////////////////////////////////////////////////////////////////////////////
18878
18879 .chapter "The manualroute router" "CHID7"
18880 .scindex IIDmanrou1 "&(manualroute)& router"
18881 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18882 .cindex "domain" "manually routing"
18883 The &(manualroute)& router is so-called because it provides a way of manually
18884 routing an address according to its domain. It is mainly used when you want to
18885 route addresses to remote hosts according to your own rules, bypassing the
18886 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18887 route to local transports, a facility that may be useful if you want to save
18888 messages for dial-in hosts in local files.
18889
18890 The &(manualroute)& router compares a list of domain patterns with the domain
18891 it is trying to route. If there is no match, the router declines. Each pattern
18892 has associated with it a list of hosts and some other optional data, which may
18893 include a transport. The combination of a pattern and its data is called a
18894 &"routing rule"&. For patterns that do not have an associated transport, the
18895 generic &%transport%& option must specify a transport, unless the router is
18896 being used purely for verification (see &%verify_only%&).
18897
18898 .vindex "&$host$&"
18899 In the case of verification, matching the domain pattern is sufficient for the
18900 router to accept the address. When actually routing an address for delivery,
18901 an address that matches a domain pattern is queued for the associated
18902 transport. If the transport is not a local one, a host list must be associated
18903 with the pattern; IP addresses are looked up for the hosts, and these are
18904 passed to the transport along with the mail address. For local transports, a
18905 host list is optional. If it is present, it is passed in &$host$& as a single
18906 text string.
18907
18908 The list of routing rules can be provided as an inline string in
18909 &%route_list%&, or the data can be obtained by looking up the domain in a file
18910 or database by setting &%route_data%&. Only one of these settings may appear in
18911 any one instance of &(manualroute)&. The format of routing rules is described
18912 below, following the list of private options.
18913
18914
18915 .section "Private options for manualroute" "SECTprioptman"
18916
18917 .cindex "options" "&(manualroute)& router"
18918 The private options for the &(manualroute)& router are as follows:
18919
18920 .option host_all_ignored manualroute string defer
18921 See &%host_find_failed%&.
18922
18923 .option host_find_failed manualroute string freeze
18924 This option controls what happens when &(manualroute)& tries to find an IP
18925 address for a host, and the host does not exist. The option can be set to one
18926 of the following values:
18927 .code
18928 decline
18929 defer
18930 fail
18931 freeze
18932 ignore
18933 pass
18934 .endd
18935 The default (&"freeze"&) assumes that this state is a serious configuration
18936 error. The difference between &"pass"& and &"decline"& is that the former
18937 forces the address to be passed to the next router (or the router defined by
18938 &%pass_router%&),
18939 .oindex "&%more%&"
18940 overriding &%no_more%&, whereas the latter passes the address to the next
18941 router only if &%more%& is true.
18942
18943 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18944 cannot be found. If all the hosts in the list are ignored, the behaviour is
18945 controlled by the &%host_all_ignored%& option. This takes the same values
18946 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18947
18948 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18949 state; if a host lookup gets a temporary error, delivery is deferred unless the
18950 generic &%pass_on_timeout%& option is set.
18951
18952
18953 .option hosts_randomize manualroute boolean false
18954 .cindex "randomized host list"
18955 .cindex "host" "list of; randomized"
18956 If this option is set, the order of the items in a host list in a routing rule
18957 is randomized each time the list is used, unless an option in the routing rule
18958 overrides (see below). Randomizing the order of a host list can be used to do
18959 crude load sharing. However, if more than one mail address is routed by the
18960 same router to the same host list, the host lists are considered to be the same
18961 (even though they may be randomized into different orders) for the purpose of
18962 deciding whether to batch the deliveries into a single SMTP transaction.
18963
18964 When &%hosts_randomize%& is true, a host list may be split
18965 into groups whose order is separately randomized. This makes it possible to
18966 set up MX-like behaviour. The boundaries between groups are indicated by an
18967 item that is just &`+`& in the host list. For example:
18968 .code
18969 route_list = * host1:host2:host3:+:host4:host5
18970 .endd
18971 The order of the first three hosts and the order of the last two hosts is
18972 randomized for each use, but the first three always end up before the last two.
18973 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18974 randomized host list is passed to an &(smtp)& transport that also has
18975 &%hosts_randomize set%&, the list is not re-randomized.
18976
18977
18978 .option route_data manualroute string&!! unset
18979 If this option is set, it must expand to yield the data part of a routing rule.
18980 Typically, the expansion string includes a lookup based on the domain. For
18981 example:
18982 .code
18983 route_data = ${lookup{$domain}dbm{/etc/routes}}
18984 .endd
18985 If the expansion is forced to fail, or the result is an empty string, the
18986 router declines. Other kinds of expansion failure cause delivery to be
18987 deferred.
18988
18989
18990 .option route_list manualroute "string list" unset
18991 This string is a list of routing rules, in the form defined below. Note that,
18992 unlike most string lists, the items are separated by semicolons. This is so
18993 that they may contain colon-separated host lists.
18994
18995
18996 .option same_domain_copy_routing manualroute boolean false
18997 .cindex "address" "copying routing"
18998 Addresses with the same domain are normally routed by the &(manualroute)&
18999 router to the same list of hosts. However, this cannot be presumed, because the
19000 router options and preconditions may refer to the local part of the address. By
19001 default, therefore, Exim routes each address in a message independently. DNS
19002 servers run caches, so repeated DNS lookups are not normally expensive, and in
19003 any case, personal messages rarely have more than a few recipients.
19004
19005 If you are running mailing lists with large numbers of subscribers at the same
19006 domain, and you are using a &(manualroute)& router which is independent of the
19007 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19008 lookups for identical domains in one message. In this case, when
19009 &(manualroute)& routes an address to a remote transport, any other unrouted
19010 addresses in the message that have the same domain are automatically given the
19011 same routing without processing them independently. However, this is only done
19012 if &%headers_add%& and &%headers_remove%& are unset.
19013
19014
19015
19016
19017 .section "Routing rules in route_list" "SECID120"
19018 The value of &%route_list%& is a string consisting of a sequence of routing
19019 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19020 entered as two semicolons. Alternatively, the list separator can be changed as
19021 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19022 Empty rules are ignored. The format of each rule is
19023 .display
19024 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19025 .endd
19026 The following example contains two rules, each with a simple domain pattern and
19027 no options:
19028 .code
19029 route_list = \
19030   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19031   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19032 .endd
19033 The three parts of a rule are separated by white space. The pattern and the
19034 list of hosts can be enclosed in quotes if necessary, and if they are, the
19035 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19036 single domain pattern, which is the only mandatory item in the rule. The
19037 pattern is in the same format as one item in a domain list (see section
19038 &<<SECTdomainlist>>&),
19039 except that it may not be the name of an interpolated file.
19040 That is, it may be wildcarded, or a regular expression, or a file or database
19041 lookup (with semicolons doubled, because of the use of semicolon as a separator
19042 in a &%route_list%&).
19043
19044 The rules in &%route_list%& are searched in order until one of the patterns
19045 matches the domain that is being routed. The list of hosts and then options are
19046 then used as described below. If there is no match, the router declines. When
19047 &%route_list%& is set, &%route_data%& must not be set.
19048
19049
19050
19051 .section "Routing rules in route_data" "SECID121"
19052 The use of &%route_list%& is convenient when there are only a small number of
19053 routing rules. For larger numbers, it is easier to use a file or database to
19054 hold the routing information, and use the &%route_data%& option instead.
19055 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19056 Most commonly, &%route_data%& is set as a string that contains an
19057 expansion lookup. For example, suppose we place two routing rules in a file
19058 like this:
19059 .code
19060 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19061 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19062 .endd
19063 This data can be accessed by setting
19064 .code
19065 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19066 .endd
19067 Failure of the lookup results in an empty string, causing the router to
19068 decline. However, you do not have to use a lookup in &%route_data%&. The only
19069 requirement is that the result of expanding the string is a list of hosts,
19070 possibly followed by options, separated by white space. The list of hosts must
19071 be enclosed in quotes if it contains white space.
19072
19073
19074
19075
19076 .section "Format of the list of hosts" "SECID122"
19077 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19078 always separately expanded before use. If the expansion fails, the router
19079 declines. The result of the expansion must be a colon-separated list of names
19080 and/or IP addresses, optionally also including ports. The format of each item
19081 in the list is described in the next section. The list separator can be changed
19082 as described in section &<<SECTlistconstruct>>&.
19083
19084 If the list of hosts was obtained from a &%route_list%& item, the following
19085 variables are set during its expansion:
19086
19087 .ilist
19088 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19089 If the domain was matched against a regular expression, the numeric variables
19090 &$1$&, &$2$&, etc. may be set. For example:
19091 .code
19092 route_list = ^domain(\d+)   host-$1.text.example
19093 .endd
19094 .next
19095 &$0$& is always set to the entire domain.
19096 .next
19097 &$1$& is also set when partial matching is done in a file lookup.
19098
19099 .next
19100 .vindex "&$value$&"
19101 If the pattern that matched the domain was a lookup item, the data that was
19102 looked up is available in the expansion variable &$value$&. For example:
19103 .code
19104 route_list = lsearch;;/some/file.routes  $value
19105 .endd
19106 .endlist
19107
19108 Note the doubling of the semicolon in the pattern that is necessary because
19109 semicolon is the default route list separator.
19110
19111
19112
19113 .section "Format of one host item" "SECTformatonehostitem"
19114 Each item in the list of hosts is either a host name or an IP address,
19115 optionally with an attached port number. When no port is given, an IP address
19116 is not enclosed in brackets. When a port is specified, it overrides the port
19117 specification on the transport. The port is separated from the name or address
19118 by a colon. This leads to some complications:
19119
19120 .ilist
19121 Because colon is the default separator for the list of hosts, either
19122 the colon that specifies a port must be doubled, or the list separator must
19123 be changed. The following two examples have the same effect:
19124 .code
19125 route_list = * "host1.tld::1225 : host2.tld::1226"
19126 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19127 .endd
19128 .next
19129 When IPv6 addresses are involved, it gets worse, because they contain
19130 colons of their own. To make this case easier, it is permitted to
19131 enclose an IP address (either v4 or v6) in square brackets if a port
19132 number follows. For example:
19133 .code
19134 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19135 .endd
19136 .endlist
19137
19138 .section "How the list of hosts is used" "SECThostshowused"
19139 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19140 the hosts is tried, in the order specified, when carrying out the SMTP
19141 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19142 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19143 transport.
19144
19145 Hosts may be listed by name or by IP address. An unadorned name in the list of
19146 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19147 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19148 records in the DNS. For example:
19149 .code
19150 route_list = *  x.y.z:p.q.r/MX:e.f.g
19151 .endd
19152 If this feature is used with a port specifier, the port must come last. For
19153 example:
19154 .code
19155 route_list = *  dom1.tld/mx::1225
19156 .endd
19157 If the &%hosts_randomize%& option is set, the order of the items in the list is
19158 randomized before any lookups are done. Exim then scans the list; for any name
19159 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19160 be an interface on the local host and the item is not the first in the list,
19161 Exim discards it and any subsequent items. If it is the first item, what
19162 happens is controlled by the
19163 .oindex "&%self%&" "in &(manualroute)& router"
19164 &%self%& option of the router.
19165
19166 A name on the list that is followed by &`/MX`& is replaced with the list of
19167 hosts obtained by looking up MX records for the name. This is always a DNS
19168 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19169 below) are not relevant here. The order of these hosts is determined by the
19170 preference values in the MX records, according to the usual rules. Because
19171 randomizing happens before the MX lookup, it does not affect the order that is
19172 defined by MX preferences.
19173
19174 If the local host is present in the sublist obtained from MX records, but is
19175 not the most preferred host in that list, it and any equally or less
19176 preferred hosts are removed before the sublist is inserted into the main list.
19177
19178 If the local host is the most preferred host in the MX list, what happens
19179 depends on where in the original list of hosts the &`/MX`& item appears. If it
19180 is not the first item (that is, there are previous hosts in the main list),
19181 Exim discards this name and any subsequent items in the main list.
19182
19183 If the MX item is first in the list of hosts, and the local host is the
19184 most preferred host, what happens is controlled by the &%self%& option of the
19185 router.
19186
19187 DNS failures when lookup up the MX records are treated in the same way as DNS
19188 failures when looking up IP addresses: &%pass_on_timeout%& and
19189 &%host_find_failed%& are used when relevant.
19190
19191 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19192 whether obtained from an MX lookup or not.
19193
19194
19195
19196 .section "How the options are used" "SECThowoptused"
19197 The options are a sequence of words; in practice no more than three are ever
19198 present. One of the words can be the name of a transport; this overrides the
19199 &%transport%& option on the router for this particular routing rule only. The
19200 other words (if present) control randomization of the list of hosts on a
19201 per-rule basis, and how the IP addresses of the hosts are to be found when
19202 routing to a remote transport. These options are as follows:
19203
19204 .ilist
19205 &%randomize%&: randomize the order of the hosts in this list, overriding the
19206 setting of &%hosts_randomize%& for this routing rule only.
19207 .next
19208 &%no_randomize%&: do not randomize the order of the hosts in this list,
19209 overriding the setting of &%hosts_randomize%& for this routing rule only.
19210 .next
19211 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19212 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19213 also look in &_/etc/hosts_& or other sources of information.
19214 .next
19215 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19216 no address records are found. If there is a temporary DNS error (such as a
19217 timeout), delivery is deferred.
19218 .endlist
19219
19220 For example:
19221 .code
19222 route_list = domain1  host1:host2:host3  randomize bydns;\
19223              domain2  host4:host5
19224 .endd
19225 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19226 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19227 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19228 or &[gethostbyname()]&, and the result of the lookup is the result of that
19229 call.
19230
19231 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19232 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19233 instead of TRY_AGAIN. That is why the default action is to try a DNS
19234 lookup first. Only if that gives a definite &"no such host"& is the local
19235 function called.
19236
19237
19238
19239 If no IP address for a host can be found, what happens is controlled by the
19240 &%host_find_failed%& option.
19241
19242 .vindex "&$host$&"
19243 When an address is routed to a local transport, IP addresses are not looked up.
19244 The host list is passed to the transport in the &$host$& variable.
19245
19246
19247
19248 .section "Manualroute examples" "SECID123"
19249 In some of the examples that follow, the presence of the &%remote_smtp%&
19250 transport, as defined in the default configuration file, is assumed:
19251
19252 .ilist
19253 .cindex "smart host" "example router"
19254 The &(manualroute)& router can be used to forward all external mail to a
19255 &'smart host'&. If you have set up, in the main part of the configuration, a
19256 named domain list that contains your local domains, for example:
19257 .code
19258 domainlist local_domains = my.domain.example
19259 .endd
19260 You can arrange for all other domains to be routed to a smart host by making
19261 your first router something like this:
19262 .code
19263 smart_route:
19264   driver = manualroute
19265   domains = !+local_domains
19266   transport = remote_smtp
19267   route_list = * smarthost.ref.example
19268 .endd
19269 This causes all non-local addresses to be sent to the single host
19270 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19271 they are tried in order
19272 (but you can use &%hosts_randomize%& to vary the order each time).
19273 Another way of configuring the same thing is this:
19274 .code
19275 smart_route:
19276   driver = manualroute
19277   transport = remote_smtp
19278   route_list = !+local_domains  smarthost.ref.example
19279 .endd
19280 There is no difference in behaviour between these two routers as they stand.
19281 However, they behave differently if &%no_more%& is added to them. In the first
19282 example, the router is skipped if the domain does not match the &%domains%&
19283 precondition; the following router is always tried. If the router runs, it
19284 always matches the domain and so can never decline. Therefore, &%no_more%&
19285 would have no effect. In the second case, the router is never skipped; it
19286 always runs. However, if it doesn't match the domain, it declines. In this case
19287 &%no_more%& would prevent subsequent routers from running.
19288
19289 .next
19290 .cindex "mail hub example"
19291 A &'mail hub'& is a host which receives mail for a number of domains via MX
19292 records in the DNS and delivers it via its own private routing mechanism. Often
19293 the final destinations are behind a firewall, with the mail hub being the one
19294 machine that can connect to machines both inside and outside the firewall. The
19295 &(manualroute)& router is usually used on a mail hub to route incoming messages
19296 to the correct hosts. For a small number of domains, the routing can be inline,
19297 using the &%route_list%& option, but for a larger number a file or database
19298 lookup is easier to manage.
19299
19300 If the domain names are in fact the names of the machines to which the mail is
19301 to be sent by the mail hub, the configuration can be quite simple. For
19302 example:
19303 .code
19304 hub_route:
19305   driver = manualroute
19306   transport = remote_smtp
19307   route_list = *.rhodes.tvs.example  $domain
19308 .endd
19309 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19310 whose names are the same as the mail domains. A similar approach can be taken
19311 if the host name can be obtained from the domain name by a string manipulation
19312 that the expansion facilities can handle. Otherwise, a lookup based on the
19313 domain can be used to find the host:
19314 .code
19315 through_firewall:
19316   driver = manualroute
19317   transport = remote_smtp
19318   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19319 .endd
19320 The result of the lookup must be the name or IP address of the host (or
19321 hosts) to which the address is to be routed. If the lookup fails, the route
19322 data is empty, causing the router to decline. The address then passes to the
19323 next router.
19324
19325 .next
19326 .cindex "batched SMTP output example"
19327 .cindex "SMTP" "batched outgoing; example"
19328 You can use &(manualroute)& to deliver messages to pipes or files in batched
19329 SMTP format for onward transportation by some other means. This is one way of
19330 storing mail for a dial-up host when it is not connected. The route list entry
19331 can be as simple as a single domain name in a configuration like this:
19332 .code
19333 save_in_file:
19334   driver = manualroute
19335   transport = batchsmtp_appendfile
19336   route_list = saved.domain.example
19337 .endd
19338 though often a pattern is used to pick up more than one domain. If there are
19339 several domains or groups of domains with different transport requirements,
19340 different transports can be listed in the routing information:
19341 .code
19342 save_in_file:
19343   driver = manualroute
19344   route_list = \
19345     *.saved.domain1.example  $domain  batch_appendfile; \
19346     *.saved.domain2.example  \
19347       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19348       batch_pipe
19349 .endd
19350 .vindex "&$domain$&"
19351 .vindex "&$host$&"
19352 The first of these just passes the domain in the &$host$& variable, which
19353 doesn't achieve much (since it is also in &$domain$&), but the second does a
19354 file lookup to find a value to pass, causing the router to decline to handle
19355 the address if the lookup fails.
19356
19357 .next
19358 .cindex "UUCP" "example of router for"
19359 Routing mail directly to UUCP software is a specific case of the use of
19360 &(manualroute)& in a gateway to another mail environment. This is an example of
19361 one way it can be done:
19362 .code
19363 # Transport
19364 uucp:
19365   driver = pipe
19366   user = nobody
19367   command = /usr/local/bin/uux -r - \
19368     ${substr_-5:$host}!rmail ${local_part}
19369   return_fail_output = true
19370
19371 # Router
19372 uucphost:
19373   transport = uucp
19374   driver = manualroute
19375   route_data = \
19376     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19377 .endd
19378 The file &_/usr/local/exim/uucphosts_& contains entries like
19379 .code
19380 darksite.ethereal.example:           darksite.UUCP
19381 .endd
19382 It can be set up more simply without adding and removing &".UUCP"& but this way
19383 makes clear the distinction between the domain name
19384 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19385 .endlist
19386 .ecindex IIDmanrou1
19387 .ecindex IIDmanrou2
19388
19389
19390
19391
19392
19393
19394
19395
19396 . ////////////////////////////////////////////////////////////////////////////
19397 . ////////////////////////////////////////////////////////////////////////////
19398
19399 .chapter "The queryprogram router" "CHAPdriverlast"
19400 .scindex IIDquerou1 "&(queryprogram)& router"
19401 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19402 .cindex "routing" "by external program"
19403 The &(queryprogram)& router routes an address by running an external command
19404 and acting on its output. This is an expensive way to route, and is intended
19405 mainly for use in lightly-loaded systems, or for performing experiments.
19406 However, if it is possible to use the precondition options (&%domains%&,
19407 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19408 be used in special cases, even on a busy host. There are the following private
19409 options:
19410 .cindex "options" "&(queryprogram)& router"
19411
19412 .option command queryprogram string&!! unset
19413 This option must be set. It specifies the command that is to be run. The
19414 command is split up into a command name and arguments, and then each is
19415 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19416 &<<CHAPpipetransport>>&).
19417
19418
19419 .option command_group queryprogram string unset
19420 .cindex "gid (group id)" "in &(queryprogram)& router"
19421 This option specifies a gid to be set when running the command while routing an
19422 address for deliver. It must be set if &%command_user%& specifies a numerical
19423 uid. If it begins with a digit, it is interpreted as the numerical value of the
19424 gid. Otherwise it is looked up using &[getgrnam()]&.
19425
19426
19427 .option command_user queryprogram string unset
19428 .cindex "uid (user id)" "for &(queryprogram)&"
19429 This option must be set. It specifies the uid which is set when running the
19430 command while routing an address for delivery. If the value begins with a digit,
19431 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19432 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19433 not set, a value for the gid also.
19434
19435 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19436 root, which it does during a normal delivery in a conventional configuration.
19437 However, when an address is being verified during message reception, Exim is
19438 usually running as the Exim user, not as root. If the &(queryprogram)& router
19439 is called from a non-root process, Exim cannot change uid or gid before running
19440 the command. In this circumstance the command runs under the current uid and
19441 gid.
19442
19443
19444 .option current_directory queryprogram string /
19445 This option specifies an absolute path which is made the current directory
19446 before running the command.
19447
19448
19449 .option timeout queryprogram time 1h
19450 If the command does not complete within the timeout period, its process group
19451 is killed and the message is frozen. A value of zero time specifies no
19452 timeout.
19453
19454
19455 The standard output of the command is connected to a pipe, which is read when
19456 the command terminates. It should consist of a single line of output,
19457 containing up to five fields, separated by white space. The maximum length of
19458 the line is 1023 characters. Longer lines are silently truncated. The first
19459 field is one of the following words (case-insensitive):
19460
19461 .ilist
19462 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19463 below).
19464 .next
19465 &'Decline'&: the router declines; pass the address to the next router, unless
19466 &%no_more%& is set.
19467 .next
19468 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19469 subsequent text on the line is an error message. If the router is run as part
19470 of address verification during an incoming SMTP message, the message is
19471 included in the SMTP response.
19472 .next
19473 &'Defer'&: routing could not be completed at this time; try again later. Any
19474 subsequent text on the line is an error message which is logged. It is not
19475 included in any SMTP response.
19476 .next
19477 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19478 .next
19479 &'Pass'&: pass the address to the next router (or the router specified by
19480 &%pass_router%&), overriding &%no_more%&.
19481 .next
19482 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19483 new addresses, which are routed independently, starting with the first router,
19484 or the router specified by &%redirect_router%&, if set.
19485 .endlist
19486
19487 When the first word is &'accept'&, the remainder of the line consists of a
19488 number of keyed data values, as follows (split into two lines here, to fit on
19489 the page):
19490 .code
19491 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19492 LOOKUP=byname|bydns DATA=<text>
19493 .endd
19494 The data items can be given in any order, and all are optional. If no transport
19495 is included, the transport specified by the generic &%transport%& option is
19496 used. The list of hosts and the lookup type are needed only if the transport is
19497 an &(smtp)& transport that does not itself supply a list of hosts.
19498
19499 The format of the list of hosts is the same as for the &(manualroute)& router.
19500 As well as host names and IP addresses with optional port numbers, as described
19501 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19502 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19503 (see section &<<SECThostshowused>>&).
19504
19505 If the lookup type is not specified, Exim behaves as follows when trying to
19506 find an IP address for each host: First, a DNS lookup is done. If this yields
19507 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19508 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19509 result of the lookup is the result of that call.
19510
19511 .vindex "&$address_data$&"
19512 If the DATA field is set, its value is placed in the &$address_data$&
19513 variable. For example, this return line
19514 .code
19515 accept hosts=x1.y.example:x2.y.example data="rule1"
19516 .endd
19517 routes the address to the default transport, passing a list of two hosts. When
19518 the transport runs, the string &"rule1"& is in &$address_data$&.
19519 .ecindex IIDquerou1
19520 .ecindex IIDquerou2
19521
19522
19523
19524
19525 . ////////////////////////////////////////////////////////////////////////////
19526 . ////////////////////////////////////////////////////////////////////////////
19527
19528 .chapter "The redirect router" "CHAPredirect"
19529 .scindex IIDredrou1 "&(redirect)& router"
19530 .scindex IIDredrou2 "routers" "&(redirect)&"
19531 .cindex "alias file" "in a &(redirect)& router"
19532 .cindex "address redirection" "&(redirect)& router"
19533 The &(redirect)& router handles several kinds of address redirection. Its most
19534 common uses are for resolving local part aliases from a central alias file
19535 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19536 files, but it has many other potential uses. The incoming address can be
19537 redirected in several different ways:
19538
19539 .ilist
19540 It can be replaced by one or more new addresses which are themselves routed
19541 independently.
19542 .next
19543 It can be routed to be delivered to a given file or directory.
19544 .next
19545 It can be routed to be delivered to a specified pipe command.
19546 .next
19547 It can cause an automatic reply to be generated.
19548 .next
19549 It can be forced to fail, optionally with a custom error message.
19550 .next
19551 It can be temporarily deferred, optionally with a custom message.
19552 .next
19553 It can be discarded.
19554 .endlist
19555
19556 The generic &%transport%& option must not be set for &(redirect)& routers.
19557 However, there are some private options which define transports for delivery to
19558 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19559 &%pipe_transport%& and &%reply_transport%& descriptions below.
19560
19561 If success DSNs have been requested
19562 .cindex "DSN" "success"
19563 .cindex "Delivery Status Notification" "success"
19564 redirection triggers one and the DSN options are not passed any further.
19565
19566
19567
19568 .section "Redirection data" "SECID124"
19569 The router operates by interpreting a text string which it obtains either by
19570 expanding the contents of the &%data%& option, or by reading the entire
19571 contents of a file whose name is given in the &%file%& option. These two
19572 options are mutually exclusive. The first is commonly used for handling system
19573 aliases, in a configuration like this:
19574 .code
19575 system_aliases:
19576   driver = redirect
19577   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19578 .endd
19579 If the lookup fails, the expanded string in this example is empty. When the
19580 expansion of &%data%& results in an empty string, the router declines. A forced
19581 expansion failure also causes the router to decline; other expansion failures
19582 cause delivery to be deferred.
19583
19584 A configuration using &%file%& is commonly used for handling users'
19585 &_.forward_& files, like this:
19586 .code
19587 userforward:
19588   driver = redirect
19589   check_local_user
19590   file = $home/.forward
19591   no_verify
19592 .endd
19593 If the file does not exist, or causes no action to be taken (for example, it is
19594 empty or consists only of comments), the router declines. &*Warning*&: This
19595 is not the case when the file contains syntactically valid items that happen to
19596 yield empty addresses, for example, items containing only RFC 2822 address
19597 comments.
19598
19599
19600
19601 .section "Forward files and address verification" "SECID125"
19602 .cindex "address redirection" "while verifying"
19603 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19604 &_.forward_& files, as in the example above. There are two reasons for this:
19605
19606 .ilist
19607 When Exim is receiving an incoming SMTP message from a remote host, it is
19608 running under the Exim uid, not as root. Exim is unable to change uid to read
19609 the file as the user, and it may not be able to read it as the Exim user. So in
19610 practice the router may not be able to operate.
19611 .next
19612 However, even when the router can operate, the existence of a &_.forward_& file
19613 is unimportant when verifying an address. What should be checked is whether the
19614 local part is a valid user name or not. Cutting out the redirection processing
19615 saves some resources.
19616 .endlist
19617
19618
19619
19620
19621
19622
19623 .section "Interpreting redirection data" "SECID126"
19624 .cindex "Sieve filter" "specifying in redirection data"
19625 .cindex "filter" "specifying in redirection data"
19626 The contents of the data string, whether obtained from &%data%& or &%file%&,
19627 can be interpreted in two different ways:
19628
19629 .ilist
19630 If the &%allow_filter%& option is set true, and the data begins with the text
19631 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19632 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19633 respectively. Details of the syntax and semantics of filter files are described
19634 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19635 document is intended for use by end users.
19636 .next
19637 Otherwise, the data must be a comma-separated list of redirection items, as
19638 described in the next section.
19639 .endlist
19640
19641 When a message is redirected to a file (a &"mail folder"&), the file name given
19642 in a non-filter redirection list must always be an absolute path. A filter may
19643 generate a relative path &-- how this is handled depends on the transport's
19644 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19645 for the &(appendfile)& transport.
19646
19647
19648
19649 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19650 .cindex "address redirection" "non-filter list items"
19651 When the redirection data is not an Exim or Sieve filter, for example, if it
19652 comes from a conventional alias or forward file, it consists of a list of
19653 addresses, file names, pipe commands, or certain special items (see section
19654 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19655 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19656 depending on their default values. The items in the list are separated by
19657 commas or newlines.
19658 If a comma is required in an item, the entire item must be enclosed in double
19659 quotes.
19660
19661 Lines starting with a # character are comments, and are ignored, and # may
19662 also appear following a comma, in which case everything between the # and the
19663 next newline character is ignored.
19664
19665 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19666 double quotes are retained because some forms of mail address require their use
19667 (but never to enclose the entire address). In the following description,
19668 &"item"& refers to what remains after any surrounding double quotes have been
19669 removed.
19670
19671 .vindex "&$local_part$&"
19672 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19673 and the expansion contains a reference to &$local_part$&, you should make use
19674 of the &%quote_local_part%& expansion operator, in case the local part contains
19675 special characters. For example, to redirect all mail for the domain
19676 &'obsolete.example'&, retaining the existing local part, you could use this
19677 setting:
19678 .code
19679 data = ${quote_local_part:$local_part}@newdomain.example
19680 .endd
19681
19682
19683 .section "Redirecting to a local mailbox" "SECTredlocmai"
19684 .cindex "routing" "loops in"
19685 .cindex "loop" "while routing, avoidance of"
19686 .cindex "address redirection" "to local mailbox"
19687 A redirection item may safely be the same as the address currently under
19688 consideration. This does not cause a routing loop, because a router is
19689 automatically skipped if any ancestor of the address that is being processed
19690 is the same as the current address and was processed by the current router.
19691 Such an address is therefore passed to the following routers, so it is handled
19692 as if there were no redirection. When making this loop-avoidance test, the
19693 complete local part, including any prefix or suffix, is used.
19694
19695 .cindex "address redirection" "local part without domain"
19696 Specifying the same local part without a domain is a common usage in personal
19697 filter files when the user wants to have messages delivered to the local
19698 mailbox and also forwarded elsewhere. For example, the user whose login is
19699 &'cleo'& might have a &_.forward_& file containing this:
19700 .code
19701 cleo, cleopatra@egypt.example
19702 .endd
19703 .cindex "backslash in alias file"
19704 .cindex "alias file" "backslash in"
19705 For compatibility with other MTAs, such unqualified local parts may be
19706 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19707 it does make a difference if more than one domain is being handled
19708 synonymously.
19709
19710 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19711 2822 address that does not include a domain, the item is qualified using the
19712 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19713 addresses are qualified using the value in &%qualify_recipient%&, but you can
19714 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19715
19716 Care must be taken if there are alias names for local users.
19717 Consider an MTA handling a single local domain where the system alias file
19718 contains:
19719 .code
19720 Sam.Reman: spqr
19721 .endd
19722 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19723 messages in the local mailbox, and also forward copies elsewhere. He creates
19724 this forward file:
19725 .code
19726 Sam.Reman, spqr@reme.elsewhere.example
19727 .endd
19728 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19729 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19730 second time round, because it has previously routed it,
19731 and the following routers presumably cannot handle the alias. The forward file
19732 should really contain
19733 .code
19734 spqr, spqr@reme.elsewhere.example
19735 .endd
19736 but because this is such a common error, the &%check_ancestor%& option (see
19737 below) exists to provide a way to get round it. This is normally set on a
19738 &(redirect)& router that is handling users' &_.forward_& files.
19739
19740
19741
19742 .section "Special items in redirection lists" "SECTspecitredli"
19743 In addition to addresses, the following types of item may appear in redirection
19744 lists (that is, in non-filter redirection data):
19745
19746 .ilist
19747 .cindex "pipe" "in redirection list"
19748 .cindex "address redirection" "to pipe"
19749 An item is treated as a pipe command if it begins with &"|"& and does not parse
19750 as a valid RFC 2822 address that includes a domain. A transport for running the
19751 command must be specified by the &%pipe_transport%& option.
19752 Normally, either the router or the transport specifies a user and a group under
19753 which to run the delivery. The default is to use the Exim user and group.
19754
19755 Single or double quotes can be used for enclosing the individual arguments of
19756 the pipe command; no interpretation of escapes is done for single quotes. If
19757 the command contains a comma character, it is necessary to put the whole item
19758 in double quotes, for example:
19759 .code
19760 "|/some/command ready,steady,go"
19761 .endd
19762 since items in redirection lists are terminated by commas. Do not, however,
19763 quote just the command. An item such as
19764 .code
19765 |"/some/command ready,steady,go"
19766 .endd
19767 is interpreted as a pipe with a rather strange command name, and no arguments.
19768
19769 Note that the above example assumes that the text comes from a lookup source
19770 of some sort, so that the quotes are part of the data.  If composing a
19771 redirect router with a &%data%& option directly specifying this command, the
19772 quotes will be used by the configuration parser to define the extent of one
19773 string, but will not be passed down into the redirect router itself.  There
19774 are two main approaches to get around this: escape quotes to be part of the
19775 data itself, or avoid using this mechanism and instead create a custom
19776 transport with the &%command%& option set and reference that transport from
19777 an &%accept%& router.
19778
19779 .next
19780 .cindex "file" "in redirection list"
19781 .cindex "address redirection" "to file"
19782 An item is interpreted as a path name if it begins with &"/"& and does not
19783 parse as a valid RFC 2822 address that includes a domain. For example,
19784 .code
19785 /home/world/minbari
19786 .endd
19787 is treated as a file name, but
19788 .code
19789 /s=molari/o=babylon/@x400gate.way
19790 .endd
19791 is treated as an address. For a file name, a transport must be specified using
19792 the &%file_transport%& option. However, if the generated path name ends with a
19793 forward slash character, it is interpreted as a directory name rather than a
19794 file name, and &%directory_transport%& is used instead.
19795
19796 Normally, either the router or the transport specifies a user and a group under
19797 which to run the delivery. The default is to use the Exim user and group.
19798
19799 .cindex "&_/dev/null_&"
19800 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19801 bypassed at a high level, and the log entry shows &"**bypassed**"&
19802 instead of a transport name. In this case the user and group are not used.
19803
19804 .next
19805 .cindex "included address list"
19806 .cindex "address redirection" "included external list"
19807 If an item is of the form
19808 .code
19809 :include:<path name>
19810 .endd
19811 a list of further items is taken from the given file and included at that
19812 point. &*Note*&: Such a file can not be a filter file; it is just an
19813 out-of-line addition to the list. The items in the included list are separated
19814 by commas or newlines and are not subject to expansion. If this is the first
19815 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19816 the alias name. This example is incorrect:
19817 .code
19818 list1    :include:/opt/lists/list1
19819 .endd
19820 It must be given as
19821 .code
19822 list1:   :include:/opt/lists/list1
19823 .endd
19824 .next
19825 .cindex "address redirection" "to black hole"
19826 Sometimes you want to throw away mail to a particular local part. Making the
19827 &%data%& option expand to an empty string does not work, because that causes
19828 the router to decline. Instead, the alias item
19829 .cindex "black hole"
19830 .cindex "abandoning mail"
19831 &':blackhole:'& can be used. It does what its name implies. No delivery is
19832 done, and no error message is generated. This has the same effect as specifying
19833 &_/dev/null_& as a destination, but it can be independently disabled.
19834
19835 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19836 delivery is done for the original local part, even if other redirection items
19837 are present. If you are generating a multi-item list (for example, by reading a
19838 database) and need the ability to provide a no-op item, you must use
19839 &_/dev/null_&.
19840
19841 .next
19842 .cindex "delivery" "forcing failure"
19843 .cindex "delivery" "forcing deferral"
19844 .cindex "failing delivery" "forcing"
19845 .cindex "deferred delivery, forcing"
19846 .cindex "customizing" "failure message"
19847 An attempt to deliver a particular address can be deferred or forced to fail by
19848 redirection items of the form
19849 .code
19850 :defer:
19851 :fail:
19852 .endd
19853 respectively. When a redirection list contains such an item, it applies
19854 to the entire redirection; any other items in the list are ignored. Any
19855 text following &':fail:'& or &':defer:'& is placed in the error text
19856 associated with the failure. For example, an alias file might contain:
19857 .code
19858 X.Employee:  :fail: Gone away, no forwarding address
19859 .endd
19860 In the case of an address that is being verified from an ACL or as the subject
19861 of a
19862 .cindex "VRFY" "error text, display of"
19863 VRFY command, the text is included in the SMTP error response by
19864 default.
19865 .cindex "EXPN" "error text, display of"
19866 The text is not included in the response to an EXPN command. In non-SMTP cases
19867 the text is included in the error message that Exim generates.
19868
19869 .cindex "SMTP" "error codes"
19870 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19871 &':fail:'&. However, if the message starts with three digits followed by a
19872 space, optionally followed by an extended code of the form &'n.n.n'&, also
19873 followed by a space, and the very first digit is the same as the default error
19874 code, the code from the message is used instead. If the very first digit is
19875 incorrect, a panic error is logged, and the default code is used. You can
19876 suppress the use of the supplied code in a redirect router by setting the
19877 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19878 ignored.
19879
19880 .vindex "&$acl_verify_message$&"
19881 In an ACL, an explicitly provided message overrides the default, but the
19882 default message is available in the variable &$acl_verify_message$& and can
19883 therefore be included in a custom message if this is desired.
19884
19885 Normally the error text is the rest of the redirection list &-- a comma does
19886 not terminate it &-- but a newline does act as a terminator. Newlines are not
19887 normally present in alias expansions. In &(lsearch)& lookups they are removed
19888 as part of the continuation process, but they may exist in other kinds of
19889 lookup and in &':include:'& files.
19890
19891 During routing for message delivery (as opposed to verification), a redirection
19892 containing &':fail:'& causes an immediate failure of the incoming address,
19893 whereas &':defer:'& causes the message to remain on the queue so that a
19894 subsequent delivery attempt can happen at a later time. If an address is
19895 deferred for too long, it will ultimately fail, because the normal retry
19896 rules still apply.
19897
19898 .next
19899 .cindex "alias file" "exception to default"
19900 Sometimes it is useful to use a single-key search type with a default (see
19901 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19902 for exceptions to the default. These can be handled by aliasing them to
19903 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19904 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19905 results in an empty redirection list has the same effect.
19906 .endlist
19907
19908
19909 .section "Duplicate addresses" "SECTdupaddr"
19910 .cindex "duplicate addresses"
19911 .cindex "address duplicate, discarding"
19912 .cindex "pipe" "duplicated"
19913 Exim removes duplicate addresses from the list to which it is delivering, so as
19914 to deliver just one copy to each address. This does not apply to deliveries
19915 routed to pipes by different immediate parent addresses, but an indirect
19916 aliasing scheme of the type
19917 .code
19918 pipe:       |/some/command $local_part
19919 localpart1: pipe
19920 localpart2: pipe
19921 .endd
19922 does not work with a message that is addressed to both local parts, because
19923 when the second is aliased to the intermediate local part &"pipe"& it gets
19924 discarded as being the same as a previously handled address. However, a scheme
19925 such as
19926 .code
19927 localpart1: |/some/command $local_part
19928 localpart2: |/some/command $local_part
19929 .endd
19930 does result in two different pipe deliveries, because the immediate parents of
19931 the pipes are distinct.
19932
19933
19934
19935 .section "Repeated redirection expansion" "SECID128"
19936 .cindex "repeated redirection expansion"
19937 .cindex "address redirection" "repeated for each delivery attempt"
19938 When a message cannot be delivered to all of its recipients immediately,
19939 leading to two or more delivery attempts, redirection expansion is carried out
19940 afresh each time for those addresses whose children were not all previously
19941 delivered. If redirection is being used as a mailing list, this can lead to new
19942 members of the list receiving copies of old messages. The &%one_time%& option
19943 can be used to avoid this.
19944
19945
19946 .section "Errors in redirection lists" "SECID129"
19947 .cindex "address redirection" "errors"
19948 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19949 error is skipped, and an entry is written to the main log. This may be useful
19950 for mailing lists that are automatically managed. Otherwise, if an error is
19951 detected while generating the list of new addresses, the original address is
19952 deferred. See also &%syntax_errors_to%&.
19953
19954
19955
19956 .section "Private options for the redirect router" "SECID130"
19957
19958 .cindex "options" "&(redirect)& router"
19959 The private options for the &(redirect)& router are as follows:
19960
19961
19962 .option allow_defer redirect boolean false
19963 Setting this option allows the use of &':defer:'& in non-filter redirection
19964 data, or the &%defer%& command in an Exim filter file.
19965
19966
19967 .option allow_fail redirect boolean false
19968 .cindex "failing delivery" "from filter"
19969 If this option is true, the &':fail:'& item can be used in a redirection list,
19970 and the &%fail%& command may be used in an Exim filter file.
19971
19972
19973 .option allow_filter redirect boolean false
19974 .cindex "filter" "enabling use of"
19975 .cindex "Sieve filter" "enabling use of"
19976 Setting this option allows Exim to interpret redirection data that starts with
19977 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19978 are some features of Exim filter files that some administrators may wish to
19979 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19980
19981 It is also possible to lock out Exim filters or Sieve filters while allowing
19982 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19983
19984
19985 The filter is run using the uid and gid set by the generic &%user%& and
19986 &%group%& options. These take their defaults from the password data if
19987 &%check_local_user%& is set, so in the normal case of users' personal filter
19988 files, the filter is run as the relevant user. When &%allow_filter%& is set
19989 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19990
19991
19992
19993 .option allow_freeze redirect boolean false
19994 .cindex "freezing messages" "allowing in filter"
19995 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19996 This command is more normally encountered in system filters, and is disabled by
19997 default for redirection filters because it isn't something you usually want to
19998 let ordinary users do.
19999
20000
20001
20002 .option check_ancestor redirect boolean false
20003 This option is concerned with handling generated addresses that are the same
20004 as some address in the list of redirection ancestors of the current address.
20005 Although it is turned off by default in the code, it is set in the default
20006 configuration file for handling users' &_.forward_& files. It is recommended
20007 for this use of the &(redirect)& router.
20008
20009 When &%check_ancestor%& is set, if a generated address (including the domain)
20010 is the same as any ancestor of the current address, it is replaced by a copy of
20011 the current address. This helps in the case where local part A is aliased to B,
20012 and B has a &_.forward_& file pointing back to A. For example, within a single
20013 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20014 &_&~jb/.forward_& contains:
20015 .code
20016 \Joe.Bloggs, <other item(s)>
20017 .endd
20018 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20019 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20020 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20021 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20022 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20023 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20024 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20025 original address. See also the &%repeat_use%& option below.
20026
20027
20028 .option check_group redirect boolean "see below"
20029 When the &%file%& option is used, the group owner of the file is checked only
20030 when this option is set. The permitted groups are those listed in the
20031 &%owngroups%& option, together with the user's default group if
20032 &%check_local_user%& is set. If the file has the wrong group, routing is
20033 deferred. The default setting for this option is true if &%check_local_user%&
20034 is set and the &%modemask%& option permits the group write bit, or if the
20035 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20036
20037
20038
20039 .option check_owner redirect boolean "see below"
20040 When the &%file%& option is used, the owner of the file is checked only when
20041 this option is set. If &%check_local_user%& is set, the local user is
20042 permitted; otherwise the owner must be one of those listed in the &%owners%&
20043 option. The default value for this option is true if &%check_local_user%& or
20044 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20045
20046
20047 .option data redirect string&!! unset
20048 This option is mutually exclusive with &%file%&. One or other of them must be
20049 set, but not both. The contents of &%data%& are expanded, and then used as the
20050 list of forwarding items, or as a set of filtering instructions. If the
20051 expansion is forced to fail, or the result is an empty string or a string that
20052 has no effect (consists entirely of comments), the router declines.
20053
20054 When filtering instructions are used, the string must begin with &"#Exim
20055 filter"&, and all comments in the string, including this initial one, must be
20056 terminated with newline characters. For example:
20057 .code
20058 data = #Exim filter\n\
20059        if $h_to: contains Exim then save $home/mail/exim endif
20060 .endd
20061 If you are reading the data from a database where newlines cannot be included,
20062 you can use the &${sg}$& expansion item to turn the escape string of your
20063 choice into a newline.
20064
20065
20066 .option directory_transport redirect string&!! unset
20067 A &(redirect)& router sets up a direct delivery to a directory when a path name
20068 ending with a slash is specified as a new &"address"&. The transport used is
20069 specified by this option, which, after expansion, must be the name of a
20070 configured transport. This should normally be an &(appendfile)& transport.
20071
20072
20073 .option file redirect string&!! unset
20074 This option specifies the name of a file that contains the redirection data. It
20075 is mutually exclusive with the &%data%& option. The string is expanded before
20076 use; if the expansion is forced to fail, the router declines. Other expansion
20077 failures cause delivery to be deferred. The result of a successful expansion
20078 must be an absolute path. The entire file is read and used as the redirection
20079 data. If the data is an empty string or a string that has no effect (consists
20080 entirely of comments), the router declines.
20081
20082 .cindex "NFS" "checking for file existence"
20083 If the attempt to open the file fails with a &"does not exist"& error, Exim
20084 runs a check on the containing directory,
20085 unless &%ignore_enotdir%& is true (see below).
20086 If the directory does not appear to exist, delivery is deferred. This can
20087 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20088 is a mount problem. If the containing directory does exist, but the file does
20089 not, the router declines.
20090
20091
20092 .option file_transport redirect string&!! unset
20093 .vindex "&$address_file$&"
20094 A &(redirect)& router sets up a direct delivery to a file when a path name not
20095 ending in a slash is specified as a new &"address"&. The transport used is
20096 specified by this option, which, after expansion, must be the name of a
20097 configured transport. This should normally be an &(appendfile)& transport. When
20098 it is running, the file name is in &$address_file$&.
20099
20100
20101 .option filter_prepend_home redirect boolean true
20102 When this option is true, if a &(save)& command in an Exim filter specifies a
20103 relative path, and &$home$& is defined, it is automatically prepended to the
20104 relative path. If this option is set false, this action does not happen. The
20105 relative path is then passed to the transport unmodified.
20106
20107
20108 .option forbid_blackhole redirect boolean false
20109 If this option is true, the &':blackhole:'& item may not appear in a
20110 redirection list.
20111
20112
20113 .option forbid_exim_filter redirect boolean false
20114 If this option is set true, only Sieve filters are permitted when
20115 &%allow_filter%& is true.
20116
20117
20118
20119
20120 .option forbid_file redirect boolean false
20121 .cindex "delivery" "to file; forbidding"
20122 .cindex "Sieve filter" "forbidding delivery to a file"
20123 .cindex "Sieve filter" "&""keep""& facility; disabling"
20124 If this option is true, this router may not generate a new address that
20125 specifies delivery to a local file or directory, either from a filter or from a
20126 conventional forward file. This option is forced to be true if &%one_time%& is
20127 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20128 locks out the Sieve's &"keep"& facility.
20129
20130
20131 .option forbid_filter_dlfunc redirect boolean false
20132 .cindex "filter" "locking out certain features"
20133 If this option is true, string expansions in Exim filters are not allowed to
20134 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20135 functions.
20136
20137 .option forbid_filter_existstest redirect boolean false
20138 .cindex "expansion" "statting a file"
20139 If this option is true, string expansions in Exim filters are not allowed to
20140 make use of the &%exists%& condition or the &%stat%& expansion item.
20141
20142 .option forbid_filter_logwrite redirect boolean false
20143 If this option is true, use of the logging facility in Exim filters is not
20144 permitted. Logging is in any case available only if the filter is being run
20145 under some unprivileged uid (which is normally the case for ordinary users'
20146 &_.forward_& files).
20147
20148
20149 .option forbid_filter_lookup redirect boolean false
20150 If this option is true, string expansions in Exim filter files are not allowed
20151 to make use of &%lookup%& items.
20152
20153
20154 .option forbid_filter_perl redirect boolean false
20155 This option has an effect only if Exim is built with embedded Perl support. If
20156 it is true, string expansions in Exim filter files are not allowed to make use
20157 of the embedded Perl support.
20158
20159
20160 .option forbid_filter_readfile redirect boolean false
20161 If this option is true, string expansions in Exim filter files are not allowed
20162 to make use of &%readfile%& items.
20163
20164
20165 .option forbid_filter_readsocket redirect boolean false
20166 If this option is true, string expansions in Exim filter files are not allowed
20167 to make use of &%readsocket%& items.
20168
20169
20170 .option forbid_filter_reply redirect boolean false
20171 If this option is true, this router may not generate an automatic reply
20172 message. Automatic replies can be generated only from Exim or Sieve filter
20173 files, not from traditional forward files. This option is forced to be true if
20174 &%one_time%& is set.
20175
20176
20177 .option forbid_filter_run redirect boolean false
20178 If this option is true, string expansions in Exim filter files are not allowed
20179 to make use of &%run%& items.
20180
20181
20182 .option forbid_include redirect boolean false
20183 If this option is true, items of the form
20184 .code
20185 :include:<path name>
20186 .endd
20187 are not permitted in non-filter redirection lists.
20188
20189
20190 .option forbid_pipe redirect boolean false
20191 .cindex "delivery" "to pipe; forbidding"
20192 If this option is true, this router may not generate a new address which
20193 specifies delivery to a pipe, either from an Exim filter or from a conventional
20194 forward file. This option is forced to be true if &%one_time%& is set.
20195
20196
20197 .option forbid_sieve_filter redirect boolean false
20198 If this option is set true, only Exim filters are permitted when
20199 &%allow_filter%& is true.
20200
20201
20202 .cindex "SMTP" "error codes"
20203 .option forbid_smtp_code redirect boolean false
20204 If this option is set true, any SMTP error codes that are present at the start
20205 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20206 the default codes (451 and 550, respectively) are always used.
20207
20208
20209
20210
20211 .option hide_child_in_errmsg redirect boolean false
20212 .cindex "bounce message" "redirection details; suppressing"
20213 If this option is true, it prevents Exim from quoting a child address if it
20214 generates a bounce or delay message for it. Instead it says &"an address
20215 generated from <&'the top level address'&>"&. Of course, this applies only to
20216 bounces generated locally. If a message is forwarded to another host, &'its'&
20217 bounce may well quote the generated address.
20218
20219
20220 .option ignore_eacces redirect boolean false
20221 .cindex "EACCES"
20222 If this option is set and an attempt to open a redirection file yields the
20223 EACCES error (permission denied), the &(redirect)& router behaves as if the
20224 file did not exist.
20225
20226
20227 .option ignore_enotdir redirect boolean false
20228 .cindex "ENOTDIR"
20229 If this option is set and an attempt to open a redirection file yields the
20230 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20231 router behaves as if the file did not exist.
20232
20233 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20234 router that has the &%file%& option set discovers that the file does not exist
20235 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20236 against unmounted NFS directories. If the parent can not be statted, delivery
20237 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20238 is set, because that option tells Exim to ignore &"something on the path is not
20239 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20240 that some operating systems give ENOENT where others give ENOTDIR.
20241
20242
20243
20244 .option include_directory redirect string unset
20245 If this option is set, the path names of any &':include:'& items in a
20246 redirection list must start with this directory.
20247
20248
20249 .option modemask redirect "octal integer" 022
20250 This specifies mode bits which must not be set for a file specified by the
20251 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20252
20253
20254 .option one_time redirect boolean false
20255 .cindex "one-time aliasing/forwarding expansion"
20256 .cindex "alias file" "one-time expansion"
20257 .cindex "forward file" "one-time expansion"
20258 .cindex "mailing lists" "one-time expansion"
20259 .cindex "address redirection" "one-time expansion"
20260 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20261 files each time it tries to deliver a message causes a problem when one or more
20262 of the generated addresses fails be delivered at the first attempt. The problem
20263 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20264 but of what happens when the redirection list changes during the time that the
20265 message is on Exim's queue. This is particularly true in the case of mailing
20266 lists, where new subscribers might receive copies of messages that were posted
20267 before they subscribed.
20268
20269 If &%one_time%& is set and any addresses generated by the router fail to
20270 deliver at the first attempt, the failing addresses are added to the message as
20271 &"top level"& addresses, and the parent address that generated them is marked
20272 &"delivered"&. Thus, redirection does not happen again at the next delivery
20273 attempt.
20274
20275 &*Warning 1*&: Any header line addition or removal that is specified by this
20276 router would be lost if delivery did not succeed at the first attempt. For this
20277 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20278 permitted when &%one_time%& is set.
20279
20280 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20281 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20282 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20283
20284 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20285 &%one_time%&.
20286
20287 The original top-level address is remembered with each of the generated
20288 addresses, and is output in any log messages. However, any intermediate parent
20289 addresses are not recorded. This makes a difference to the log only if
20290 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20291 typically be used for mailing lists, where there is normally just one level of
20292 expansion.
20293
20294
20295 .option owners redirect "string list" unset
20296 .cindex "ownership" "alias file"
20297 .cindex "ownership" "forward file"
20298 .cindex "alias file" "ownership"
20299 .cindex "forward file" "ownership"
20300 This specifies a list of permitted owners for the file specified by &%file%&.
20301 This list is in addition to the local user when &%check_local_user%& is set.
20302 See &%check_owner%& above.
20303
20304
20305 .option owngroups redirect "string list" unset
20306 This specifies a list of permitted groups for the file specified by &%file%&.
20307 The list is in addition to the local user's primary group when
20308 &%check_local_user%& is set. See &%check_group%& above.
20309
20310
20311 .option pipe_transport redirect string&!! unset
20312 .vindex "&$address_pipe$&"
20313 A &(redirect)& router sets up a direct delivery to a pipe when a string
20314 starting with a vertical bar character is specified as a new &"address"&. The
20315 transport used is specified by this option, which, after expansion, must be the
20316 name of a configured transport. This should normally be a &(pipe)& transport.
20317 When the transport is run, the pipe command is in &$address_pipe$&.
20318
20319
20320 .option qualify_domain redirect string&!! unset
20321 .vindex "&$qualify_recipient$&"
20322 If this option is set, and an unqualified address (one without a domain) is
20323 generated, and that address would normally be qualified by the global setting
20324 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20325 expanding this string. If the expansion fails, the router declines. If you want
20326 to revert to the default, you can have the expansion generate
20327 &$qualify_recipient$&.
20328
20329 This option applies to all unqualified addresses generated by Exim filters,
20330 but for traditional &_.forward_& files, it applies only to addresses that are
20331 not preceded by a backslash. Sieve filters cannot generate unqualified
20332 addresses.
20333
20334 .option qualify_preserve_domain redirect boolean false
20335 .cindex "domain" "in redirection; preserving"
20336 .cindex "preserving domain in redirection"
20337 .cindex "address redirection" "domain; preserving"
20338 If this option is set, the router's local &%qualify_domain%& option must not be
20339 set (a configuration error occurs if it is). If an unqualified address (one
20340 without a domain) is generated, it is qualified with the domain of the parent
20341 address (the immediately preceding ancestor) instead of the global
20342 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20343 this applies whether or not the address is preceded by a backslash.
20344
20345
20346 .option repeat_use redirect boolean true
20347 If this option is set false, the router is skipped for a child address that has
20348 any ancestor that was routed by this router. This test happens before any of
20349 the other preconditions are tested. Exim's default anti-looping rules skip
20350 only when the ancestor is the same as the current address. See also
20351 &%check_ancestor%& above and the generic &%redirect_router%& option.
20352
20353
20354 .option reply_transport redirect string&!! unset
20355 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20356 &%vacation%& command is used in a filter file. The transport used is specified
20357 by this option, which, after expansion, must be the name of a configured
20358 transport. This should normally be an &(autoreply)& transport. Other transports
20359 are unlikely to do anything sensible or useful.
20360
20361
20362 .option rewrite redirect boolean true
20363 .cindex "address redirection" "disabling rewriting"
20364 If this option is set false, addresses generated by the router are not
20365 subject to address rewriting. Otherwise, they are treated like new addresses
20366 and are rewritten according to the global rewriting rules.
20367
20368
20369 .option sieve_subaddress redirect string&!! unset
20370 The value of this option is passed to a Sieve filter to specify the
20371 :subaddress part of an address.
20372
20373 .option sieve_useraddress redirect string&!! unset
20374 The value of this option is passed to a Sieve filter to specify the :user part
20375 of an address. However, if it is unset, the entire original local part
20376 (including any prefix or suffix) is used for :user.
20377
20378
20379 .option sieve_vacation_directory redirect string&!! unset
20380 .cindex "Sieve filter" "vacation directory"
20381 To enable the &"vacation"& extension for Sieve filters, you must set
20382 &%sieve_vacation_directory%& to the directory where vacation databases are held
20383 (do not put anything else in that directory), and ensure that the
20384 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20385 needs their own directory; Exim will create it if necessary.
20386
20387
20388
20389 .option skip_syntax_errors redirect boolean false
20390 .cindex "forward file" "broken"
20391 .cindex "address redirection" "broken files"
20392 .cindex "alias file" "broken"
20393 .cindex "broken alias or forward files"
20394 .cindex "ignoring faulty addresses"
20395 .cindex "skipping faulty addresses"
20396 .cindex "error" "skipping bad syntax"
20397 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20398 non-filter redirection data are skipped, and each failing address is logged. If
20399 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20400 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20401 are expanded and placed at the head of the error message generated by
20402 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20403 be the same address as the generic &%errors_to%& option. The
20404 &%skip_syntax_errors%& option is often used when handling mailing lists.
20405
20406 If all the addresses in a redirection list are skipped because of syntax
20407 errors, the router declines to handle the original address, and it is passed to
20408 the following routers.
20409
20410 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20411 error in the filter causes filtering to be abandoned without any action being
20412 taken. The incident is logged, and the router declines to handle the address,
20413 so it is passed to the following routers.
20414
20415 .cindex "Sieve filter" "syntax errors in"
20416 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20417 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20418 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20419
20420 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20421 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20422 option, used with an address that does not get redirected, can be used to
20423 notify users of these errors, by means of a router like this:
20424 .code
20425 userforward:
20426   driver = redirect
20427   allow_filter
20428   check_local_user
20429   file = $home/.forward
20430   file_transport = address_file
20431   pipe_transport = address_pipe
20432   reply_transport = address_reply
20433   no_verify
20434   skip_syntax_errors
20435   syntax_errors_to = real-$local_part@$domain
20436   syntax_errors_text = \
20437    This is an automatically generated message. An error has\n\
20438    been found in your .forward file. Details of the error are\n\
20439    reported below. While this error persists, you will receive\n\
20440    a copy of this message for every message that is addressed\n\
20441    to you. If your .forward file is a filter file, or if it is\n\
20442    a non-filter file containing no valid forwarding addresses,\n\
20443    a copy of each incoming message will be put in your normal\n\
20444    mailbox. If a non-filter file contains at least one valid\n\
20445    forwarding address, forwarding to the valid addresses will\n\
20446    happen, and those will be the only deliveries that occur.
20447 .endd
20448 You also need a router to ensure that local addresses that are prefixed by
20449 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20450 put this immediately before the &(userforward)& router:
20451 .code
20452 real_localuser:
20453   driver = accept
20454   check_local_user
20455   local_part_prefix = real-
20456   transport = local_delivery
20457 .endd
20458 For security, it would probably be a good idea to restrict the use of this
20459 router to locally-generated messages, using a condition such as this:
20460 .code
20461   condition = ${if match {$sender_host_address}\
20462                          {\N^(|127\.0\.0\.1)$\N}}
20463 .endd
20464
20465
20466 .option syntax_errors_text redirect string&!! unset
20467 See &%skip_syntax_errors%& above.
20468
20469
20470 .option syntax_errors_to redirect string unset
20471 See &%skip_syntax_errors%& above.
20472 .ecindex IIDredrou1
20473 .ecindex IIDredrou2
20474
20475
20476
20477
20478
20479
20480 . ////////////////////////////////////////////////////////////////////////////
20481 . ////////////////////////////////////////////////////////////////////////////
20482
20483 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20484          "Environment for local transports"
20485 .scindex IIDenvlotra1 "local transports" "environment for"
20486 .scindex IIDenvlotra2 "environment for local transports"
20487 .scindex IIDenvlotra3 "transport" "local; environment for"
20488 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20489 transport can be thought of as similar to a pipe.) Exim always runs transports
20490 in subprocesses, under specified uids and gids. Typical deliveries to local
20491 mailboxes run under the uid and gid of the local user.
20492
20493 Exim also sets a specific current directory while running the transport; for
20494 some transports a home directory setting is also relevant. The &(pipe)&
20495 transport is the only one that sets up environment variables; see section
20496 &<<SECTpipeenv>>& for details.
20497
20498 The values used for the uid, gid, and the directories may come from several
20499 different places. In many cases, the router that handles the address associates
20500 settings with that address as a result of its &%check_local_user%&, &%group%&,
20501 or &%user%& options. However, values may also be given in the transport's own
20502 configuration, and these override anything that comes from the router.
20503
20504
20505
20506 .section "Concurrent deliveries" "SECID131"
20507 .cindex "concurrent deliveries"
20508 .cindex "simultaneous deliveries"
20509 If two different messages for the same local recipient arrive more or less
20510 simultaneously, the two delivery processes are likely to run concurrently. When
20511 the &(appendfile)& transport is used to write to a file, Exim applies locking
20512 rules to stop concurrent processes from writing to the same file at the same
20513 time.
20514
20515 However, when you use a &(pipe)& transport, it is up to you to arrange any
20516 locking that is needed. Here is a silly example:
20517 .code
20518 my_transport:
20519   driver = pipe
20520   command = /bin/sh -c 'cat >>/some/file'
20521 .endd
20522 This is supposed to write the message at the end of the file. However, if two
20523 messages arrive at the same time, the file will be scrambled. You can use the
20524 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20525 file using the same algorithm that Exim itself uses.
20526
20527
20528
20529
20530 .section "Uids and gids" "SECTenvuidgid"
20531 .cindex "local transports" "uid and gid"
20532 .cindex "transport" "local; uid and gid"
20533 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20534 overrides any group that the router set in the address, even if &%user%& is not
20535 set for the transport. This makes it possible, for example, to run local mail
20536 delivery under the uid of the recipient (set by the router), but in a special
20537 group (set by the transport). For example:
20538 .code
20539 # Routers ...
20540 # User/group are set by check_local_user in this router
20541 local_users:
20542   driver = accept
20543   check_local_user
20544   transport = group_delivery
20545
20546 # Transports ...
20547 # This transport overrides the group
20548 group_delivery:
20549   driver = appendfile
20550   file = /var/spool/mail/$local_part
20551   group = mail
20552 .endd
20553 If &%user%& is set for a transport, its value overrides what is set in the
20554 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20555 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20556 set.
20557
20558 .oindex "&%initgroups%&"
20559 When the uid is taken from the transport's configuration, the &[initgroups()]&
20560 function is called for the groups associated with that uid if the
20561 &%initgroups%& option is set for the transport. When the uid is not specified
20562 by the transport, but is associated with the address by a router, the option
20563 for calling &[initgroups()]& is taken from the router configuration.
20564
20565 .cindex "&(pipe)& transport" "uid for"
20566 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20567 is set and &%user%& is not set, the uid of the process that called Exim to
20568 receive the message is used, and if &%group%& is not set, the corresponding
20569 original gid is also used.
20570
20571 This is the detailed preference order for obtaining a gid; the first of the
20572 following that is set is used:
20573
20574 .ilist
20575 A &%group%& setting of the transport;
20576 .next
20577 A &%group%& setting of the router;
20578 .next
20579 A gid associated with a user setting of the router, either as a result of
20580 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20581 .next
20582 The group associated with a non-numeric &%user%& setting of the transport;
20583 .next
20584 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20585 the uid is the creator's uid;
20586 .next
20587 The Exim gid if the Exim uid is being used as a default.
20588 .endlist
20589
20590 If, for example, the user is specified numerically on the router and there are
20591 no group settings, no gid is available. In this situation, an error occurs.
20592 This is different for the uid, for which there always is an ultimate default.
20593 The first of the following that is set is used:
20594
20595 .ilist
20596 A &%user%& setting of the transport;
20597 .next
20598 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20599 .next
20600 A &%user%& setting of the router;
20601 .next
20602 A &%check_local_user%& setting of the router;
20603 .next
20604 The Exim uid.
20605 .endlist
20606
20607 Of course, an error will still occur if the uid that is chosen is on the
20608 &%never_users%& list.
20609
20610
20611
20612
20613
20614 .section "Current and home directories" "SECID132"
20615 .cindex "current directory for local transport"
20616 .cindex "home directory" "for local transport"
20617 .cindex "transport" "local; home directory for"
20618 .cindex "transport" "local; current directory for"
20619 Routers may set current and home directories for local transports by means of
20620 the &%transport_current_directory%& and &%transport_home_directory%& options.
20621 However, if the transport's &%current_directory%& or &%home_directory%& options
20622 are set, they override the router's values. In detail, the home directory
20623 for a local transport is taken from the first of these values that is set:
20624
20625 .ilist
20626 The &%home_directory%& option on the transport;
20627 .next
20628 The &%transport_home_directory%& option on the router;
20629 .next
20630 The password data if &%check_local_user%& is set on the router;
20631 .next
20632 The &%router_home_directory%& option on the router.
20633 .endlist
20634
20635 The current directory is taken from the first of these values that is set:
20636
20637 .ilist
20638 The &%current_directory%& option on the transport;
20639 .next
20640 The &%transport_current_directory%& option on the router.
20641 .endlist
20642
20643
20644 If neither the router nor the transport sets a current directory, Exim uses the
20645 value of the home directory, if it is set. Otherwise it sets the current
20646 directory to &_/_& before running a local transport.
20647
20648
20649
20650 .section "Expansion variables derived from the address" "SECID133"
20651 .vindex "&$domain$&"
20652 .vindex "&$local_part$&"
20653 .vindex "&$original_domain$&"
20654 Normally a local delivery is handling a single address, and in that case the
20655 variables such as &$domain$& and &$local_part$& are set during local
20656 deliveries. However, in some circumstances more than one address may be handled
20657 at once (for example, while writing batch SMTP for onward transmission by some
20658 other means). In this case, the variables associated with the local part are
20659 never set, &$domain$& is set only if all the addresses have the same domain,
20660 and &$original_domain$& is never set.
20661 .ecindex IIDenvlotra1
20662 .ecindex IIDenvlotra2
20663 .ecindex IIDenvlotra3
20664
20665
20666
20667
20668
20669
20670
20671 . ////////////////////////////////////////////////////////////////////////////
20672 . ////////////////////////////////////////////////////////////////////////////
20673
20674 .chapter "Generic options for transports" "CHAPtransportgeneric"
20675 .scindex IIDgenoptra1 "generic options" "transport"
20676 .scindex IIDgenoptra2 "options" "generic; for transports"
20677 .scindex IIDgenoptra3 "transport" "generic options for"
20678 The following generic options apply to all transports:
20679
20680
20681 .option body_only transports boolean false
20682 .cindex "transport" "body only"
20683 .cindex "message" "transporting body only"
20684 .cindex "body of message" "transporting"
20685 If this option is set, the message's headers are not transported. It is
20686 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20687 or &(pipe)& transports, the settings of &%message_prefix%& and
20688 &%message_suffix%& should be checked, because this option does not
20689 automatically suppress them.
20690
20691
20692 .option current_directory transports string&!! unset
20693 .cindex "transport" "current directory for"
20694 This specifies the current directory that is to be set while running the
20695 transport, overriding any value that may have been set by the router.
20696 If the expansion fails for any reason, including forced failure, an error is
20697 logged, and delivery is deferred.
20698
20699
20700 .option disable_logging transports boolean false
20701 If this option is set true, nothing is logged for any
20702 deliveries by the transport or for any
20703 transport errors. You should not set this option unless you really, really know
20704 what you are doing.
20705
20706
20707 .option debug_print transports string&!! unset
20708 .cindex "testing" "variables in drivers"
20709 If this option is set and debugging is enabled (see the &%-d%& command line
20710 option), the string is expanded and included in the debugging output when the
20711 transport is run.
20712 If expansion of the string fails, the error message is written to the debugging
20713 output, and Exim carries on processing.
20714 This facility is provided to help with checking out the values of variables and
20715 so on when debugging driver configurations. For example, if a &%headers_add%&
20716 option is not working properly, &%debug_print%& could be used to output the
20717 variables it references. A newline is added to the text if it does not end with
20718 one.
20719 The variables &$transport_name$& and &$router_name$& contain the name of the
20720 transport and the router that called it.
20721
20722 .option delivery_date_add transports boolean false
20723 .cindex "&'Delivery-date:'& header line"
20724 If this option is true, a &'Delivery-date:'& header is added to the message.
20725 This gives the actual time the delivery was made. As this is not a standard
20726 header, Exim has a configuration option (&%delivery_date_remove%&) which
20727 requests its removal from incoming messages, so that delivered messages can
20728 safely be resent to other recipients.
20729
20730
20731 .option driver transports string unset
20732 This specifies which of the available transport drivers is to be used.
20733 There is no default, and this option must be set for every transport.
20734
20735
20736 .option envelope_to_add transports boolean false
20737 .cindex "&'Envelope-to:'& header line"
20738 If this option is true, an &'Envelope-to:'& header is added to the message.
20739 This gives the original address(es) in the incoming envelope that caused this
20740 delivery to happen. More than one address may be present if the transport is
20741 configured to handle several addresses at once, or if more than one original
20742 address was redirected to the same final address. As this is not a standard
20743 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20744 its removal from incoming messages, so that delivered messages can safely be
20745 resent to other recipients.
20746
20747
20748 .option event_action transports string&!! unset
20749 .cindex events
20750 This option declares a string to be expanded for Exim's events mechanism.
20751 For details see &<<CHAPevents>>&.
20752 .wen
20753
20754
20755 .option group transports string&!! "Exim group"
20756 .cindex "transport" "group; specifying"
20757 This option specifies a gid for running the transport process, overriding any
20758 value that the router supplies, and also overriding any value associated with
20759 &%user%& (see below).
20760
20761
20762 .option headers_add transports list&!! unset
20763 .cindex "header lines" "adding in transport"
20764 .cindex "transport" "header lines; adding"
20765 This option specifies a list of text headers,
20766 newline-separated (by default, changeable in the usual way),
20767 which are (separately) expanded and added to the header
20768 portion of a message as it is transported, as described in section
20769 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20770 routers. If the result of the expansion is an empty string, or if the expansion
20771 is forced to fail, no action is taken. Other expansion failures are treated as
20772 errors and cause the delivery to be deferred.
20773
20774 Unlike most options, &%headers_add%& can be specified multiple times
20775 for a transport; all listed headers are added.
20776
20777
20778 .option headers_only transports boolean false
20779 .cindex "transport" "header lines only"
20780 .cindex "message" "transporting headers only"
20781 .cindex "header lines" "transporting"
20782 If this option is set, the message's body is not transported. It is mutually
20783 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20784 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20785 checked, since this option does not automatically suppress them.
20786
20787
20788 .option headers_remove transports list&!! unset
20789 .cindex "header lines" "removing"
20790 .cindex "transport" "header lines; removing"
20791 This option specifies a list of header names,
20792 colon-separated (by default, changeable in the usual way);
20793 these headers are omitted from the message as it is transported, as described
20794 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20795 routers.
20796 Each list item is separately expanded.
20797 If the result of the expansion is an empty string, or if the expansion
20798 is forced to fail, no action is taken. Other expansion failures are treated as
20799 errors and cause the delivery to be deferred.
20800
20801 Unlike most options, &%headers_remove%& can be specified multiple times
20802 for a router; all listed headers are removed.
20803
20804 &*Warning*&: Because of the separate expansion of the list items,
20805 items that contain a list separator must have it doubled.
20806 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20807
20808
20809
20810 .option headers_rewrite transports string unset
20811 .cindex "transport" "header lines; rewriting"
20812 .cindex "rewriting" "at transport time"
20813 This option allows addresses in header lines to be rewritten at transport time,
20814 that is, as the message is being copied to its destination. The contents of the
20815 option are a colon-separated list of rewriting rules. Each rule is in exactly
20816 the same form as one of the general rewriting rules that are applied when a
20817 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20818 example,
20819 .code
20820 headers_rewrite = a@b c@d f : \
20821                   x@y w@z
20822 .endd
20823 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20824 &'w@z'& in all address-bearing header lines. The rules are applied to the
20825 header lines just before they are written out at transport time, so they affect
20826 only those copies of the message that pass through the transport. However, only
20827 the message's original header lines, and any that were added by a system
20828 filter, are rewritten. If a router or transport adds header lines, they are not
20829 affected by this option. These rewriting rules are &'not'& applied to the
20830 envelope. You can change the return path using &%return_path%&, but you cannot
20831 change envelope recipients at this time.
20832
20833
20834 .option home_directory transports string&!! unset
20835 .cindex "transport" "home directory for"
20836 .vindex "&$home$&"
20837 This option specifies a home directory setting for a local transport,
20838 overriding any value that may be set by the router. The home directory is
20839 placed in &$home$& while expanding the transport's private options. It is also
20840 used as the current directory if no current directory is set by the
20841 &%current_directory%& option on the transport or the
20842 &%transport_current_directory%& option on the router. If the expansion fails
20843 for any reason, including forced failure, an error is logged, and delivery is
20844 deferred.
20845
20846
20847 .option initgroups transports boolean false
20848 .cindex "additional groups"
20849 .cindex "groups" "additional"
20850 .cindex "transport" "group; additional"
20851 If this option is true and the uid for the delivery process is provided by the
20852 transport, the &[initgroups()]& function is called when running the transport
20853 to ensure that any additional groups associated with the uid are set up.
20854
20855
20856 .new
20857 .option max_parallel transports integer&!! unset
20858 .cindex limit "transport parallelism"
20859 .cindex transport "parallel processes"
20860 .cindex transport "concurrency limit"
20861 .cindex "delivery" "parallelism for transport"
20862 If this option is set and expands to an integer greater than zero
20863 it limits the number of concurrent runs of the transport.
20864 The control does not apply to shadow transports.
20865
20866 .cindex "hints database" "transport concurrency control"
20867 Exim implements this control by means of a hints database in which a record is
20868 incremented whenever a transport process is beaing created. The record
20869 is decremented and possibly removed when the process terminates.
20870 Obviously there is scope for
20871 records to get left lying around if there is a system or program crash. To
20872 guard against this, Exim ignores any records that are more than six hours old.
20873
20874 If you use this option, you should also arrange to delete the
20875 relevant hints database whenever your system reboots. The names of the files
20876 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20877 may be one or two files, depending on the type of DBM in use. The same files
20878 are used for ETRN and smtp transport serialization.
20879 .wen
20880
20881
20882 .option message_size_limit transports string&!! 0
20883 .cindex "limit" "message size per transport"
20884 .cindex "size" "of message, limit"
20885 .cindex "transport" "message size; limiting"
20886 This option controls the size of messages passed through the transport. It is
20887 expanded before use; the result of the expansion must be a sequence of decimal
20888 digits, optionally followed by K or M. If the expansion fails for any reason,
20889 including forced failure, or if the result is not of the required form,
20890 delivery is deferred. If the value is greater than zero and the size of a
20891 message exceeds this limit, the address is failed. If there is any chance that
20892 the resulting bounce message could be routed to the same transport, you should
20893 ensure that &%return_size_limit%& is less than the transport's
20894 &%message_size_limit%&, as otherwise the bounce message will fail to get
20895 delivered.
20896
20897
20898
20899 .option rcpt_include_affixes transports boolean false
20900 .cindex "prefix" "for local part, including in envelope"
20901 .cindex "suffix for local part" "including in envelope"
20902 .cindex "local part" "prefix"
20903 .cindex "local part" "suffix"
20904 When this option is false (the default), and an address that has had any
20905 affixes (prefixes or suffixes) removed from the local part is delivered by any
20906 form of SMTP or LMTP, the affixes are not included. For example, if a router
20907 that contains
20908 .code
20909 local_part_prefix = *-
20910 .endd
20911 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20912 is delivered with
20913 .code
20914 RCPT TO:<xyz@some.domain>
20915 .endd
20916 This is also the case when an ACL-time callout is being used to verify a
20917 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20918 whole local part is included in the RCPT command. This option applies to BSMTP
20919 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20920 &(lmtp)& and &(smtp)& transports.
20921
20922
20923 .option retry_use_local_part transports boolean "see below"
20924 .cindex "hints database" "retry keys"
20925 When a delivery suffers a temporary failure, a retry record is created
20926 in Exim's hints database. For remote deliveries, the key for the retry record
20927 is based on the name and/or IP address of the failing remote host. For local
20928 deliveries, the key is normally the entire address, including both the local
20929 part and the domain. This is suitable for most common cases of local delivery
20930 temporary failure &-- for example, exceeding a mailbox quota should delay only
20931 deliveries to that mailbox, not to the whole domain.
20932
20933 However, in some special cases you may want to treat a temporary local delivery
20934 as a failure associated with the domain, and not with a particular local part.
20935 (For example, if you are storing all mail for some domain in files.) You can do
20936 this by setting &%retry_use_local_part%& false.
20937
20938 For all the local transports, its default value is true. For remote transports,
20939 the default value is false for tidiness, but changing the value has no effect
20940 on a remote transport in the current implementation.
20941
20942
20943 .option return_path transports string&!! unset
20944 .cindex "envelope sender"
20945 .cindex "transport" "return path; changing"
20946 .cindex "return path" "changing in transport"
20947 If this option is set, the string is expanded at transport time and replaces
20948 the existing return path (envelope sender) value in the copy of the message
20949 that is being delivered. An empty return path is permitted. This feature is
20950 designed for remote deliveries, where the value of this option is used in the
20951 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20952 only effect is to change the address that is placed in the &'Return-path:'&
20953 header line, if one is added to the message (see the next option).
20954
20955 &*Note:*& A changed return path is not logged unless you add
20956 &%return_path_on_delivery%& to the log selector.
20957
20958 .vindex "&$return_path$&"
20959 The expansion can refer to the existing value via &$return_path$&. This is
20960 either the message's envelope sender, or an address set by the
20961 &%errors_to%& option on a router. If the expansion is forced to fail, no
20962 replacement occurs; if it fails for another reason, delivery is deferred. This
20963 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20964 section &<<SECTverp>>&.
20965
20966 &*Note*&: If a delivery error is detected locally, including the case when a
20967 remote server rejects a message at SMTP time, the bounce message is not sent to
20968 the value of this option. It is sent to the previously set errors address.
20969 This defaults to the incoming sender address, but can be changed by setting
20970 &%errors_to%& in a router.
20971
20972
20973
20974 .option return_path_add transports boolean false
20975 .cindex "&'Return-path:'& header line"
20976 If this option is true, a &'Return-path:'& header is added to the message.
20977 Although the return path is normally available in the prefix line of BSD
20978 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20979 have easy access to it.
20980
20981 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20982 the delivery SMTP server makes the final delivery"&. This implies that this
20983 header should not be present in incoming messages. Exim has a configuration
20984 option, &%return_path_remove%&, which requests removal of this header from
20985 incoming messages, so that delivered messages can safely be resent to other
20986 recipients.
20987
20988
20989 .option shadow_condition transports string&!! unset
20990 See &%shadow_transport%& below.
20991
20992
20993 .option shadow_transport transports string unset
20994 .cindex "shadow transport"
20995 .cindex "transport" "shadow"
20996 A local transport may set the &%shadow_transport%& option to the name of
20997 another local transport. Shadow remote transports are not supported.
20998
20999 Whenever a delivery to the main transport succeeds, and either
21000 &%shadow_condition%& is unset, or its expansion does not result in the empty
21001 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21002 passed to the shadow transport, with the same delivery address or addresses. If
21003 expansion fails, no action is taken except that non-forced expansion failures
21004 cause a log line to be written.
21005
21006 The result of the shadow transport is discarded and does not affect the
21007 subsequent processing of the message. Only a single level of shadowing is
21008 provided; the &%shadow_transport%& option is ignored on any transport when it
21009 is running as a shadow. Options concerned with output from pipes are also
21010 ignored. The log line for the successful delivery has an item added on the end,
21011 of the form
21012 .code
21013 ST=<shadow transport name>
21014 .endd
21015 If the shadow transport did not succeed, the error message is put in
21016 parentheses afterwards. Shadow transports can be used for a number of different
21017 purposes, including keeping more detailed log information than Exim normally
21018 provides, and implementing automatic acknowledgment policies based on message
21019 headers that some sites insist on.
21020
21021
21022 .option transport_filter transports string&!! unset
21023 .cindex "transport" "filter"
21024 .cindex "filter" "transport filter"
21025 This option sets up a filtering (in the Unix shell sense) process for messages
21026 at transport time. It should not be confused with mail filtering as set up by
21027 individual users or via a system filter.
21028 .new
21029 If unset, or expanding to an empty string, no filtering is done.
21030 .wen
21031
21032 When the message is about to be written out, the command specified by
21033 &%transport_filter%& is started up in a separate, parallel process, and
21034 the entire message, including the header lines, is passed to it on its standard
21035 input (this in fact is done from a third process, to avoid deadlock). The
21036 command must be specified as an absolute path.
21037
21038 The lines of the message that are written to the transport filter are
21039 terminated by newline (&"\n"&). The message is passed to the filter before any
21040 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21041 lines beginning with a dot, and also before any processing implied by the
21042 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21043 &(pipe)& transports.
21044
21045 The standard error for the filter process is set to the same destination as its
21046 standard output; this is read and written to the message's ultimate
21047 destination. The process that writes the message to the filter, the
21048 filter itself, and the original process that reads the result and delivers it
21049 are all run in parallel, like a shell pipeline.
21050
21051 The filter can perform any transformations it likes, but of course should take
21052 care not to break RFC 2822 syntax. Exim does not check the result, except to
21053 test for a final newline when SMTP is in use. All messages transmitted over
21054 SMTP must end with a newline, so Exim supplies one if it is missing.
21055
21056 .cindex "content scanning" "per user"
21057 A transport filter can be used to provide content-scanning on a per-user basis
21058 at delivery time if the only required effect of the scan is to modify the
21059 message. For example, a content scan could insert a new header line containing
21060 a spam score. This could be interpreted by a filter in the user's MUA. It is
21061 not possible to discard a message at this stage.
21062
21063 .cindex "SMTP" "SIZE"
21064 A problem might arise if the filter increases the size of a message that is
21065 being sent down an SMTP connection. If the receiving SMTP server has indicated
21066 support for the SIZE parameter, Exim will have sent the size of the message
21067 at the start of the SMTP session. If what is actually sent is substantially
21068 more, the server might reject the message. This can be worked round by setting
21069 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21070 additions to the message, or to disable the use of SIZE altogether.
21071
21072 .vindex "&$pipe_addresses$&"
21073 The value of the &%transport_filter%& option is the command string for starting
21074 the filter, which is run directly from Exim, not under a shell. The string is
21075 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21076 Exim breaks it up into arguments and then expands each argument separately (see
21077 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21078 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21079 of arguments, one for each address that applies to this delivery. (This isn't
21080 an ideal name for this feature here, but as it was already implemented for the
21081 &(pipe)& transport, it seemed sensible not to change it.)
21082
21083 .vindex "&$host$&"
21084 .vindex "&$host_address$&"
21085 The expansion variables &$host$& and &$host_address$& are available when the
21086 transport is a remote one. They contain the name and IP address of the host to
21087 which the message is being sent. For example:
21088 .code
21089 transport_filter = /some/directory/transport-filter.pl \
21090   $host $host_address $sender_address $pipe_addresses
21091 .endd
21092
21093 Two problems arise if you want to use more complicated expansion items to
21094 generate transport filter commands, both of which due to the fact that the
21095 command is split up &'before'& expansion.
21096 .ilist
21097 If an expansion item contains white space, you must quote it, so that it is all
21098 part of the same command item. If the entire option setting is one such
21099 expansion item, you have to take care what kind of quoting you use. For
21100 example:
21101 .code
21102 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21103 .endd
21104 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21105 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21106 stripped by Exim when it read the option's value. When the value is used, if
21107 the single quotes were missing, the line would be split into two items,
21108 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21109 Exim tried to expand the first one.
21110 .next
21111 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21112 expansion cannot generate multiple arguments, or a command name followed by
21113 arguments. Consider this example:
21114 .code
21115 transport_filter = ${lookup{$host}lsearch{/a/file}\
21116                     {$value}{/bin/cat}}
21117 .endd
21118 The result of the lookup is interpreted as the name of the command, even
21119 if it contains white space. The simplest way round this is to use a shell:
21120 .code
21121 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21122                                {$value}{/bin/cat}}
21123 .endd
21124 .endlist
21125
21126 The filter process is run under the same uid and gid as the normal delivery.
21127 For remote deliveries this is the Exim uid/gid by default. The command should
21128 normally yield a zero return code. Transport filters are not supposed to fail.
21129 A non-zero code is taken to mean that the transport filter encountered some
21130 serious problem. Delivery of the message is deferred; the message remains on
21131 the queue and is tried again later. It is not possible to cause a message to be
21132 bounced from a transport filter.
21133
21134 If a transport filter is set on an autoreply transport, the original message is
21135 passed through the filter as it is being copied into the newly generated
21136 message, which happens if the &%return_message%& option is set.
21137
21138
21139 .option transport_filter_timeout transports time 5m
21140 .cindex "transport" "filter, timeout"
21141 When Exim is reading the output of a transport filter, it applies a timeout
21142 that can be set by this option. Exceeding the timeout is normally treated as a
21143 temporary delivery failure. However, if a transport filter is used with a
21144 &(pipe)& transport, a timeout in the transport filter is treated in the same
21145 way as a timeout in the pipe command itself. By default, a timeout is a hard
21146 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21147 becomes a temporary error.
21148
21149
21150 .option user transports string&!! "Exim user"
21151 .cindex "uid (user id)" "local delivery"
21152 .cindex "transport" "user, specifying"
21153 This option specifies the user under whose uid the delivery process is to be
21154 run, overriding any uid that may have been set by the router. If the user is
21155 given as a name, the uid is looked up from the password data, and the
21156 associated group is taken as the value of the gid to be used if the &%group%&
21157 option is not set.
21158
21159 For deliveries that use local transports, a user and group are normally
21160 specified explicitly or implicitly (for example, as a result of
21161 &%check_local_user%&) by the router or transport.
21162
21163 .cindex "hints database" "access by remote transport"
21164 For remote transports, you should leave this option unset unless you really are
21165 sure you know what you are doing. When a remote transport is running, it needs
21166 to be able to access Exim's hints databases, because each host may have its own
21167 retry data.
21168 .ecindex IIDgenoptra1
21169 .ecindex IIDgenoptra2
21170 .ecindex IIDgenoptra3
21171
21172
21173
21174
21175
21176
21177 . ////////////////////////////////////////////////////////////////////////////
21178 . ////////////////////////////////////////////////////////////////////////////
21179
21180 .chapter "Address batching in local transports" "CHAPbatching" &&&
21181          "Address batching"
21182 .cindex "transport" "local; address batching in"
21183 The only remote transport (&(smtp)&) is normally configured to handle more than
21184 one address at a time, so that when several addresses are routed to the same
21185 remote host, just one copy of the message is sent. Local transports, however,
21186 normally handle one address at a time. That is, a separate instance of the
21187 transport is run for each address that is routed to the transport. A separate
21188 copy of the message is delivered each time.
21189
21190 .cindex "batched local delivery"
21191 .oindex "&%batch_max%&"
21192 .oindex "&%batch_id%&"
21193 In special cases, it may be desirable to handle several addresses at once in a
21194 local transport, for example:
21195
21196 .ilist
21197 In an &(appendfile)& transport, when storing messages in files for later
21198 delivery by some other means, a single copy of the message with multiple
21199 recipients saves space.
21200 .next
21201 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21202 a single copy saves time, and is the normal way LMTP is expected to work.
21203 .next
21204 In a &(pipe)& transport, when passing the message
21205 to a scanner program or
21206 to some other delivery mechanism such as UUCP, multiple recipients may be
21207 acceptable.
21208 .endlist
21209
21210 These three local transports all have the same options for controlling multiple
21211 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21212 repeating the information for each transport, these options are described here.
21213
21214 The &%batch_max%& option specifies the maximum number of addresses that can be
21215 delivered together in a single run of the transport. Its default value is one
21216 (no batching). When more than one address is routed to a transport that has a
21217 &%batch_max%& value greater than one, the addresses are delivered in a batch
21218 (that is, in a single run of the transport with multiple recipients), subject
21219 to certain conditions:
21220
21221 .ilist
21222 .vindex "&$local_part$&"
21223 If any of the transport's options contain a reference to &$local_part$&, no
21224 batching is possible.
21225 .next
21226 .vindex "&$domain$&"
21227 If any of the transport's options contain a reference to &$domain$&, only
21228 addresses with the same domain are batched.
21229 .next
21230 .cindex "customizing" "batching condition"
21231 If &%batch_id%& is set, it is expanded for each address, and only those
21232 addresses with the same expanded value are batched. This allows you to specify
21233 customized batching conditions. Failure of the expansion for any reason,
21234 including forced failure, disables batching, but it does not stop the delivery
21235 from taking place.
21236 .next
21237 Batched addresses must also have the same errors address (where to send
21238 delivery errors), the same header additions and removals, the same user and
21239 group for the transport, and if a host list is present, the first host must
21240 be the same.
21241 .endlist
21242
21243 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21244 both when the file or pipe command is specified in the transport, and when it
21245 is specified by a &(redirect)& router, but all the batched addresses must of
21246 course be routed to the same file or pipe command. These two transports have an
21247 option called &%use_bsmtp%&, which causes them to deliver the message in
21248 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21249 &%check_string%& and &%escape_string%& options are forced to the values
21250 .code
21251 check_string = "."
21252 escape_string = ".."
21253 .endd
21254 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21255 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21256 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21257
21258 .cindex "&'Envelope-to:'& header line"
21259 If the generic &%envelope_to_add%& option is set for a batching transport, the
21260 &'Envelope-to:'& header that is added to the message contains all the addresses
21261 that are being processed together. If you are using a batching &(appendfile)&
21262 transport without &%use_bsmtp%&, the only way to preserve the recipient
21263 addresses is to set the &%envelope_to_add%& option.
21264
21265 .cindex "&(pipe)& transport" "with multiple addresses"
21266 .vindex "&$pipe_addresses$&"
21267 If you are using a &(pipe)& transport without BSMTP, and setting the
21268 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21269 the command. This is not a true variable; it is a bit of magic that causes each
21270 of the recipient addresses to be inserted into the command as a separate
21271 argument. This provides a way of accessing all the addresses that are being
21272 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21273 are specified by a &(redirect)& router.
21274
21275
21276
21277
21278 . ////////////////////////////////////////////////////////////////////////////
21279 . ////////////////////////////////////////////////////////////////////////////
21280
21281 .chapter "The appendfile transport" "CHAPappendfile"
21282 .scindex IIDapptra1 "&(appendfile)& transport"
21283 .scindex IIDapptra2 "transports" "&(appendfile)&"
21284 .cindex "directory creation"
21285 .cindex "creating directories"
21286 The &(appendfile)& transport delivers a message by appending it to an existing
21287 file, or by creating an entirely new file in a specified directory. Single
21288 files to which messages are appended can be in the traditional Unix mailbox
21289 format, or optionally in the MBX format supported by the Pine MUA and
21290 University of Washington IMAP daemon, &'inter alia'&. When each message is
21291 being delivered as a separate file, &"maildir"& format can optionally be used
21292 to give added protection against failures that happen part-way through the
21293 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21294 supported. For all file formats, Exim attempts to create as many levels of
21295 directory as necessary, provided that &%create_directory%& is set.
21296
21297 The code for the optional formats is not included in the Exim binary by
21298 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21299 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21300 included.
21301
21302 .cindex "quota" "system"
21303 Exim recognizes system quota errors, and generates an appropriate message. Exim
21304 also supports its own quota control within the transport, for use when the
21305 system facility is unavailable or cannot be used for some reason.
21306
21307 If there is an error while appending to a file (for example, quota exceeded or
21308 partition filled), Exim attempts to reset the file's length and last
21309 modification time back to what they were before. If there is an error while
21310 creating an entirely new file, the new file is removed.
21311
21312 Before appending to a file, a number of security checks are made, and the
21313 file is locked. A detailed description is given below, after the list of
21314 private options.
21315
21316 The &(appendfile)& transport is most commonly used for local deliveries to
21317 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21318 putting messages into files for remote delivery by some means other than Exim.
21319 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21320 option).
21321
21322
21323
21324 .section "The file and directory options" "SECTfildiropt"
21325 The &%file%& option specifies a single file, to which the message is appended;
21326 the &%directory%& option specifies a directory, in which a new file containing
21327 the message is created. Only one of these two options can be set, and for
21328 normal deliveries to mailboxes, one of them &'must'& be set.
21329
21330 .vindex "&$address_file$&"
21331 .vindex "&$local_part$&"
21332 However, &(appendfile)& is also used for delivering messages to files or
21333 directories whose names (or parts of names) are obtained from alias,
21334 forwarding, or filtering operations (for example, a &%save%& command in a
21335 user's Exim filter). When such a transport is running, &$local_part$& contains
21336 the local part that was aliased or forwarded, and &$address_file$& contains the
21337 name (or partial name) of the file or directory generated by the redirection
21338 operation. There are two cases:
21339
21340 .ilist
21341 If neither &%file%& nor &%directory%& is set, the redirection operation
21342 must specify an absolute path (one that begins with &`/`&). This is the most
21343 common case when users with local accounts use filtering to sort mail into
21344 different folders. See for example, the &(address_file)& transport in the
21345 default configuration. If the path ends with a slash, it is assumed to be the
21346 name of a directory. A delivery to a directory can also be forced by setting
21347 &%maildir_format%& or &%mailstore_format%&.
21348 .next
21349 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21350 used to determine the file or directory name for the delivery. Normally, the
21351 contents of &$address_file$& are used in some way in the string expansion.
21352 .endlist
21353
21354
21355 .cindex "Sieve filter" "configuring &(appendfile)&"
21356 .cindex "Sieve filter" "relative mailbox path handling"
21357 As an example of the second case, consider an environment where users do not
21358 have home directories. They may be permitted to use Exim filter commands of the
21359 form:
21360 .code
21361 save folder23
21362 .endd
21363 or Sieve filter commands of the form:
21364 .code
21365 require "fileinto";
21366 fileinto "folder23";
21367 .endd
21368 In this situation, the expansion of &%file%& or &%directory%& in the transport
21369 must transform the relative path into an appropriate absolute file name. In the
21370 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21371 is used as a result of a &"keep"& action in the filter. This example shows one
21372 way of handling this requirement:
21373 .code
21374 file = ${if eq{$address_file}{inbox} \
21375             {/var/mail/$local_part} \
21376             {${if eq{${substr_0_1:$address_file}}{/} \
21377                   {$address_file} \
21378                   {$home/mail/$address_file} \
21379             }} \
21380        }
21381 .endd
21382 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21383 location, absolute paths are used without change, and other folders are in the
21384 &_mail_& directory within the home directory.
21385
21386 &*Note 1*&: While processing an Exim filter, a relative path such as
21387 &_folder23_& is turned into an absolute path if a home directory is known to
21388 the router. In particular, this is the case if &%check_local_user%& is set. If
21389 you want to prevent this happening at routing time, you can set
21390 &%router_home_directory%& empty. This forces the router to pass the relative
21391 path to the transport.
21392
21393 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21394 the &%file%& or &%directory%& option is still used if it is set.
21395
21396
21397
21398
21399 .section "Private options for appendfile" "SECID134"
21400 .cindex "options" "&(appendfile)& transport"
21401
21402
21403
21404 .option allow_fifo appendfile boolean false
21405 .cindex "fifo (named pipe)"
21406 .cindex "named pipe (fifo)"
21407 .cindex "pipe" "named (fifo)"
21408 Setting this option permits delivery to named pipes (FIFOs) as well as to
21409 regular files. If no process is reading the named pipe at delivery time, the
21410 delivery is deferred.
21411
21412
21413 .option allow_symlink appendfile boolean false
21414 .cindex "symbolic link" "to mailbox"
21415 .cindex "mailbox" "symbolic link"
21416 By default, &(appendfile)& will not deliver if the path name for the file is
21417 that of a symbolic link. Setting this option relaxes that constraint, but there
21418 are security issues involved in the use of symbolic links. Be sure you know
21419 what you are doing if you set this. Details of exactly what this option affects
21420 are included in the discussion which follows this list of options.
21421
21422
21423 .option batch_id appendfile string&!! unset
21424 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21425 However, batching is automatically disabled for &(appendfile)& deliveries that
21426 happen as a result of forwarding or aliasing or other redirection directly to a
21427 file.
21428
21429
21430 .option batch_max appendfile integer 1
21431 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21432
21433
21434 .option check_group appendfile boolean false
21435 When this option is set, the group owner of the file defined by the &%file%&
21436 option is checked to see that it is the same as the group under which the
21437 delivery process is running. The default setting is false because the default
21438 file mode is 0600, which means that the group is irrelevant.
21439
21440
21441 .option check_owner appendfile boolean true
21442 When this option is set, the owner of the file defined by the &%file%& option
21443 is checked to ensure that it is the same as the user under which the delivery
21444 process is running.
21445
21446
21447 .option check_string appendfile string "see below"
21448 .cindex "&""From""& line"
21449 As &(appendfile)& writes the message, the start of each line is tested for
21450 matching &%check_string%&, and if it does, the initial matching characters are
21451 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21452 a literal string, not a regular expression, and the case of any letters it
21453 contains is significant.
21454
21455 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21456 are forced to &"."& and &".."& respectively, and any settings in the
21457 configuration are ignored. Otherwise, they default to &"From&~"& and
21458 &">From&~"& when the &%file%& option is set, and unset when any of the
21459 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21460
21461 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21462 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21463 &"From&~"& indicates the start of a new message. All four options need changing
21464 if another format is used. For example, to deliver to mailboxes in MMDF format:
21465 .cindex "MMDF format mailbox"
21466 .cindex "mailbox" "MMDF format"
21467 .code
21468 check_string = "\1\1\1\1\n"
21469 escape_string = "\1\1\1\1 \n"
21470 message_prefix = "\1\1\1\1\n"
21471 message_suffix = "\1\1\1\1\n"
21472 .endd
21473 .option create_directory appendfile boolean true
21474 .cindex "directory creation"
21475 When this option is true, Exim attempts to create any missing superior
21476 directories for the file that it is about to write. A created directory's mode
21477 is given by the &%directory_mode%& option.
21478
21479 The group ownership of a newly created directory is highly dependent on the
21480 operating system (and possibly the file system) that is being used. For
21481 example, in Solaris, if the parent directory has the setgid bit set, its group
21482 is propagated to the child; if not, the currently set group is used. However,
21483 in FreeBSD, the parent's group is always used.
21484
21485
21486
21487 .option create_file appendfile string anywhere
21488 This option constrains the location of files and directories that are created
21489 by this transport. It applies to files defined by the &%file%& option and
21490 directories defined by the &%directory%& option. In the case of maildir
21491 delivery, it applies to the top level directory, not the maildir directories
21492 beneath.
21493
21494 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21495 &"belowhome"&. In the second and third cases, a home directory must have been
21496 set for the transport. This option is not useful when an explicit file name is
21497 given for normal mailbox deliveries. It is intended for the case when file
21498 names are generated from users' &_.forward_& files. These are usually handled
21499 by an &(appendfile)& transport called &%address_file%&. See also
21500 &%file_must_exist%&.
21501
21502
21503 .option directory appendfile string&!! unset
21504 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21505 or &%directory%& must be set, unless the delivery is the direct result of a
21506 redirection (see section &<<SECTfildiropt>>&).
21507
21508 When &%directory%& is set, the string is expanded, and the message is delivered
21509 into a new file or files in or below the given directory, instead of being
21510 appended to a single mailbox file. A number of different formats are provided
21511 (see &%maildir_format%& and &%mailstore_format%&), and see section
21512 &<<SECTopdir>>& for further details of this form of delivery.
21513
21514
21515 .option directory_file appendfile string&!! "see below"
21516 .cindex "base62"
21517 .vindex "&$inode$&"
21518 When &%directory%& is set, but neither &%maildir_format%& nor
21519 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21520 whose name is obtained by expanding this string. The default value is:
21521 .code
21522 q${base62:$tod_epoch}-$inode
21523 .endd
21524 This generates a unique name from the current time, in base 62 form, and the
21525 inode of the file. The variable &$inode$& is available only when expanding this
21526 option.
21527
21528
21529 .option directory_mode appendfile "octal integer" 0700
21530 If &(appendfile)& creates any directories as a result of the
21531 &%create_directory%& option, their mode is specified by this option.
21532
21533
21534 .option escape_string appendfile string "see description"
21535 See &%check_string%& above.
21536
21537
21538 .option file appendfile string&!! unset
21539 This option is mutually exclusive with the &%directory%& option, but one of
21540 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21541 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21542 specifies a single file, to which the message is appended. One or more of
21543 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21544 &%file%&.
21545
21546 .cindex "NFS" "lock file"
21547 .cindex "locking files"
21548 .cindex "lock files"
21549 If you are using more than one host to deliver over NFS into the same
21550 mailboxes, you should always use lock files.
21551
21552 The string value is expanded for each delivery, and must yield an absolute
21553 path. The most common settings of this option are variations on one of these
21554 examples:
21555 .code
21556 file = /var/spool/mail/$local_part
21557 file = /home/$local_part/inbox
21558 file = $home/inbox
21559 .endd
21560 .cindex "&""sticky""& bit"
21561 In the first example, all deliveries are done into the same directory. If Exim
21562 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21563 create a file in the directory, so the &"sticky"& bit must be turned on for
21564 deliveries to be possible, or alternatively the &%group%& option can be used to
21565 run the delivery under a group id which has write access to the directory.
21566
21567
21568
21569 .option file_format appendfile string unset
21570 .cindex "file" "mailbox; checking existing format"
21571 This option requests the transport to check the format of an existing file
21572 before adding to it. The check consists of matching a specific string at the
21573 start of the file. The value of the option consists of an even number of
21574 colon-separated strings. The first of each pair is the test string, and the
21575 second is the name of a transport. If the transport associated with a matched
21576 string is not the current transport, control is passed over to the other
21577 transport. For example, suppose the standard &(local_delivery)& transport has
21578 this added to it:
21579 .code
21580 file_format = "From       : local_delivery :\
21581                \1\1\1\1\n : local_mmdf_delivery"
21582 .endd
21583 Mailboxes that begin with &"From"& are still handled by this transport, but if
21584 a mailbox begins with four binary ones followed by a newline, control is passed
21585 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21586 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21587 is assumed to match the current transport. If the start of a mailbox doesn't
21588 match any string, or if the transport named for a given string is not defined,
21589 delivery is deferred.
21590
21591
21592 .option file_must_exist appendfile boolean false
21593 If this option is true, the file specified by the &%file%& option must exist.
21594 A temporary error occurs if it does not, causing delivery to be deferred.
21595 If this option is false, the file is created if it does not exist.
21596
21597
21598 .option lock_fcntl_timeout appendfile time 0s
21599 .cindex "timeout" "mailbox locking"
21600 .cindex "mailbox" "locking, blocking and non-blocking"
21601 .cindex "locking files"
21602 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21603 when locking an open mailbox file. If the call fails, the delivery process
21604 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21605 Non-blocking calls are used so that the file is not kept open during the wait
21606 for the lock; the reason for this is to make it as safe as possible for
21607 deliveries over NFS in the case when processes might be accessing an NFS
21608 mailbox without using a lock file. This should not be done, but
21609 misunderstandings and hence misconfigurations are not unknown.
21610
21611 On a busy system, however, the performance of a non-blocking lock approach is
21612 not as good as using a blocking lock with a timeout. In this case, the waiting
21613 is done inside the system call, and Exim's delivery process acquires the lock
21614 and can proceed as soon as the previous lock holder releases it.
21615
21616 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21617 timeout, are used. There may still be some retrying: the maximum number of
21618 retries is
21619 .code
21620 (lock_retries * lock_interval) / lock_fcntl_timeout
21621 .endd
21622 rounded up to the next whole number. In other words, the total time during
21623 which &(appendfile)& is trying to get a lock is roughly the same, unless
21624 &%lock_fcntl_timeout%& is set very large.
21625
21626 You should consider setting this option if you are getting a lot of delayed
21627 local deliveries because of errors of the form
21628 .code
21629 failed to lock mailbox /some/file (fcntl)
21630 .endd
21631
21632 .option lock_flock_timeout appendfile time 0s
21633 This timeout applies to file locking when using &[flock()]& (see
21634 &%use_flock%&); the timeout operates in a similar manner to
21635 &%lock_fcntl_timeout%&.
21636
21637
21638 .option lock_interval appendfile time 3s
21639 This specifies the time to wait between attempts to lock the file. See below
21640 for details of locking.
21641
21642
21643 .option lock_retries appendfile integer 10
21644 This specifies the maximum number of attempts to lock the file. A value of zero
21645 is treated as 1. See below for details of locking.
21646
21647
21648 .option lockfile_mode appendfile "octal integer" 0600
21649 This specifies the mode of the created lock file, when a lock file is being
21650 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21651
21652
21653 .option lockfile_timeout appendfile time 30m
21654 .cindex "timeout" "mailbox locking"
21655 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21656 exists and is older than this value, it is assumed to have been left behind by
21657 accident, and Exim attempts to remove it.
21658
21659
21660 .option mailbox_filecount appendfile string&!! unset
21661 .cindex "mailbox" "specifying size of"
21662 .cindex "size" "of mailbox"
21663 If this option is set, it is expanded, and the result is taken as the current
21664 number of files in the mailbox. It must be a decimal number, optionally
21665 followed by K or M. This provides a way of obtaining this information from an
21666 external source that maintains the data.
21667
21668
21669 .option mailbox_size appendfile string&!! unset
21670 .cindex "mailbox" "specifying size of"
21671 .cindex "size" "of mailbox"
21672 If this option is set, it is expanded, and the result is taken as the current
21673 size the mailbox. It must be a decimal number, optionally followed by K or M.
21674 This provides a way of obtaining this information from an external source that
21675 maintains the data. This is likely to be helpful for maildir deliveries where
21676 it is computationally expensive to compute the size of a mailbox.
21677
21678
21679
21680 .option maildir_format appendfile boolean false
21681 .cindex "maildir format" "specifying"
21682 If this option is set with the &%directory%& option, the delivery is into a new
21683 file, in the &"maildir"& format that is used by other mail software. When the
21684 transport is activated directly from a &(redirect)& router (for example, the
21685 &(address_file)& transport in the default configuration), setting
21686 &%maildir_format%& causes the path received from the router to be treated as a
21687 directory, whether or not it ends with &`/`&. This option is available only if
21688 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21689 &<<SECTmaildirdelivery>>& below for further details.
21690
21691
21692 .option maildir_quota_directory_regex appendfile string "See below"
21693 .cindex "maildir format" "quota; directories included in"
21694 .cindex "quota" "maildir; directories included in"
21695 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21696 a regular expression for specifying directories, relative to the quota
21697 directory (see &%quota_directory%&), that should be included in the quota
21698 calculation. The default value is:
21699 .code
21700 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21701 .endd
21702 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21703 (directories whose names begin with a dot). If you want to exclude the
21704 &_Trash_&
21705 folder from the count (as some sites do), you need to change this setting to
21706 .code
21707 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21708 .endd
21709 This uses a negative lookahead in the regular expression to exclude the
21710 directory whose name is &_.Trash_&. When a directory is excluded from quota
21711 calculations, quota processing is bypassed for any messages that are delivered
21712 directly into that directory.
21713
21714
21715 .option maildir_retries appendfile integer 10
21716 This option specifies the number of times to retry when writing a file in
21717 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21718
21719
21720 .option maildir_tag appendfile string&!! unset
21721 This option applies only to deliveries in maildir format, and is described in
21722 section &<<SECTmaildirdelivery>>& below.
21723
21724
21725 .option maildir_use_size_file appendfile&!! boolean false
21726 .cindex "maildir format" "&_maildirsize_& file"
21727 The result of string expansion for this option must be a valid boolean value.
21728 If it is true, it enables support for &_maildirsize_& files. Exim
21729 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21730 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21731 value is zero. See &%maildir_quota_directory_regex%& above and section
21732 &<<SECTmaildirdelivery>>& below for further details.
21733
21734 .option maildirfolder_create_regex appendfile string unset
21735 .cindex "maildir format" "&_maildirfolder_& file"
21736 .cindex "&_maildirfolder_&, creating"
21737 The value of this option is a regular expression. If it is unset, it has no
21738 effect. Otherwise, before a maildir delivery takes place, the pattern is
21739 matched against the name of the maildir directory, that is, the directory
21740 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21741 delivery. If there is a match, Exim checks for the existence of a file called
21742 &_maildirfolder_& in the directory, and creates it if it does not exist.
21743 See section &<<SECTmaildirdelivery>>& for more details.
21744
21745
21746 .option mailstore_format appendfile boolean false
21747 .cindex "mailstore format" "specifying"
21748 If this option is set with the &%directory%& option, the delivery is into two
21749 new files in  &"mailstore"& format. The option is available only if
21750 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21751 below for further details.
21752
21753
21754 .option mailstore_prefix appendfile string&!! unset
21755 This option applies only to deliveries in mailstore format, and is described in
21756 section &<<SECTopdir>>& below.
21757
21758
21759 .option mailstore_suffix appendfile string&!! unset
21760 This option applies only to deliveries in mailstore format, and is described in
21761 section &<<SECTopdir>>& below.
21762
21763
21764 .option mbx_format appendfile boolean false
21765 .cindex "locking files"
21766 .cindex "file" "locking"
21767 .cindex "file" "MBX format"
21768 .cindex "MBX format, specifying"
21769 This option is available only if Exim has been compiled with SUPPORT_MBX
21770 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21771 the message is appended to the mailbox file in MBX format instead of
21772 traditional Unix format. This format is supported by Pine4 and its associated
21773 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21774
21775 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21776 automatically changed by the use of &%mbx_format%&. They should normally be set
21777 empty when using MBX format, so this option almost always appears in this
21778 combination:
21779 .code
21780 mbx_format = true
21781 message_prefix =
21782 message_suffix =
21783 .endd
21784 If none of the locking options are mentioned in the configuration,
21785 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21786 is possible to specify the other kinds of locking with &%mbx_format%&, but
21787 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21788 interworks with &'c-client'&, providing for shared access to the mailbox. It
21789 should not be used if any program that does not use this form of locking is
21790 going to access the mailbox, nor should it be used if the mailbox file is NFS
21791 mounted, because it works only when the mailbox is accessed from a single host.
21792
21793 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21794 the standard version of &'c-client'&, because as long as it has a mailbox open
21795 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21796 append messages to it.
21797
21798
21799 .option message_prefix appendfile string&!! "see below"
21800 .cindex "&""From""& line"
21801 The string specified here is expanded and output at the start of every message.
21802 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21803 in which case it is:
21804 .code
21805 message_prefix = "From ${if def:return_path{$return_path}\
21806   {MAILER-DAEMON}} $tod_bsdinbox\n"
21807 .endd
21808 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21809 &`\n`& to &`\r\n`& in &%message_prefix%&.
21810
21811 .option message_suffix appendfile string&!! "see below"
21812 The string specified here is expanded and output at the end of every message.
21813 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21814 in which case it is a single newline character. The suffix can be suppressed by
21815 setting
21816 .code
21817 message_suffix =
21818 .endd
21819 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21820 &`\n`& to &`\r\n`& in &%message_suffix%&.
21821
21822 .option mode appendfile "octal integer" 0600
21823 If the output file is created, it is given this mode. If it already exists and
21824 has wider permissions, they are reduced to this mode. If it has narrower
21825 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21826 if the delivery is the result of a &%save%& command in a filter file specifying
21827 a particular mode, the mode of the output file is always forced to take that
21828 value, and this option is ignored.
21829
21830
21831 .option mode_fail_narrower appendfile boolean true
21832 This option applies in the case when an existing mailbox file has a narrower
21833 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21834 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21835 continues with the delivery attempt, using the existing mode of the file.
21836
21837
21838 .option notify_comsat appendfile boolean false
21839 If this option is true, the &'comsat'& daemon is notified after every
21840 successful delivery to a user mailbox. This is the daemon that notifies logged
21841 on users about incoming mail.
21842
21843
21844 .option quota appendfile string&!! unset
21845 .cindex "quota" "imposed by Exim"
21846 This option imposes a limit on the size of the file to which Exim is appending,
21847 or to the total space used in the directory tree when the &%directory%& option
21848 is set. In the latter case, computation of the space used is expensive, because
21849 all the files in the directory (and any sub-directories) have to be
21850 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21851 &%maildir_use_size_file%& for ways to avoid this in environments where users
21852 have no shell access to their mailboxes).
21853
21854 As there is no interlock against two simultaneous deliveries into a
21855 multi-file mailbox, it is possible for the quota to be overrun in this case.
21856 For single-file mailboxes, of course, an interlock is a necessity.
21857
21858 A file's size is taken as its &'used'& value. Because of blocking effects, this
21859 may be a lot less than the actual amount of disk space allocated to the file.
21860 If the sizes of a number of files are being added up, the rounding effect can
21861 become quite noticeable, especially on systems that have large block sizes.
21862 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21863 the obvious value which users understand most easily.
21864
21865 The value of the option is expanded, and must then be a numerical value
21866 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21867 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21868 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21869 be handled.
21870
21871 &*Note*&: A value of zero is interpreted as &"no quota"&.
21872
21873 The expansion happens while Exim is running as root, before it changes uid for
21874 the delivery. This means that files that are inaccessible to the end user can
21875 be used to hold quota values that are looked up in the expansion. When delivery
21876 fails because this quota is exceeded, the handling of the error is as for
21877 system quota failures.
21878
21879 By default, Exim's quota checking mimics system quotas, and restricts the
21880 mailbox to the specified maximum size, though the value is not accurate to the
21881 last byte, owing to separator lines and additional headers that may get added
21882 during message delivery. When a mailbox is nearly full, large messages may get
21883 refused even though small ones are accepted, because the size of the current
21884 message is added to the quota when the check is made. This behaviour can be
21885 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21886 for exceeding the quota does not include the current message. Thus, deliveries
21887 continue until the quota has been exceeded; thereafter, no further messages are
21888 delivered. See also &%quota_warn_threshold%&.
21889
21890
21891 .option quota_directory appendfile string&!! unset
21892 This option defines the directory to check for quota purposes when delivering
21893 into individual files. The default is the delivery directory, or, if a file
21894 called &_maildirfolder_& exists in a maildir directory, the parent of the
21895 delivery directory.
21896
21897
21898 .option quota_filecount appendfile string&!! 0
21899 This option applies when the &%directory%& option is set. It limits the total
21900 number of files in the directory (compare the inode limit in system quotas). It
21901 can only be used if &%quota%& is also set. The value is expanded; an expansion
21902 failure causes delivery to be deferred. A value of zero is interpreted as
21903 &"no quota"&.
21904
21905
21906 .option quota_is_inclusive appendfile boolean true
21907 See &%quota%& above.
21908
21909
21910 .option quota_size_regex appendfile string unset
21911 This option applies when one of the delivery modes that writes a separate file
21912 for each message is being used. When Exim wants to find the size of one of
21913 these files in order to test the quota, it first checks &%quota_size_regex%&.
21914 If this is set to a regular expression that matches the file name, and it
21915 captures one string, that string is interpreted as a representation of the
21916 file's size. The value of &%quota_size_regex%& is not expanded.
21917
21918 This feature is useful only when users have no shell access to their mailboxes
21919 &-- otherwise they could defeat the quota simply by renaming the files. This
21920 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21921 the file length to the file name. For example:
21922 .code
21923 maildir_tag = ,S=$message_size
21924 quota_size_regex = ,S=(\d+)
21925 .endd
21926 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21927 number of lines in the message.
21928
21929 The regular expression should not assume that the length is at the end of the
21930 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21931 sometimes add other information onto the ends of message file names.
21932
21933 Section &<<SECID136>>& contains further information.
21934
21935
21936 .option quota_warn_message appendfile string&!! "see below"
21937 See below for the use of this option. If it is not set when
21938 &%quota_warn_threshold%& is set, it defaults to
21939 .code
21940 quota_warn_message = "\
21941   To: $local_part@$domain\n\
21942   Subject: Your mailbox\n\n\
21943   This message is automatically created \
21944   by mail delivery software.\n\n\
21945   The size of your mailbox has exceeded \
21946   a warning threshold that is\n\
21947   set by the system administrator.\n"
21948 .endd
21949
21950
21951 .option quota_warn_threshold appendfile string&!! 0
21952 .cindex "quota" "warning threshold"
21953 .cindex "mailbox" "size warning"
21954 .cindex "size" "of mailbox"
21955 This option is expanded in the same way as &%quota%& (see above). If the
21956 resulting value is greater than zero, and delivery of the message causes the
21957 size of the file or total space in the directory tree to cross the given
21958 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21959 may be specified as a percentage of it by following the value with a percent
21960 sign. For example:
21961 .code
21962 quota = 10M
21963 quota_warn_threshold = 75%
21964 .endd
21965 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21966 percent sign is ignored.
21967
21968 The warning message itself is specified by the &%quota_warn_message%& option,
21969 and it must start with a &'To:'& header line containing the recipient(s) of the
21970 warning message. These do not necessarily have to include the recipient(s) of
21971 the original message. A &'Subject:'& line should also normally be supplied. You
21972 can include any other header lines that you want. If you do not include a
21973 &'From:'& line, the default is:
21974 .code
21975 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21976 .endd
21977 .oindex &%errors_reply_to%&
21978 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21979 option.
21980
21981 The &%quota%& option does not have to be set in order to use this option; they
21982 are independent of one another except when the threshold is specified as a
21983 percentage.
21984
21985
21986 .option use_bsmtp appendfile boolean false
21987 .cindex "envelope sender"
21988 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21989 format, with the envelope sender and recipient(s) included as SMTP commands. If
21990 you want to include a leading HELO command with such messages, you can do
21991 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21992 for details of batch SMTP.
21993
21994
21995 .option use_crlf appendfile boolean false
21996 .cindex "carriage return"
21997 .cindex "linefeed"
21998 This option causes lines to be terminated with the two-character CRLF sequence
21999 (carriage return, linefeed) instead of just a linefeed character. In the case
22000 of batched SMTP, the byte sequence written to the file is then an exact image
22001 of what would be sent down a real SMTP connection.
22002
22003 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22004 (which are used to supply the traditional &"From&~"& and blank line separators
22005 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22006 carriage return characters if these are needed. In cases where these options
22007 have non-empty defaults, the values end with a single linefeed, so they must be
22008 changed to end with &`\r\n`& if &%use_crlf%& is set.
22009
22010
22011 .option use_fcntl_lock appendfile boolean "see below"
22012 This option controls the use of the &[fcntl()]& function to lock a file for
22013 exclusive use when a message is being appended. It is set by default unless
22014 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22015 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22016 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22017
22018
22019 .option use_flock_lock appendfile boolean false
22020 This option is provided to support the use of &[flock()]& for file locking, for
22021 the few situations where it is needed. Most modern operating systems support
22022 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22023 each other. Exim uses &[fcntl()]& locking by default.
22024
22025 This option is required only if you are using an operating system where
22026 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22027 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22028 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22029
22030 .cindex "Solaris" "&[flock()]& support"
22031 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22032 have it (and some, I think, provide a not quite right version built on top of
22033 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22034 the ability to use it, and any attempt to do so will cause a configuration
22035 error.
22036
22037 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22038 is just being mapped onto &[fcntl()]& by the OS).
22039
22040
22041 .option use_lockfile appendfile boolean "see below"
22042 If this option is turned off, Exim does not attempt to create a lock file when
22043 appending to a mailbox file. In this situation, the only locking is by
22044 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22045 sure that every MUA that is ever going to look at your users' mailboxes uses
22046 &[fcntl()]& rather than a lock file, and even then only when you are not
22047 delivering over NFS from more than one host.
22048
22049 .cindex "NFS" "lock file"
22050 In order to append to an NFS file safely from more than one host, it is
22051 necessary to take out a lock &'before'& opening the file, and the lock file
22052 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22053 file corruption.
22054
22055 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22056 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22057 except when &%mbx_format%& is set.
22058
22059
22060 .option use_mbx_lock appendfile boolean "see below"
22061 This option is available only if Exim has been compiled with SUPPORT_MBX
22062 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22063 locking rules be used. It is set by default if &%mbx_format%& is set and none
22064 of the locking options are mentioned in the configuration. The locking rules
22065 are the same as are used by the &'c-client'& library that underlies Pine and
22066 the IMAP4 and POP daemons that come with it (see the discussion below). The
22067 rules allow for shared access to the mailbox. However, this kind of locking
22068 does not work when the mailbox is NFS mounted.
22069
22070 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22071 &%use_flock_lock%& to control what kind of locking is used in implementing the
22072 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22073 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22074
22075
22076
22077
22078 .section "Operational details for appending" "SECTopappend"
22079 .cindex "appending to a file"
22080 .cindex "file" "appending"
22081 Before appending to a file, the following preparations are made:
22082
22083 .ilist
22084 If the name of the file is &_/dev/null_&, no action is taken, and a success
22085 return is given.
22086
22087 .next
22088 .cindex "directory creation"
22089 If any directories on the file's path are missing, Exim creates them if the
22090 &%create_directory%& option is set. A created directory's mode is given by the
22091 &%directory_mode%& option.
22092
22093 .next
22094 If &%file_format%& is set, the format of an existing file is checked. If this
22095 indicates that a different transport should be used, control is passed to that
22096 transport.
22097
22098 .next
22099 .cindex "file" "locking"
22100 .cindex "locking files"
22101 .cindex "NFS" "lock file"
22102 If &%use_lockfile%& is set, a lock file is built in a way that will work
22103 reliably over NFS, as follows:
22104
22105 .olist
22106 Create a &"hitching post"& file whose name is that of the lock file with the
22107 current time, primary host name, and process id added, by opening for writing
22108 as a new file. If this fails with an access error, delivery is deferred.
22109 .next
22110 Close the hitching post file, and hard link it to the lock file name.
22111 .next
22112 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22113 Unlink the hitching post name.
22114 .next
22115 Otherwise, use &[stat()]& to get information about the hitching post file, and
22116 then unlink hitching post name. If the number of links is exactly two, creation
22117 of the lock file succeeded but something (for example, an NFS server crash and
22118 restart) caused this fact not to be communicated to the &[link()]& call.
22119 .next
22120 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22121 up to &%lock_retries%& times. However, since any program that writes to a
22122 mailbox should complete its task very quickly, it is reasonable to time out old
22123 lock files that are normally the result of user agent and system crashes. If an
22124 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22125 it before trying again.
22126 .endlist olist
22127
22128 .next
22129 A call is made to &[lstat()]& to discover whether the main file exists, and if
22130 so, what its characteristics are. If &[lstat()]& fails for any reason other
22131 than non-existence, delivery is deferred.
22132
22133 .next
22134 .cindex "symbolic link" "to mailbox"
22135 .cindex "mailbox" "symbolic link"
22136 If the file does exist and is a symbolic link, delivery is deferred, unless the
22137 &%allow_symlink%& option is set, in which case the ownership of the link is
22138 checked, and then &[stat()]& is called to find out about the real file, which
22139 is then subjected to the checks below. The check on the top-level link
22140 ownership prevents one user creating a link for another's mailbox in a sticky
22141 directory, though allowing symbolic links in this case is definitely not a good
22142 idea. If there is a chain of symbolic links, the intermediate ones are not
22143 checked.
22144
22145 .next
22146 If the file already exists but is not a regular file, or if the file's owner
22147 and group (if the group is being checked &-- see &%check_group%& above) are
22148 different from the user and group under which the delivery is running,
22149 delivery is deferred.
22150
22151 .next
22152 If the file's permissions are more generous than specified, they are reduced.
22153 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22154 is set false, in which case the delivery is tried using the existing
22155 permissions.
22156
22157 .next
22158 The file's inode number is saved, and the file is then opened for appending.
22159 If this fails because the file has vanished, &(appendfile)& behaves as if it
22160 hadn't existed (see below). For any other failures, delivery is deferred.
22161
22162 .next
22163 If the file is opened successfully, check that the inode number hasn't
22164 changed, that it is still a regular file, and that the owner and permissions
22165 have not changed. If anything is wrong, defer delivery and freeze the message.
22166
22167 .next
22168 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22169 option is set. Otherwise, check that the file is being created in a permitted
22170 directory if the &%create_file%& option is set (deferring on failure), and then
22171 open for writing as a new file, with the O_EXCL and O_CREAT options,
22172 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22173 set). In this case, which can happen if the link points to a non-existent file,
22174 the file is opened for writing using O_CREAT but not O_EXCL, because
22175 that prevents link following.
22176
22177 .next
22178 .cindex "loop" "while file testing"
22179 If opening fails because the file exists, obey the tests given above for
22180 existing files. However, to avoid looping in a situation where the file is
22181 being continuously created and destroyed, the exists/not-exists loop is broken
22182 after 10 repetitions, and the message is then frozen.
22183
22184 .next
22185 If opening fails with any other error, defer delivery.
22186
22187 .next
22188 .cindex "file" "locking"
22189 .cindex "locking files"
22190 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22191 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22192 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22193 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22194 file, and an exclusive lock on the file whose name is
22195 .code
22196 /tmp/.<device-number>.<inode-number>
22197 .endd
22198 using the device and inode numbers of the open mailbox file, in accordance with
22199 the MBX locking rules. This file is created with a mode that is specified by
22200 the &%lockfile_mode%& option.
22201
22202 If Exim fails to lock the file, there are two possible courses of action,
22203 depending on the value of the locking timeout. This is obtained from
22204 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22205
22206 If the timeout value is zero, the file is closed, Exim waits for
22207 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22208 to lock it again. This happens up to &%lock_retries%& times, after which the
22209 delivery is deferred.
22210
22211 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22212 &[flock()]& are used (with the given timeout), so there has already been some
22213 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22214 immediately. It retries up to
22215 .code
22216 (lock_retries * lock_interval) / <timeout>
22217 .endd
22218 times (rounded up).
22219 .endlist
22220
22221 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22222 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22223
22224
22225 .section "Operational details for delivery to a new file" "SECTopdir"
22226 .cindex "delivery" "to single file"
22227 .cindex "&""From""& line"
22228 When the &%directory%& option is set instead of &%file%&, each message is
22229 delivered into a newly-created file or set of files. When &(appendfile)& is
22230 activated directly from a &(redirect)& router, neither &%file%& nor
22231 &%directory%& is normally set, because the path for delivery is supplied by the
22232 router. (See for example, the &(address_file)& transport in the default
22233 configuration.) In this case, delivery is to a new file if either the path name
22234 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22235
22236 No locking is required while writing the message to a new file, so the various
22237 locking options of the transport are ignored. The &"From"& line that by default
22238 separates messages in a single file is not normally needed, nor is the escaping
22239 of message lines that start with &"From"&, and there is no need to ensure a
22240 newline at the end of each message. Consequently, the default values for
22241 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22242 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22243
22244 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22245 the files in the delivery directory by default. However, you can specify a
22246 different directory by setting &%quota_directory%&. Also, for maildir
22247 deliveries (see below) the &_maildirfolder_& convention is honoured.
22248
22249
22250 .cindex "maildir format"
22251 .cindex "mailstore format"
22252 There are three different ways in which delivery to individual files can be
22253 done, controlled by the settings of the &%maildir_format%& and
22254 &%mailstore_format%& options. Note that code to support maildir or mailstore
22255 formats is not included in the binary unless SUPPORT_MAILDIR or
22256 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22257
22258 .cindex "directory creation"
22259 In all three cases an attempt is made to create the directory and any necessary
22260 sub-directories if they do not exist, provided that the &%create_directory%&
22261 option is set (the default). The location of a created directory can be
22262 constrained by setting &%create_file%&. A created directory's mode is given by
22263 the &%directory_mode%& option. If creation fails, or if the
22264 &%create_directory%& option is not set when creation is required, delivery is
22265 deferred.
22266
22267
22268
22269 .section "Maildir delivery" "SECTmaildirdelivery"
22270 .cindex "maildir format" "description of"
22271 If the &%maildir_format%& option is true, Exim delivers each message by writing
22272 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22273 directory that is defined by the &%directory%& option (the &"delivery
22274 directory"&). If the delivery is successful, the file is renamed into the
22275 &_new_& subdirectory.
22276
22277 In the file name, <&'stime'&> is the current time of day in seconds, and
22278 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22279 Exim checks that the time-of-day clock has moved on by at least one microsecond
22280 before terminating the delivery process. This guarantees uniqueness for the
22281 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22282 opening it. If any response other than ENOENT (does not exist) is given,
22283 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22284
22285 Before Exim carries out a maildir delivery, it ensures that subdirectories
22286 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22287 do not exist, Exim tries to create them and any superior directories in their
22288 path, subject to the &%create_directory%& and &%create_file%& options. If the
22289 &%maildirfolder_create_regex%& option is set, and the regular expression it
22290 contains matches the delivery directory, Exim also ensures that a file called
22291 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22292 &_maildirfolder_& file cannot be created, delivery is deferred.
22293
22294 These features make it possible to use Exim to create all the necessary files
22295 and directories in a maildir mailbox, including subdirectories for maildir++
22296 folders. Consider this example:
22297 .code
22298 maildir_format = true
22299 directory = /var/mail/$local_part\
22300            ${if eq{$local_part_suffix}{}{}\
22301            {/.${substr_1:$local_part_suffix}}}
22302 maildirfolder_create_regex = /\.[^/]+$
22303 .endd
22304 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22305 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22306 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22307 not match this name, so Exim will not look for or create the file
22308 &_/var/mail/pimbo/maildirfolder_&, though it will create
22309 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22310
22311 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22312 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22313 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22314 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22315 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22316
22317 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22318 not inadvertently match the toplevel maildir directory, because a
22319 &_maildirfolder_& file at top level would completely break quota calculations.
22320
22321 .cindex "quota" "in maildir delivery"
22322 .cindex "maildir++"
22323 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22324 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22325 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22326 Exim assumes the directory is a maildir++ folder directory, which is one level
22327 down from the user's top level mailbox directory. This causes it to start at
22328 the parent directory instead of the current directory when calculating the
22329 amount of space used.
22330
22331 One problem with delivering into a multi-file mailbox is that it is
22332 computationally expensive to compute the size of the mailbox for quota
22333 checking. Various approaches have been taken to reduce the amount of work
22334 needed. The next two sections describe two of them. A third alternative is to
22335 use some external process for maintaining the size data, and use the expansion
22336 of the &%mailbox_size%& option as a way of importing it into Exim.
22337
22338
22339
22340
22341 .section "Using tags to record message sizes" "SECID135"
22342 If &%maildir_tag%& is set, the string is expanded for each delivery.
22343 When the maildir file is renamed into the &_new_& sub-directory, the
22344 tag is added to its name. However, if adding the tag takes the length of the
22345 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22346 the tag is dropped and the maildir file is created with no tag.
22347
22348
22349 .vindex "&$message_size$&"
22350 Tags can be used to encode the size of files in their names; see
22351 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22352 happens after the message has been written. The value of the &$message_size$&
22353 variable is set to the number of bytes actually written. If the expansion is
22354 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22355 be deferred. The expanded tag may contain any printing characters except &"/"&.
22356 Non-printing characters in the string are ignored; if the resulting string is
22357 empty, it is ignored. If it starts with an alphanumeric character, a leading
22358 colon is inserted; this default has not proven to be the path that popular
22359 maildir implementations have chosen (but changing it in Exim would break
22360 backwards compatibility).
22361
22362 For one common implementation, you might set:
22363 .code
22364 maildir_tag = ,S=${message_size}
22365 .endd
22366 but you should check the documentation of the other software to be sure.
22367
22368 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22369 as this allows Exim to extract the size from your tag, instead of having to
22370 &[stat()]& each message file.
22371
22372
22373 .section "Using a maildirsize file" "SECID136"
22374 .cindex "quota" "in maildir delivery"
22375 .cindex "maildir format" "&_maildirsize_& file"
22376 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22377 storing quota and message size information in a file called &_maildirsize_&
22378 within the toplevel maildir directory. If this file does not exist, Exim
22379 creates it, setting the quota from the &%quota%& option of the transport. If
22380 the maildir directory itself does not exist, it is created before any attempt
22381 to write a &_maildirsize_& file.
22382
22383 The &_maildirsize_& file is used to hold information about the sizes of
22384 messages in the maildir, thus speeding up quota calculations. The quota value
22385 in the file is just a cache; if the quota is changed in the transport, the new
22386 value overrides the cached value when the next message is delivered. The cache
22387 is maintained for the benefit of other programs that access the maildir and
22388 need to know the quota.
22389
22390 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22391 file is maintained (with a zero quota setting), but no quota is imposed.
22392
22393 A regular expression is available for controlling which directories in the
22394 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22395 See the description of the &%maildir_quota_directory_regex%& option above for
22396 details.
22397
22398
22399 .section "Mailstore delivery" "SECID137"
22400 .cindex "mailstore format" "description of"
22401 If the &%mailstore_format%& option is true, each message is written as two
22402 files in the given directory. A unique base name is constructed from the
22403 message id and the current delivery process, and the files that are written use
22404 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22405 contains the message's envelope, and the &_.msg_& file contains the message
22406 itself. The base name is placed in the variable &$mailstore_basename$&.
22407
22408 During delivery, the envelope is first written to a file with the suffix
22409 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22410 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22411 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22412 file before accessing either of them. An alternative approach is to wait for
22413 the absence of a &_.tmp_& file.
22414
22415 The envelope file starts with any text defined by the &%mailstore_prefix%&
22416 option, expanded and terminated by a newline if there isn't one. Then follows
22417 the sender address on one line, then all the recipient addresses, one per line.
22418 There can be more than one recipient only if the &%batch_max%& option is set
22419 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22420 appended to the file, followed by a newline if it does not end with one.
22421
22422 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22423 failure, it is ignored. Other expansion errors are treated as serious
22424 configuration errors, and delivery is deferred. The variable
22425 &$mailstore_basename$& is available for use during these expansions.
22426
22427
22428 .section "Non-special new file delivery" "SECID138"
22429 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22430 file is created directly in the named directory. For example, when delivering
22431 messages into files in batched SMTP format for later delivery to some host (see
22432 section &<<SECTbatchSMTP>>&), a setting such as
22433 .code
22434 directory = /var/bsmtp/$host
22435 .endd
22436 might be used. A message is written to a file with a temporary name, which is
22437 then renamed when the delivery is complete. The final name is obtained by
22438 expanding the contents of the &%directory_file%& option.
22439 .ecindex IIDapptra1
22440 .ecindex IIDapptra2
22441
22442
22443
22444
22445
22446
22447 . ////////////////////////////////////////////////////////////////////////////
22448 . ////////////////////////////////////////////////////////////////////////////
22449
22450 .chapter "The autoreply transport" "CHID8"
22451 .scindex IIDauttra1 "transports" "&(autoreply)&"
22452 .scindex IIDauttra2 "&(autoreply)& transport"
22453 The &(autoreply)& transport is not a true transport in that it does not cause
22454 the message to be transmitted. Instead, it generates a new mail message as an
22455 automatic reply to the incoming message. &'References:'& and
22456 &'Auto-Submitted:'& header lines are included. These are constructed according
22457 to the rules in RFCs 2822 and 3834, respectively.
22458
22459 If the router that passes the message to this transport does not have the
22460 &%unseen%& option set, the original message (for the current recipient) is not
22461 delivered anywhere. However, when the &%unseen%& option is set on the router
22462 that passes the message to this transport, routing of the address continues, so
22463 another router can set up a normal message delivery.
22464
22465
22466 The &(autoreply)& transport is usually run as the result of mail filtering, a
22467 &"vacation"& message being the standard example. However, it can also be run
22468 directly from a router like any other transport. To reduce the possibility of
22469 message cascades, messages created by the &(autoreply)& transport always have
22470 empty envelope sender addresses, like bounce messages.
22471
22472 The parameters of the message to be sent can be specified in the configuration
22473 by options described below. However, these are used only when the address
22474 passed to the transport does not contain its own reply information. When the
22475 transport is run as a consequence of a
22476 &%mail%&
22477 or &%vacation%& command in a filter file, the parameters of the message are
22478 supplied by the filter, and passed with the address. The transport's options
22479 that define the message are then ignored (so they are not usually set in this
22480 case). The message is specified entirely by the filter or by the transport; it
22481 is never built from a mixture of options. However, the &%file_optional%&,
22482 &%mode%&, and &%return_message%& options apply in all cases.
22483
22484 &(Autoreply)& is implemented as a local transport. When used as a result of a
22485 command in a user's filter file, &(autoreply)& normally runs under the uid and
22486 gid of the user, and with appropriate current and home directories (see chapter
22487 &<<CHAPenvironment>>&).
22488
22489 There is a subtle difference between routing a message to a &(pipe)& transport
22490 that generates some text to be returned to the sender, and routing it to an
22491 &(autoreply)& transport. This difference is noticeable only if more than one
22492 address from the same message is so handled. In the case of a pipe, the
22493 separate outputs from the different addresses are gathered up and returned to
22494 the sender in a single message, whereas if &(autoreply)& is used, a separate
22495 message is generated for each address that is passed to it.
22496
22497 Non-printing characters are not permitted in the header lines generated for the
22498 message that &(autoreply)& creates, with the exception of newlines that are
22499 immediately followed by white space. If any non-printing characters are found,
22500 the transport defers.
22501 Whether characters with the top bit set count as printing characters or not is
22502 controlled by the &%print_topbitchars%& global option.
22503
22504 If any of the generic options for manipulating headers (for example,
22505 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22506 of the original message that is included in the generated message when
22507 &%return_message%& is set. They do not apply to the generated message itself.
22508
22509 .vindex "&$sender_address$&"
22510 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22511 the message, indicating that there were no recipients, it does not treat this
22512 as an error. This means that autoreplies sent to &$sender_address$& when this
22513 is empty (because the incoming message is a bounce message) do not cause
22514 problems. They are just discarded.
22515
22516
22517
22518 .section "Private options for autoreply" "SECID139"
22519 .cindex "options" "&(autoreply)& transport"
22520
22521 .option bcc autoreply string&!! unset
22522 This specifies the addresses that are to receive &"blind carbon copies"& of the
22523 message when the message is specified by the transport.
22524
22525
22526 .option cc autoreply string&!! unset
22527 This specifies recipients of the message and the contents of the &'Cc:'& header
22528 when the message is specified by the transport.
22529
22530
22531 .option file autoreply string&!! unset
22532 The contents of the file are sent as the body of the message when the message
22533 is specified by the transport. If both &%file%& and &%text%& are set, the text
22534 string comes first.
22535
22536
22537 .option file_expand autoreply boolean false
22538 If this is set, the contents of the file named by the &%file%& option are
22539 subjected to string expansion as they are added to the message.
22540
22541
22542 .option file_optional autoreply boolean false
22543 If this option is true, no error is generated if the file named by the &%file%&
22544 option or passed with the address does not exist or cannot be read.
22545
22546
22547 .option from autoreply string&!! unset
22548 This specifies the contents of the &'From:'& header when the message is
22549 specified by the transport.
22550
22551
22552 .option headers autoreply string&!! unset
22553 This specifies additional RFC 2822 headers that are to be added to the message
22554 when the message is specified by the transport. Several can be given by using
22555 &"\n"& to separate them. There is no check on the format.
22556
22557
22558 .option log autoreply string&!! unset
22559 This option names a file in which a record of every message sent is logged when
22560 the message is specified by the transport.
22561
22562
22563 .option mode autoreply "octal integer" 0600
22564 If either the log file or the &"once"& file has to be created, this mode is
22565 used.
22566
22567
22568 .option never_mail autoreply "address list&!!" unset
22569 If any run of the transport creates a message with a recipient that matches any
22570 item in the list, that recipient is quietly discarded. If all recipients are
22571 discarded, no message is created. This applies both when the recipients are
22572 generated by a filter and when they are specified in the transport.
22573
22574
22575
22576 .option once autoreply string&!! unset
22577 This option names a file or DBM database in which a record of each &'To:'&
22578 recipient is kept when the message is specified by the transport. &*Note*&:
22579 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22580
22581 If &%once%& is unset, or is set to an empty string, the message is always sent.
22582 By default, if &%once%& is set to a non-empty file name, the message
22583 is not sent if a potential recipient is already listed in the database.
22584 However, if the &%once_repeat%& option specifies a time greater than zero, the
22585 message is sent if that much time has elapsed since a message was last sent to
22586 this recipient. A setting of zero time for &%once_repeat%& (the default)
22587 prevents a message from being sent a second time &-- in this case, zero means
22588 infinity.
22589
22590 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22591 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22592 greater than zero, it changes the way Exim implements the &%once%& option.
22593 Instead of using a DBM file to record every recipient it sends to, it uses a
22594 regular file, whose size will never get larger than the given value.
22595
22596 In the file, Exim keeps a linear list of recipient addresses and the times at
22597 which they were sent messages. If the file is full when a new address needs to
22598 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22599 means that a given recipient may receive multiple messages, but at
22600 unpredictable intervals that depend on the rate of turnover of addresses in the
22601 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22602
22603
22604 .option once_file_size autoreply integer 0
22605 See &%once%& above.
22606
22607
22608 .option once_repeat autoreply time&!! 0s
22609 See &%once%& above.
22610 After expansion, the value of this option must be a valid time value.
22611
22612
22613 .option reply_to autoreply string&!! unset
22614 This specifies the contents of the &'Reply-To:'& header when the message is
22615 specified by the transport.
22616
22617
22618 .option return_message autoreply boolean false
22619 If this is set, a copy of the original message is returned with the new
22620 message, subject to the maximum size set in the &%return_size_limit%& global
22621 configuration option.
22622
22623
22624 .option subject autoreply string&!! unset
22625 This specifies the contents of the &'Subject:'& header when the message is
22626 specified by the transport. It is tempting to quote the original subject in
22627 automatic responses. For example:
22628 .code
22629 subject = Re: $h_subject:
22630 .endd
22631 There is a danger in doing this, however. It may allow a third party to
22632 subscribe your users to an opt-in mailing list, provided that the list accepts
22633 bounce messages as subscription confirmations. Well-managed lists require a
22634 non-bounce message to confirm a subscription, so the danger is relatively
22635 small.
22636
22637
22638
22639 .option text autoreply string&!! unset
22640 This specifies a single string to be used as the body of the message when the
22641 message is specified by the transport. If both &%text%& and &%file%& are set,
22642 the text comes first.
22643
22644
22645 .option to autoreply string&!! unset
22646 This specifies recipients of the message and the contents of the &'To:'& header
22647 when the message is specified by the transport.
22648 .ecindex IIDauttra1
22649 .ecindex IIDauttra2
22650
22651
22652
22653
22654 . ////////////////////////////////////////////////////////////////////////////
22655 . ////////////////////////////////////////////////////////////////////////////
22656
22657 .chapter "The lmtp transport" "CHAPLMTP"
22658 .cindex "transports" "&(lmtp)&"
22659 .cindex "&(lmtp)& transport"
22660 .cindex "LMTP" "over a pipe"
22661 .cindex "LMTP" "over a socket"
22662 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22663 specified command
22664 or by interacting with a Unix domain socket.
22665 This transport is something of a cross between the &(pipe)& and &(smtp)&
22666 transports. Exim also has support for using LMTP over TCP/IP; this is
22667 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22668 to be of minority interest, the default build-time configure in &_src/EDITME_&
22669 has it commented out. You need to ensure that
22670 .code
22671 TRANSPORT_LMTP=yes
22672 .endd
22673 .cindex "options" "&(lmtp)& transport"
22674 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22675 included in the Exim binary. The private options of the &(lmtp)& transport are
22676 as follows:
22677
22678 .option batch_id lmtp string&!! unset
22679 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22680
22681
22682 .option batch_max lmtp integer 1
22683 This limits the number of addresses that can be handled in a single delivery.
22684 Most LMTP servers can handle several addresses at once, so it is normally a
22685 good idea to increase this value. See the description of local delivery
22686 batching in chapter &<<CHAPbatching>>&.
22687
22688
22689 .option command lmtp string&!! unset
22690 This option must be set if &%socket%& is not set. The string is a command which
22691 is run in a separate process. It is split up into a command name and list of
22692 arguments, each of which is separately expanded (so expansion cannot change the
22693 number of arguments). The command is run directly, not via a shell. The message
22694 is passed to the new process using the standard input and output to operate the
22695 LMTP protocol.
22696
22697 .option ignore_quota lmtp boolean false
22698 .cindex "LMTP" "ignoring quota errors"
22699 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22700 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22701 in its response to the LHLO command.
22702
22703 .option socket lmtp string&!! unset
22704 This option must be set if &%command%& is not set. The result of expansion must
22705 be the name of a Unix domain socket. The transport connects to the socket and
22706 delivers the message to it using the LMTP protocol.
22707
22708
22709 .option timeout lmtp time 5m
22710 The transport is aborted if the created process or Unix domain socket does not
22711 respond to LMTP commands or message input within this timeout. Delivery
22712 is deferred, and will be tried again later. Here is an example of a typical
22713 LMTP transport:
22714 .code
22715 lmtp:
22716   driver = lmtp
22717   command = /some/local/lmtp/delivery/program
22718   batch_max = 20
22719   user = exim
22720 .endd
22721 This delivers up to 20 addresses at a time, in a mixture of domains if
22722 necessary, running as the user &'exim'&.
22723
22724
22725
22726 . ////////////////////////////////////////////////////////////////////////////
22727 . ////////////////////////////////////////////////////////////////////////////
22728
22729 .chapter "The pipe transport" "CHAPpipetransport"
22730 .scindex IIDpiptra1 "transports" "&(pipe)&"
22731 .scindex IIDpiptra2 "&(pipe)& transport"
22732 The &(pipe)& transport is used to deliver messages via a pipe to a command
22733 running in another process. One example is the use of &(pipe)& as a
22734 pseudo-remote transport for passing messages to some other delivery mechanism
22735 (such as UUCP). Another is the use by individual users to automatically process
22736 their incoming messages. The &(pipe)& transport can be used in one of the
22737 following ways:
22738
22739 .ilist
22740 .vindex "&$local_part$&"
22741 A router routes one address to a transport in the normal way, and the
22742 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22743 contains the local part of the address (as usual), and the command that is run
22744 is specified by the &%command%& option on the transport.
22745 .next
22746 .vindex "&$pipe_addresses$&"
22747 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22748 transport can handle more than one address in a single run. In this case, when
22749 more than one address is routed to the transport, &$local_part$& is not set
22750 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22751 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22752 that are routed to the transport.
22753 .next
22754 .vindex "&$address_pipe$&"
22755 A router redirects an address directly to a pipe command (for example, from an
22756 alias or forward file). In this case, &$address_pipe$& contains the text of the
22757 pipe command, and the &%command%& option on the transport is ignored unless
22758 &%force_command%& is set. If only one address is being transported
22759 (&%batch_max%& is not greater than one, or only one address was redirected to
22760 this pipe command), &$local_part$& contains the local part that was redirected.
22761 .endlist
22762
22763
22764 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22765 deliver messages over pipes using the LMTP interactive protocol. This is
22766 implemented by the &(lmtp)& transport.
22767
22768 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22769 &_.forward_& file, the command runs under the uid and gid of that user. In
22770 other cases, the uid and gid have to be specified explicitly, either on the
22771 transport or on the router that handles the address. Current and &"home"&
22772 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22773 details of the local delivery environment and chapter &<<CHAPbatching>>&
22774 for a discussion of local delivery batching.
22775
22776
22777 .section "Concurrent delivery" "SECID140"
22778 If two messages arrive at almost the same time, and both are routed to a pipe
22779 delivery, the two pipe transports may be run concurrently. You must ensure that
22780 any pipe commands you set up are robust against this happening. If the commands
22781 write to a file, the &%exim_lock%& utility might be of use.
22782 .new
22783 Alternatively the &%max_parallel%& option could be used with a value
22784 of "1" to enforce serialization.
22785 .wen
22786
22787
22788
22789
22790 .section "Returned status and data" "SECID141"
22791 .cindex "&(pipe)& transport" "returned data"
22792 If the command exits with a non-zero return code, the delivery is deemed to
22793 have failed, unless either the &%ignore_status%& option is set (in which case
22794 the return code is treated as zero), or the return code is one of those listed
22795 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22796 later"&. In this case, delivery is deferred. Details of a permanent failure are
22797 logged, but are not included in the bounce message, which merely contains
22798 &"local delivery failed"&.
22799
22800 If the command exits on a signal and the &%freeze_signal%& option is set then
22801 the message will be frozen in the queue. If that option is not set, a bounce
22802 will be sent as normal.
22803
22804 If the return code is greater than 128 and the command being run is a shell
22805 script, it normally means that the script was terminated by a signal whose
22806 value is the return code minus 128. The &%freeze_signal%& option does not
22807 apply in this case.
22808
22809 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22810 return code is set to 127. This is the value that a shell returns if it is
22811 asked to run a non-existent command. The wording for the log line suggests that
22812 a non-existent command may be the problem.
22813
22814 The &%return_output%& option can affect the result of a pipe delivery. If it is
22815 set and the command produces any output on its standard output or standard
22816 error streams, the command is considered to have failed, even if it gave a zero
22817 return code or if &%ignore_status%& is set. The output from the command is
22818 included as part of the bounce message. The &%return_fail_output%& option is
22819 similar, except that output is returned only when the command exits with a
22820 failure return code, that is, a value other than zero or a code that matches
22821 &%temp_errors%&.
22822
22823
22824
22825 .section "How the command is run" "SECThowcommandrun"
22826 .cindex "&(pipe)& transport" "path for command"
22827 The command line is (by default) broken down into a command name and arguments
22828 by the &(pipe)& transport itself. The &%allow_commands%& and
22829 &%restrict_to_path%& options can be used to restrict the commands that may be
22830 run.
22831
22832 .cindex "quoting" "in pipe command"
22833 Unquoted arguments are delimited by white space. If an argument appears in
22834 double quotes, backslash is interpreted as an escape character in the usual
22835 way. If an argument appears in single quotes, no escaping is done.
22836
22837 String expansion is applied to the command line except when it comes from a
22838 traditional &_.forward_& file (commands from a filter file are expanded). The
22839 expansion is applied to each argument in turn rather than to the whole line.
22840 For this reason, any string expansion item that contains white space must be
22841 quoted so as to be contained within a single argument. A setting such as
22842 .code
22843 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22844 .endd
22845 will not work, because the expansion item gets split between several
22846 arguments. You have to write
22847 .code
22848 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22849 .endd
22850 to ensure that it is all in one argument. The expansion is done in this way,
22851 argument by argument, so that the number of arguments cannot be changed as a
22852 result of expansion, and quotes or backslashes in inserted variables do not
22853 interact with external quoting. However, this leads to problems if you want to
22854 generate multiple arguments (or the command name plus arguments) from a single
22855 expansion. In this situation, the simplest solution is to use a shell. For
22856 example:
22857 .code
22858 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22859 .endd
22860
22861 .cindex "transport" "filter"
22862 .cindex "filter" "transport filter"
22863 .vindex "&$pipe_addresses$&"
22864 Special handling takes place when an argument consists of precisely the text
22865 &`$pipe_addresses`&. This is not a general expansion variable; the only
22866 place this string is recognized is when it appears as an argument for a pipe or
22867 transport filter command. It causes each address that is being handled to be
22868 inserted in the argument list at that point &'as a separate argument'&. This
22869 avoids any problems with spaces or shell metacharacters, and is of use when a
22870 &(pipe)& transport is handling groups of addresses in a batch.
22871
22872 If &%force_command%& is enabled on the transport, Special handling takes place
22873 for an argument that consists of precisely the text &`$address_pipe`&.  It
22874 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22875 argument is inserted in the argument list at that point
22876 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22877 the only item in the argument; in fact, if it were then &%force_command%&
22878 should behave as a no-op.  Rather, it should be used to adjust the command
22879 run while preserving the argument vector separation.
22880
22881 After splitting up into arguments and expansion, the resulting command is run
22882 in a subprocess directly from the transport, &'not'& under a shell. The
22883 message that is being delivered is supplied on the standard input, and the
22884 standard output and standard error are both connected to a single pipe that is
22885 read by Exim. The &%max_output%& option controls how much output the command
22886 may produce, and the &%return_output%& and &%return_fail_output%& options
22887 control what is done with it.
22888
22889 Not running the command under a shell (by default) lessens the security risks
22890 in cases when a command from a user's filter file is built out of data that was
22891 taken from an incoming message. If a shell is required, it can of course be
22892 explicitly specified as the command to be run. However, there are circumstances
22893 where existing commands (for example, in &_.forward_& files) expect to be run
22894 under a shell and cannot easily be modified. To allow for these cases, there is
22895 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22896 works. Instead of breaking up the command line as just described, it expands it
22897 as a single string and passes the result to &_/bin/sh_&. The
22898 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22899 with &%use_shell%&, and the whole mechanism is inherently less secure.
22900
22901
22902
22903 .section "Environment variables" "SECTpipeenv"
22904 .cindex "&(pipe)& transport" "environment for command"
22905 .cindex "environment for pipe transport"
22906 The environment variables listed below are set up when the command is invoked.
22907 This list is a compromise for maximum compatibility with other MTAs. Note that
22908 the &%environment%& option can be used to add additional variables to this
22909 environment.
22910 .display
22911 &`DOMAIN            `&   the domain of the address
22912 &`HOME              `&   the home directory, if set
22913 &`HOST              `&   the host name when called from a router (see below)
22914 &`LOCAL_PART        `&   see below
22915 &`LOCAL_PART_PREFIX `&   see below
22916 &`LOCAL_PART_SUFFIX `&   see below
22917 &`LOGNAME           `&   see below
22918 &`MESSAGE_ID        `&   Exim's local ID for the message
22919 &`PATH              `&   as specified by the &%path%& option below
22920 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22921 &`RECIPIENT         `&   the complete recipient address
22922 &`SENDER            `&   the sender of the message (empty if a bounce)
22923 &`SHELL             `&   &`/bin/sh`&
22924 &`TZ                `&   the value of the &%timezone%& option, if set
22925 &`USER              `&   see below
22926 .endd
22927 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22928 router, LOCAL_PART is set to the local part of the address. When it is
22929 called as a result of a forward or alias expansion, LOCAL_PART is set to
22930 the local part of the address that was expanded. In both cases, any affixes are
22931 removed from the local part, and made available in LOCAL_PART_PREFIX and
22932 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22933 same value as LOCAL_PART for compatibility with other MTAs.
22934
22935 .cindex "HOST"
22936 HOST is set only when a &(pipe)& transport is called from a router that
22937 associates hosts with an address, typically when using &(pipe)& as a
22938 pseudo-remote transport. HOST is set to the first host name specified by
22939 the router.
22940
22941 .cindex "HOME"
22942 If the transport's generic &%home_directory%& option is set, its value is used
22943 for the HOME environment variable. Otherwise, a home directory may be set
22944 by the router's &%transport_home_directory%& option, which defaults to the
22945 user's home directory if &%check_local_user%& is set.
22946
22947
22948 .section "Private options for pipe" "SECID142"
22949 .cindex "options" "&(pipe)& transport"
22950
22951
22952
22953 .option allow_commands pipe "string list&!!" unset
22954 .cindex "&(pipe)& transport" "permitted commands"
22955 The string is expanded, and is then interpreted as a colon-separated list of
22956 permitted commands. If &%restrict_to_path%& is not set, the only commands
22957 permitted are those in the &%allow_commands%& list. They need not be absolute
22958 paths; the &%path%& option is still used for relative paths. If
22959 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22960 in the &%allow_commands%& list, or a name without any slashes that is found on
22961 the path. In other words, if neither &%allow_commands%& nor
22962 &%restrict_to_path%& is set, there is no restriction on the command, but
22963 otherwise only commands that are permitted by one or the other are allowed. For
22964 example, if
22965 .code
22966 allow_commands = /usr/bin/vacation
22967 .endd
22968 and &%restrict_to_path%& is not set, the only permitted command is
22969 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22970 &%use_shell%& is set.
22971
22972
22973 .option batch_id pipe string&!! unset
22974 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22975
22976
22977 .option batch_max pipe integer 1
22978 This limits the number of addresses that can be handled in a single delivery.
22979 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22980
22981
22982 .option check_string pipe string unset
22983 As &(pipe)& writes the message, the start of each line is tested for matching
22984 &%check_string%&, and if it does, the initial matching characters are replaced
22985 by the contents of &%escape_string%&, provided both are set. The value of
22986 &%check_string%& is a literal string, not a regular expression, and the case of
22987 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22988 of &%check_string%& and &%escape_string%& are forced to values that implement
22989 the SMTP escaping protocol. Any settings made in the configuration file are
22990 ignored.
22991
22992
22993 .option command pipe string&!! unset
22994 This option need not be set when &(pipe)& is being used to deliver to pipes
22995 obtained directly from address redirections. In other cases, the option must be
22996 set, to provide a command to be run. It need not yield an absolute path (see
22997 the &%path%& option below). The command is split up into separate arguments by
22998 Exim, and each argument is separately expanded, as described in section
22999 &<<SECThowcommandrun>>& above.
23000
23001
23002 .option environment pipe string&!! unset
23003 .cindex "&(pipe)& transport" "environment for command"
23004 .cindex "environment for &(pipe)& transport"
23005 This option is used to add additional variables to the environment in which the
23006 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23007 a string which is expanded, and then interpreted as a colon-separated list of
23008 environment settings of the form <&'name'&>=<&'value'&>.
23009
23010
23011 .option escape_string pipe string unset
23012 See &%check_string%& above.
23013
23014
23015 .option freeze_exec_fail pipe boolean false
23016 .cindex "exec failure"
23017 .cindex "failure of exec"
23018 .cindex "&(pipe)& transport" "failure of exec"
23019 Failure to exec the command in a pipe transport is by default treated like
23020 any other failure while running the command. However, if &%freeze_exec_fail%&
23021 is set, failure to exec is treated specially, and causes the message to be
23022 frozen, whatever the setting of &%ignore_status%&.
23023
23024
23025 .option freeze_signal pipe boolean false
23026 .cindex "signal exit"
23027 .cindex "&(pipe)& transport", "signal exit"
23028 Normally if the process run by a command in a pipe transport exits on a signal,
23029 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23030 frozen in Exim's queue instead.
23031
23032
23033 .option force_command pipe boolean false
23034 .cindex "force command"
23035 .cindex "&(pipe)& transport", "force command"
23036 Normally when a router redirects an address directly to a pipe command
23037 the &%command%& option on the transport is ignored.  If &%force_command%&
23038 is set, the &%command%& option will used. This is especially
23039 useful for forcing a wrapper or additional argument to be added to the
23040 command. For example:
23041 .code
23042 command = /usr/bin/remote_exec myhost -- $address_pipe
23043 force_command
23044 .endd
23045
23046 Note that &$address_pipe$& is handled specially in &%command%& when
23047 &%force_command%& is set, expanding out to the original argument vector as
23048 separate items, similarly to a Unix shell &`"$@"`& construct.
23049
23050
23051 .option ignore_status pipe boolean false
23052 If this option is true, the status returned by the subprocess that is set up to
23053 run the command is ignored, and Exim behaves as if zero had been returned.
23054 Otherwise, a non-zero status or termination by signal causes an error return
23055 from the transport unless the status value is one of those listed in
23056 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23057
23058 &*Note*&: This option does not apply to timeouts, which do not return a status.
23059 See the &%timeout_defer%& option for how timeouts are handled.
23060
23061
23062 .option log_defer_output pipe boolean false
23063 .cindex "&(pipe)& transport" "logging output"
23064 If this option is set, and the status returned by the command is
23065 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23066 and any output was produced on stdout or stderr, the first line of it is
23067 written to the main log.
23068
23069
23070 .option log_fail_output pipe boolean false
23071 If this option is set, and the command returns any output on stdout or
23072 stderr, and also ends with a return code that is neither zero nor one of
23073 the return codes listed in &%temp_errors%& (that is, the delivery
23074 failed), the first line of output is written to the main log. This
23075 option and &%log_output%& are mutually exclusive.  Only one of them may
23076 be set.
23077
23078
23079 .option log_output pipe boolean false
23080 If this option is set and the command returns any output on stdout or
23081 stderr, the first line of output is written to the main log, whatever
23082 the return code. This option and &%log_fail_output%& are mutually
23083 exclusive. Only one of them may be set.
23084
23085
23086 .option max_output pipe integer 20K
23087 This specifies the maximum amount of output that the command may produce on its
23088 standard output and standard error file combined. If the limit is exceeded, the
23089 process running the command is killed. This is intended as a safety measure to
23090 catch runaway processes. The limit is applied independently of the settings of
23091 the options that control what is done with such output (for example,
23092 &%return_output%&). Because of buffering effects, the amount of output may
23093 exceed the limit by a small amount before Exim notices.
23094
23095
23096 .option message_prefix pipe string&!! "see below"
23097 The string specified here is expanded and output at the start of every message.
23098 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23099 .code
23100 message_prefix = \
23101   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23102   ${tod_bsdinbox}\n
23103 .endd
23104 .cindex "Cyrus"
23105 .cindex "&%tmail%&"
23106 .cindex "&""From""& line"
23107 This is required by the commonly used &_/usr/bin/vacation_& program.
23108 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23109 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23110 setting
23111 .code
23112 message_prefix =
23113 .endd
23114 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23115 &`\n`& to &`\r\n`& in &%message_prefix%&.
23116
23117
23118 .option message_suffix pipe string&!! "see below"
23119 The string specified here is expanded and output at the end of every message.
23120 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23121 The suffix can be suppressed by setting
23122 .code
23123 message_suffix =
23124 .endd
23125 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23126 &`\n`& to &`\r\n`& in &%message_suffix%&.
23127
23128
23129 .option path pipe string "see below"
23130 This option specifies the string that is set up in the PATH environment
23131 variable of the subprocess. The default is:
23132 .code
23133 /bin:/usr/bin
23134 .endd
23135 If the &%command%& option does not yield an absolute path name, the command is
23136 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23137 apply to a command specified as a transport filter.
23138
23139
23140 .option permit_coredump pipe boolean false
23141 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23142 a core-dump of a pipe command, enable this command.  This enables core-dumps
23143 during delivery and affects both the Exim binary and the pipe command run.
23144 It is recommended that this option remain off unless and until you have a need
23145 for it and that this only be enabled when needed, as the risk of excessive
23146 resource consumption can be quite high.  Note also that Exim is typically
23147 installed as a setuid binary and most operating systems will inhibit coredumps
23148 of these by default, so further OS-specific action may be required.
23149
23150
23151 .option pipe_as_creator pipe boolean false
23152 .cindex "uid (user id)" "local delivery"
23153 If the generic &%user%& option is not set and this option is true, the delivery
23154 process is run under the uid that was in force when Exim was originally called
23155 to accept the message. If the group id is not otherwise set (via the generic
23156 &%group%& option), the gid that was in force when Exim was originally called to
23157 accept the message is used.
23158
23159
23160 .option restrict_to_path pipe boolean false
23161 When this option is set, any command name not listed in &%allow_commands%& must
23162 contain no slashes. The command is searched for only in the directories listed
23163 in the &%path%& option. This option is intended for use in the case when a pipe
23164 command has been generated from a user's &_.forward_& file. This is usually
23165 handled by a &(pipe)& transport called &%address_pipe%&.
23166
23167
23168 .option return_fail_output pipe boolean false
23169 If this option is true, and the command produced any output and ended with a
23170 return code other than zero or one of the codes listed in &%temp_errors%& (that
23171 is, the delivery failed), the output is returned in the bounce message.
23172 However, if the message has a null sender (that is, it is itself a bounce
23173 message), output from the command is discarded. This option and
23174 &%return_output%& are mutually exclusive. Only one of them may be set.
23175
23176
23177
23178 .option return_output pipe boolean false
23179 If this option is true, and the command produced any output, the delivery is
23180 deemed to have failed whatever the return code from the command, and the output
23181 is returned in the bounce message. Otherwise, the output is just discarded.
23182 However, if the message has a null sender (that is, it is a bounce message),
23183 output from the command is always discarded, whatever the setting of this
23184 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23185 of them may be set.
23186
23187
23188
23189 .option temp_errors pipe "string list" "see below"
23190 .cindex "&(pipe)& transport" "temporary failure"
23191 This option contains either a colon-separated list of numbers, or a single
23192 asterisk. If &%ignore_status%& is false
23193 and &%return_output%& is not set,
23194 and the command exits with a non-zero return code, the failure is treated as
23195 temporary and the delivery is deferred if the return code matches one of the
23196 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23197 codes are treated as permanent errors. The default setting contains the codes
23198 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23199 compiled on a system that does not define these macros, it assumes values of 75
23200 and 73, respectively.
23201
23202
23203 .option timeout pipe time 1h
23204 If the command fails to complete within this time, it is killed. This normally
23205 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23206 specifies no timeout. In order to ensure that any subprocesses created by the
23207 command are also killed, Exim makes the initial process a process group leader,
23208 and kills the whole process group on a timeout. However, this can be defeated
23209 if one of the processes starts a new process group.
23210
23211 .option timeout_defer pipe boolean false
23212 A timeout in a &(pipe)& transport, either in the command that the transport
23213 runs, or in a transport filter that is associated with it, is by default
23214 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23215 is set true, both kinds of timeout become temporary errors, causing the
23216 delivery to be deferred.
23217
23218 .option umask pipe "octal integer" 022
23219 This specifies the umask setting for the subprocess that runs the command.
23220
23221
23222 .option use_bsmtp pipe boolean false
23223 .cindex "envelope sender"
23224 If this option is set true, the &(pipe)& transport writes messages in &"batch
23225 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23226 commands. If you want to include a leading HELO command with such messages,
23227 you can do so by setting the &%message_prefix%& option. See section
23228 &<<SECTbatchSMTP>>& for details of batch SMTP.
23229
23230 .option use_classresources pipe boolean false
23231 .cindex "class resources (BSD)"
23232 This option is available only when Exim is running on FreeBSD, NetBSD, or
23233 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23234 resource limits when a &(pipe)& transport is run to perform a delivery. The
23235 limits for the uid under which the pipe is to run are obtained from the login
23236 class database.
23237
23238
23239 .option use_crlf pipe boolean false
23240 .cindex "carriage return"
23241 .cindex "linefeed"
23242 This option causes lines to be terminated with the two-character CRLF sequence
23243 (carriage return, linefeed) instead of just a linefeed character. In the case
23244 of batched SMTP, the byte sequence written to the pipe is then an exact image
23245 of what would be sent down a real SMTP connection.
23246
23247 The contents of the &%message_prefix%& and &%message_suffix%& options are
23248 written verbatim, so must contain their own carriage return characters if these
23249 are needed. When &%use_bsmtp%& is not set, the default values for both
23250 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23251 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23252
23253
23254 .option use_shell pipe boolean false
23255 .vindex "&$pipe_addresses$&"
23256 If this option is set, it causes the command to be passed to &_/bin/sh_&
23257 instead of being run directly from the transport, as described in section
23258 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23259 where the command is expected to be run under a shell and cannot easily be
23260 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23261 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23262 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23263 its &%-c%& option.
23264
23265
23266
23267 .section "Using an external local delivery agent" "SECID143"
23268 .cindex "local delivery" "using an external agent"
23269 .cindex "&'procmail'&"
23270 .cindex "external local delivery"
23271 .cindex "delivery" "&'procmail'&"
23272 .cindex "delivery" "by external agent"
23273 The &(pipe)& transport can be used to pass all messages that require local
23274 delivery to a separate local delivery agent such as &%procmail%&. When doing
23275 this, care must be taken to ensure that the pipe is run under an appropriate
23276 uid and gid. In some configurations one wants this to be a uid that is trusted
23277 by the delivery agent to supply the correct sender of the message. It may be
23278 necessary to recompile or reconfigure the delivery agent so that it trusts an
23279 appropriate user. The following is an example transport and router
23280 configuration for &%procmail%&:
23281 .code
23282 # transport
23283 procmail_pipe:
23284   driver = pipe
23285   command = /usr/local/bin/procmail -d $local_part
23286   return_path_add
23287   delivery_date_add
23288   envelope_to_add
23289   check_string = "From "
23290   escape_string = ">From "
23291   umask = 077
23292   user = $local_part
23293   group = mail
23294
23295 # router
23296 procmail:
23297   driver = accept
23298   check_local_user
23299   transport = procmail_pipe
23300 .endd
23301 In this example, the pipe is run as the local user, but with the group set to
23302 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23303 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23304 user to supply a correct sender address. If you do not specify either a
23305 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23306 home directory is the user's home directory by default.
23307
23308 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23309 .code
23310 IFS=" "
23311 .endd
23312 as shown in some &%procmail%& documentation, because Exim does not by default
23313 use a shell to run pipe commands.
23314
23315 .cindex "Cyrus"
23316 The next example shows a transport and a router for a system where local
23317 deliveries are handled by the Cyrus IMAP server.
23318 .code
23319 # transport
23320 local_delivery_cyrus:
23321   driver = pipe
23322   command = /usr/cyrus/bin/deliver \
23323             -m ${substr_1:$local_part_suffix} -- $local_part
23324   user = cyrus
23325   group = mail
23326   return_output
23327   log_output
23328   message_prefix =
23329   message_suffix =
23330
23331 # router
23332 local_user_cyrus:
23333   driver = accept
23334   check_local_user
23335   local_part_suffix = .*
23336   transport = local_delivery_cyrus
23337 .endd
23338 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23339 &%return_output%& to cause any text written by Cyrus to be returned to the
23340 sender.
23341 .ecindex IIDpiptra1
23342 .ecindex IIDpiptra2
23343
23344
23345 . ////////////////////////////////////////////////////////////////////////////
23346 . ////////////////////////////////////////////////////////////////////////////
23347
23348 .chapter "The smtp transport" "CHAPsmtptrans"
23349 .scindex IIDsmttra1 "transports" "&(smtp)&"
23350 .scindex IIDsmttra2 "&(smtp)& transport"
23351 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23352 or LMTP protocol. The list of hosts to try can either be taken from the address
23353 that is being processed (having been set up by the router), or specified
23354 explicitly for the transport. Timeout and retry processing (see chapter
23355 &<<CHAPretry>>&) is applied to each IP address independently.
23356
23357
23358 .section "Multiple messages on a single connection" "SECID144"
23359 The sending of multiple messages over a single TCP/IP connection can arise in
23360 two ways:
23361
23362 .ilist
23363 If a message contains more than &%max_rcpt%& (see below) addresses that are
23364 routed to the same host, more than one copy of the message has to be sent to
23365 that host. In this situation, multiple copies may be sent in a single run of
23366 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23367 does when it has too many addresses to send in one message also depends on the
23368 value of the global &%remote_max_parallel%& option. Details are given in
23369 section &<<SECToutSMTPTCP>>&.)
23370 .next
23371 .cindex "hints database" "remembering routing"
23372 When a message has been successfully delivered over a TCP/IP connection, Exim
23373 looks in its hints database to see if there are any other messages awaiting a
23374 connection to the same host. If there are, a new delivery process is started
23375 for one of them, and the current TCP/IP connection is passed on to it. The new
23376 process may in turn send multiple copies and possibly create yet another
23377 process.
23378 .endlist
23379
23380
23381 For each copy sent over the same TCP/IP connection, a sequence counter is
23382 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23383 no further messages are sent over that connection.
23384
23385
23386
23387 .section "Use of the $host and $host_address variables" "SECID145"
23388 .vindex "&$host$&"
23389 .vindex "&$host_address$&"
23390 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23391 &$host_address$& are the name and IP address of the first host on the host list
23392 passed by the router. However, when the transport is about to connect to a
23393 specific host, and while it is connected to that host, &$host$& and
23394 &$host_address$& are set to the values for that host. These are the values
23395 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23396 &%serialize_hosts%&, and the various TLS options are expanded.
23397
23398
23399 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23400 .vindex &$tls_bits$&
23401 .vindex &$tls_cipher$&
23402 .vindex &$tls_peerdn$&
23403 .vindex &$tls_sni$&
23404 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23405 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23406 are the values that were set when the message was received.
23407 These are the values that are used for options that are expanded before any
23408 SMTP connections are made. Just before each connection is made, these four
23409 variables are emptied. If TLS is subsequently started, they are set to the
23410 appropriate values for the outgoing connection, and these are the values that
23411 are in force when any authenticators are run and when the
23412 &%authenticated_sender%& option is expanded.
23413
23414 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23415 and will be removed in a future release.
23416
23417
23418 .section "Private options for smtp" "SECID146"
23419 .cindex "options" "&(smtp)& transport"
23420 The private options of the &(smtp)& transport are as follows:
23421
23422
23423 .option address_retry_include_sender smtp boolean true
23424 .cindex "4&'xx'& responses" "retrying after"
23425 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23426 is the combination of sender and recipient that is delayed in subsequent queue
23427 runs until the retry time is reached. You can delay the recipient without
23428 reference to the sender (which is what earlier versions of Exim did), by
23429 setting &%address_retry_include_sender%& false. However, this can lead to
23430 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23431
23432 .option allow_localhost smtp boolean false
23433 .cindex "local host" "sending to"
23434 .cindex "fallback" "hosts specified on transport"
23435 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23436 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23437 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23438 the delivery anyway. This should be used only in special cases when the
23439 configuration ensures that no looping will result (for example, a differently
23440 configured Exim is listening on the port to which the message is sent).
23441
23442
23443 .option authenticated_sender smtp string&!! unset
23444 .cindex "Cyrus"
23445 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23446 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23447 overriding any existing authenticated sender value. If the string expansion is
23448 forced to fail, the option is ignored. Other expansion failures cause delivery
23449 to be deferred. If the result of expansion is an empty string, that is also
23450 ignored.
23451
23452 The expansion happens after the outgoing connection has been made and TLS
23453 started, if required. This means that the &$host$&, &$host_address$&,
23454 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23455 particular connection.
23456
23457 If the SMTP session is not authenticated, the expansion of
23458 &%authenticated_sender%& still happens (and can cause the delivery to be
23459 deferred if it fails), but no AUTH= item is added to MAIL commands
23460 unless &%authenticated_sender_force%& is true.
23461
23462 This option allows you to use the &(smtp)& transport in LMTP mode to
23463 deliver mail to Cyrus IMAP and provide the proper local part as the
23464 &"authenticated sender"&, via a setting such as:
23465 .code
23466 authenticated_sender = $local_part
23467 .endd
23468 This removes the need for IMAP subfolders to be assigned special ACLs to
23469 allow direct delivery to those subfolders.
23470
23471 Because of expected uses such as that just described for Cyrus (when no
23472 domain is involved), there is no checking on the syntax of the provided
23473 value.
23474
23475
23476 .option authenticated_sender_force smtp boolean false
23477 If this option is set true, the &%authenticated_sender%& option's value
23478 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23479 authenticated as a client.
23480
23481
23482 .option command_timeout smtp time 5m
23483 This sets a timeout for receiving a response to an SMTP command that has been
23484 sent out. It is also used when waiting for the initial banner line from the
23485 remote host. Its value must not be zero.
23486
23487
23488 .option connect_timeout smtp time 5m
23489 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23490 to a remote host. A setting of zero allows the system timeout (typically
23491 several minutes) to act. To have any effect, the value of this option must be
23492 less than the system timeout. However, it has been observed that on some
23493 systems there is no system timeout, which is why the default value for this
23494 option is 5 minutes, a value recommended by RFC 1123.
23495
23496
23497 .option connection_max_messages smtp integer 500
23498 .cindex "SMTP" "passed connection"
23499 .cindex "SMTP" "multiple deliveries"
23500 .cindex "multiple SMTP deliveries"
23501 This controls the maximum number of separate message deliveries that are sent
23502 over a single TCP/IP connection. If the value is zero, there is no limit.
23503 For testing purposes, this value can be overridden by the &%-oB%& command line
23504 option.
23505
23506
23507 .option data_timeout smtp time 5m
23508 This sets a timeout for the transmission of each block in the data portion of
23509 the message. As a result, the overall timeout for a message depends on the size
23510 of the message. Its value must not be zero. See also &%final_timeout%&.
23511
23512
23513 .option dkim_domain smtp string&!! unset
23514 .option dkim_selector smtp string&!! unset
23515 .option dkim_private_key smtp string&!! unset
23516 .option dkim_canon smtp string&!! unset
23517 .option dkim_strict smtp string&!! unset
23518 .option dkim_sign_headers smtp string&!! unset
23519 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23520
23521
23522 .option delay_after_cutoff smtp boolean true
23523 This option controls what happens when all remote IP addresses for a given
23524 domain have been inaccessible for so long that they have passed their retry
23525 cutoff times.
23526
23527 In the default state, if the next retry time has not been reached for any of
23528 them, the address is bounced without trying any deliveries. In other words,
23529 Exim delays retrying an IP address after the final cutoff time until a new
23530 retry time is reached, and can therefore bounce an address without ever trying
23531 a delivery, when machines have been down for a long time. Some people are
23532 unhappy at this prospect, so...
23533
23534 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23535 addresses are past their final cutoff time, Exim tries to deliver to those
23536 IP addresses that have not been tried since the message arrived. If there are
23537 none, of if they all fail, the address is bounced. In other words, it does not
23538 delay when a new message arrives, but immediately tries those expired IP
23539 addresses that haven't been tried since the message arrived. If there is a
23540 continuous stream of messages for the dead hosts, unsetting
23541 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23542 to them.
23543
23544
23545 .option dns_qualify_single smtp boolean true
23546 If the &%hosts%& or &%fallback_hosts%& option is being used,
23547 and the &%gethostbyname%& option is false,
23548 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23549 in chapter &<<CHAPdnslookup>>& for more details.
23550
23551
23552 .option dns_search_parents smtp boolean false
23553 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23554 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23555 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23556 details.
23557
23558
23559 .option dnssec_request_domains smtp "domain list&!!" unset
23560 .cindex "MX record" "security"
23561 .cindex "DNSSEC" "MX lookup"
23562 .cindex "security" "MX lookup"
23563 .cindex "DNS" "DNSSEC"
23564 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23565 the dnssec request bit set.
23566 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23567
23568
23569
23570 .option dnssec_require_domains smtp "domain list&!!" unset
23571 .cindex "MX record" "security"
23572 .cindex "DNSSEC" "MX lookup"
23573 .cindex "security" "MX lookup"
23574 .cindex "DNS" "DNSSEC"
23575 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23576 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23577 (AD bit) set will be ignored and logged as a host-lookup failure.
23578 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23579
23580
23581
23582 .option dscp smtp string&!! unset
23583 .cindex "DCSP" "outbound"
23584 This option causes the DSCP value associated with a socket to be set to one
23585 of a number of fixed strings or to numeric value.
23586 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23587 Common values include &`throughput`&, &`mincost`&, and on newer systems
23588 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23589
23590 The outbound packets from Exim will be marked with this value in the header
23591 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23592 that these values will have any effect, not be stripped by networking
23593 equipment, or do much of anything without cooperation with your Network
23594 Engineer and those of all network operators between the source and destination.
23595
23596
23597 .option fallback_hosts smtp "string list" unset
23598 .cindex "fallback" "hosts specified on transport"
23599 String expansion is not applied to this option. The argument must be a
23600 colon-separated list of host names or IP addresses, optionally also including
23601 port numbers, though the separator can be changed, as described in section
23602 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23603 item in a &%route_list%& setting for the &(manualroute)& router, as described
23604 in section &<<SECTformatonehostitem>>&.
23605
23606 Fallback hosts can also be specified on routers, which associate them with the
23607 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23608 &%fallback_hosts%& specified on the transport is used only if the address does
23609 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23610 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23611 However, &%hosts_randomize%& does apply to fallback host lists.
23612
23613 If Exim is unable to deliver to any of the hosts for a particular address, and
23614 the errors are not permanent rejections, the address is put on a separate
23615 transport queue with its host list replaced by the fallback hosts, unless the
23616 address was routed via MX records and the current host was in the original MX
23617 list. In that situation, the fallback host list is not used.
23618
23619 Once normal deliveries are complete, the fallback queue is delivered by
23620 re-running the same transports with the new host lists. If several failing
23621 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23622 copy of the message is sent.
23623
23624 The resolution of the host names on the fallback list is controlled by the
23625 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23626 both to cases when the host list comes with the address and when it is taken
23627 from &%hosts%&. This option provides a &"use a smart host only if delivery
23628 fails"& facility.
23629
23630
23631 .option final_timeout smtp time 10m
23632 This is the timeout that applies while waiting for the response to the final
23633 line containing just &"."& that terminates a message. Its value must not be
23634 zero.
23635
23636 .option gethostbyname smtp boolean false
23637 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23638 being used, names are looked up using &[gethostbyname()]&
23639 (or &[getipnodebyname()]& when available)
23640 instead of using the DNS. Of course, that function may in fact use the DNS, but
23641 it may also consult other sources of information such as &_/etc/hosts_&.
23642
23643 .option gnutls_compat_mode smtp boolean unset
23644 This option controls whether GnuTLS is used in compatibility mode in an Exim
23645 server. This reduces security slightly, but improves interworking with older
23646 implementations of TLS.
23647
23648 .option helo_data smtp string&!! "see below"
23649 .cindex "HELO" "argument, setting"
23650 .cindex "EHLO" "argument, setting"
23651 .cindex "LHLO argument setting"
23652 The value of this option is expanded after a connection to a another host has
23653 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23654 command that starts the outgoing SMTP or LMTP session. The default value of the
23655 option is:
23656 .code
23657 $primary_hostname
23658 .endd
23659 During the expansion, the variables &$host$& and &$host_address$& are set to
23660 the identity of the remote host, and the variables &$sending_ip_address$& and
23661 &$sending_port$& are set to the local IP address and port number that are being
23662 used. These variables can be used to generate different values for different
23663 servers or different local IP addresses. For example, if you want the string
23664 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23665 interface address, you could use this:
23666 .code
23667 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23668   {$primary_hostname}}
23669 .endd
23670 The use of &%helo_data%& applies both to sending messages and when doing
23671 callouts.
23672
23673 .option hosts smtp "string list&!!" unset
23674 Hosts are associated with an address by a router such as &(dnslookup)&, which
23675 finds the hosts by looking up the address domain in the DNS, or by
23676 &(manualroute)&, which has lists of hosts in its configuration. However,
23677 email addresses can be passed to the &(smtp)& transport by any router, and not
23678 all of them can provide an associated list of hosts.
23679
23680 The &%hosts%& option specifies a list of hosts to be used if the address being
23681 processed does not have any hosts associated with it. The hosts specified by
23682 &%hosts%& are also used, whether or not the address has its own hosts, if
23683 &%hosts_override%& is set.
23684
23685 The string is first expanded, before being interpreted as a colon-separated
23686 list of host names or IP addresses, possibly including port numbers. The
23687 separator may be changed to something other than colon, as described in section
23688 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23689 item in a &%route_list%& setting for the &(manualroute)& router, as described
23690 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23691 of the &(manualroute)& router is not available here.
23692
23693 If the expansion fails, delivery is deferred. Unless the failure was caused by
23694 the inability to complete a lookup, the error is logged to the panic log as
23695 well as the main log. Host names are looked up either by searching directly for
23696 address records in the DNS or by calling &[gethostbyname()]& (or
23697 &[getipnodebyname()]& when available), depending on the setting of the
23698 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23699 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23700 address are used.
23701
23702 During delivery, the hosts are tried in order, subject to their retry status,
23703 unless &%hosts_randomize%& is set.
23704
23705
23706 .option hosts_avoid_esmtp smtp "host list&!!" unset
23707 .cindex "ESMTP, avoiding use of"
23708 .cindex "HELO" "forcing use of"
23709 .cindex "EHLO" "avoiding use of"
23710 .cindex "PIPELINING" "avoiding the use of"
23711 This option is for use with broken hosts that announce ESMTP facilities (for
23712 example, PIPELINING) and then fail to implement them properly. When a host
23713 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23714 start of the SMTP session. This means that it cannot use any of the ESMTP
23715 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23716
23717
23718 .option hosts_avoid_pipelining smtp "host list&!!" unset
23719 .cindex "PIPELINING" "avoiding the use of"
23720 Exim will not use the SMTP PIPELINING extension when delivering to any host
23721 that matches this list, even if the server host advertises PIPELINING support.
23722
23723
23724 .option hosts_avoid_tls smtp "host list&!!" unset
23725 .cindex "TLS" "avoiding for certain hosts"
23726 Exim will not try to start a TLS session when delivering to any host that
23727 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23728
23729 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23730 .cindex "TLS" "avoiding for certain hosts"
23731 Exim will not try to start a TLS session for a verify callout,
23732 or when delivering in cutthrough mode,
23733 to any host that matches this list.
23734
23735
23736 .option hosts_max_try smtp integer 5
23737 .cindex "host" "maximum number to try"
23738 .cindex "limit" "number of hosts tried"
23739 .cindex "limit" "number of MX tried"
23740 .cindex "MX record" "maximum tried"
23741 This option limits the number of IP addresses that are tried for any one
23742 delivery in cases where there are temporary delivery errors. Section
23743 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23744
23745
23746 .option hosts_max_try_hardlimit smtp integer 50
23747 This is an additional check on the maximum number of IP addresses that Exim
23748 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23749 why it exists.
23750
23751
23752
23753 .option hosts_nopass_tls smtp "host list&!!" unset
23754 .cindex "TLS" "passing connection"
23755 .cindex "multiple SMTP deliveries"
23756 .cindex "TLS" "multiple message deliveries"
23757 For any host that matches this list, a connection on which a TLS session has
23758 been started will not be passed to a new delivery process for sending another
23759 message on the same connection. See section &<<SECTmulmessam>>& for an
23760 explanation of when this might be needed.
23761
23762
23763 .option hosts_override smtp boolean false
23764 If this option is set and the &%hosts%& option is also set, any hosts that are
23765 attached to the address are ignored, and instead the hosts specified by the
23766 &%hosts%& option are always used. This option does not apply to
23767 &%fallback_hosts%&.
23768
23769
23770 .option hosts_randomize smtp boolean false
23771 .cindex "randomized host list"
23772 .cindex "host" "list of; randomized"
23773 .cindex "fallback" "randomized hosts"
23774 If this option is set, and either the list of hosts is taken from the
23775 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23776 were not obtained from MX records (this includes fallback hosts from the
23777 router), and were not randomized by the router, the order of trying the hosts
23778 is randomized each time the transport runs. Randomizing the order of a host
23779 list can be used to do crude load sharing.
23780
23781 When &%hosts_randomize%& is true, a host list may be split into groups whose
23782 order is separately randomized. This makes it possible to set up MX-like
23783 behaviour. The boundaries between groups are indicated by an item that is just
23784 &`+`& in the host list. For example:
23785 .code
23786 hosts = host1:host2:host3:+:host4:host5
23787 .endd
23788 The order of the first three hosts and the order of the last two hosts is
23789 randomized for each use, but the first three always end up before the last two.
23790 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23791
23792 .option hosts_require_auth smtp "host list&!!" unset
23793 .cindex "authentication" "required by client"
23794 This option provides a list of servers for which authentication must succeed
23795 before Exim will try to transfer a message. If authentication fails for
23796 servers which are not in this list, Exim tries to send unauthenticated. If
23797 authentication fails for one of these servers, delivery is deferred. This
23798 temporary error is detectable in the retry rules, so it can be turned into a
23799 hard failure if required. See also &%hosts_try_auth%&, and chapter
23800 &<<CHAPSMTPAUTH>>& for details of authentication.
23801
23802
23803 .option hosts_request_ocsp smtp "host list&!!" *
23804 .cindex "TLS" "requiring for certain servers"
23805 Exim will request a Certificate Status on a
23806 TLS session for any host that matches this list.
23807 &%tls_verify_certificates%& should also be set for the transport.
23808
23809 .option hosts_require_ocsp smtp "host list&!!" unset
23810 .cindex "TLS" "requiring for certain servers"
23811 Exim will request, and check for a valid Certificate Status being given, on a
23812 TLS session for any host that matches this list.
23813 &%tls_verify_certificates%& should also be set for the transport.
23814
23815 .option hosts_require_tls smtp "host list&!!" unset
23816 .cindex "TLS" "requiring for certain servers"
23817 Exim will insist on using a TLS session when delivering to any host that
23818 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23819 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23820 incoming messages, use an appropriate ACL.
23821
23822 .option hosts_try_auth smtp "host list&!!" unset
23823 .cindex "authentication" "optional in client"
23824 This option provides a list of servers to which, provided they announce
23825 authentication support, Exim will attempt to authenticate as a client when it
23826 connects. If authentication fails, Exim will try to transfer the message
23827 unauthenticated. See also &%hosts_require_auth%&, and chapter
23828 &<<CHAPSMTPAUTH>>& for details of authentication.
23829
23830 .option hosts_try_prdr smtp "host list&!!" *
23831 .cindex "PRDR" "enabling, optional in client"
23832 This option provides a list of servers to which, provided they announce
23833 PRDR support, Exim will attempt to negotiate PRDR
23834 for multi-recipient messages.
23835 The option can usually be left as default.
23836
23837 .option interface smtp "string list&!!" unset
23838 .cindex "bind IP address"
23839 .cindex "IP address" "binding"
23840 .vindex "&$host$&"
23841 .vindex "&$host_address$&"
23842 This option specifies which interface to bind to when making an outgoing SMTP
23843 call. The value is an IP address, not an interface name such as
23844 &`eth0`&. Do not confuse this with the interface address that was used when a
23845 message was received, which is in &$received_ip_address$&, formerly known as
23846 &$interface_address$&. The name was changed to minimize confusion with the
23847 outgoing interface address. There is no variable that contains an outgoing
23848 interface address because, unless it is set by this option, its value is
23849 unknown.
23850
23851 During the expansion of the &%interface%& option the variables &$host$& and
23852 &$host_address$& refer to the host to which a connection is about to be made
23853 during the expansion of the string. Forced expansion failure, or an empty
23854 string result causes the option to be ignored. Otherwise, after expansion, the
23855 string must be a list of IP addresses, colon-separated by default, but the
23856 separator can be changed in the usual way. For example:
23857 .code
23858 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23859 .endd
23860 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23861 connection. If none of them are the correct type, the option is ignored. If
23862 &%interface%& is not set, or is ignored, the system's IP functions choose which
23863 interface to use if the host has more than one.
23864
23865
23866 .option keepalive smtp boolean true
23867 .cindex "keepalive" "on outgoing connection"
23868 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23869 connections. When set, it causes the kernel to probe idle connections
23870 periodically, by sending packets with &"old"& sequence numbers. The other end
23871 of the connection should send a acknowledgment if the connection is still okay
23872 or a reset if the connection has been aborted. The reason for doing this is
23873 that it has the beneficial effect of freeing up certain types of connection
23874 that can get stuck when the remote host is disconnected without tidying up the
23875 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23876 unreachable hosts.
23877
23878
23879 .option lmtp_ignore_quota smtp boolean false
23880 .cindex "LMTP" "ignoring quota errors"
23881 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23882 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23883 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23884
23885 .option max_rcpt smtp integer 100
23886 .cindex "RCPT" "maximum number of outgoing"
23887 This option limits the number of RCPT commands that are sent in a single
23888 SMTP message transaction. Each set of addresses is treated independently, and
23889 so can cause parallel connections to the same host if &%remote_max_parallel%&
23890 permits this.
23891
23892
23893 .option multi_domain smtp boolean&!! true
23894 .vindex "&$domain$&"
23895 When this option is set, the &(smtp)& transport can handle a number of
23896 addresses containing a mixture of different domains provided they all resolve
23897 to the same list of hosts. Turning the option off restricts the transport to
23898 handling only one domain at a time. This is useful if you want to use
23899 &$domain$& in an expansion for the transport, because it is set only when there
23900 is a single domain involved in a remote delivery.
23901
23902 It is expanded per-address and can depend on any of
23903 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23904 &$host$&, &$host_address$& and &$host_port$&.
23905
23906 .option port smtp string&!! "see below"
23907 .cindex "port" "sending TCP/IP"
23908 .cindex "TCP/IP" "setting outgoing port"
23909 This option specifies the TCP/IP port on the server to which Exim connects.
23910 &*Note:*& Do not confuse this with the port that was used when a message was
23911 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23912 The name was changed to minimize confusion with the outgoing port. There is no
23913 variable that contains an outgoing port.
23914
23915 If the value of this option begins with a digit it is taken as a port number;
23916 otherwise it is looked up using &[getservbyname()]&. The default value is
23917 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23918 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23919 is deferred.
23920
23921
23922
23923 .option protocol smtp string smtp
23924 .cindex "LMTP" "over TCP/IP"
23925 .cindex "ssmtp protocol" "outbound"
23926 .cindex "TLS" "SSL-on-connect outbound"
23927 .vindex "&$port$&"
23928 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23929 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23930 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23931 deliveries into closed message stores. Exim also has support for running LMTP
23932 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23933
23934 If this option is set to &"smtps"&, the default value for the &%port%& option
23935 changes to &"smtps"&, and the transport initiates TLS immediately after
23936 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23937 The Internet standards bodies strongly discourage use of this mode.
23938
23939
23940 .option retry_include_ip_address smtp boolean&!! true
23941 Exim normally includes both the host name and the IP address in the key it
23942 constructs for indexing retry data after a temporary delivery failure. This
23943 means that when one of several IP addresses for a host is failing, it gets
23944 tried periodically (controlled by the retry rules), but use of the other IP
23945 addresses is not affected.
23946
23947 However, in some dialup environments hosts are assigned a different IP address
23948 each time they connect. In this situation the use of the IP address as part of
23949 the retry key leads to undesirable behaviour. Setting this option false causes
23950 Exim to use only the host name.
23951 Since it is expanded it can be made to depend on the host or domain.
23952
23953
23954 .option serialize_hosts smtp "host list&!!" unset
23955 .cindex "serializing connections"
23956 .cindex "host" "serializing connections"
23957 Because Exim operates in a distributed manner, if several messages for the same
23958 host arrive at around the same time, more than one simultaneous connection to
23959 the remote host can occur. This is not usually a problem except when there is a
23960 slow link between the hosts. In that situation it may be helpful to restrict
23961 Exim to one connection at a time. This can be done by setting
23962 &%serialize_hosts%& to match the relevant hosts.
23963
23964 .cindex "hints database" "serializing deliveries to a host"
23965 Exim implements serialization by means of a hints database in which a record is
23966 written whenever a process connects to one of the restricted hosts. The record
23967 is deleted when the connection is completed. Obviously there is scope for
23968 records to get left lying around if there is a system or program crash. To
23969 guard against this, Exim ignores any records that are more than six hours old.
23970
23971 If you set up this kind of serialization, you should also arrange to delete the
23972 relevant hints database whenever your system reboots. The names of the files
23973 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23974 may be one or two files, depending on the type of DBM in use. The same files
23975 are used for ETRN serialization.
23976
23977 .new
23978 See also the &%max_parallel%& generic transport option.
23979 .wen
23980
23981
23982 .option size_addition smtp integer 1024
23983 .cindex "SMTP" "SIZE"
23984 .cindex "message" "size issue for transport filter"
23985 .cindex "size" "of message"
23986 .cindex "transport" "filter"
23987 .cindex "filter" "transport filter"
23988 If a remote SMTP server indicates that it supports the SIZE option of the
23989 MAIL command, Exim uses this to pass over the message size at the start of
23990 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23991 sends, to allow for headers and other text that may be added during delivery by
23992 configuration options or in a transport filter. It may be necessary to increase
23993 this if a lot of text is added to messages.
23994
23995 Alternatively, if the value of &%size_addition%& is set negative, it disables
23996 the use of the SIZE option altogether.
23997
23998
23999 .new
24000 .option socks_proxy smtp string&!! unset
24001 .cindex proxy SOCKS
24002 This option enables use of SOCKS proxies for connections made by the
24003 transport.  For details see &<<SECTproxySOCKS>>&.
24004 .wen
24005
24006
24007 .option tls_certificate smtp string&!! unset
24008 .cindex "TLS" "client certificate, location of"
24009 .cindex "certificate" "client, location of"
24010 .vindex "&$host$&"
24011 .vindex "&$host_address$&"
24012 The value of this option must be the absolute path to a file which contains the
24013 client's certificate, for possible use when sending a message over an encrypted
24014 connection. The values of &$host$& and &$host_address$& are set to the name and
24015 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24016 details of TLS.
24017
24018 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24019 certificate when sending messages as a client. The global option of the same
24020 name specifies the certificate for Exim as a server; it is not automatically
24021 assumed that the same certificate should be used when Exim is operating as a
24022 client.
24023
24024
24025 .option tls_crl smtp string&!! unset
24026 .cindex "TLS" "client certificate revocation list"
24027 .cindex "certificate" "revocation list for client"
24028 This option specifies a certificate revocation list. The expanded value must
24029 be the name of a file that contains a CRL in PEM format.
24030
24031
24032 .option tls_dh_min_bits smtp integer 1024
24033 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24034 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24035 key agreement is negotiated, the server will provide a large prime number
24036 for use.  This option establishes the minimum acceptable size of that number.
24037 If the parameter offered by the server is too small, then the TLS handshake
24038 will fail.
24039
24040 Only supported when using GnuTLS.
24041
24042
24043 .option tls_privatekey smtp string&!! unset
24044 .cindex "TLS" "client private key, location of"
24045 .vindex "&$host$&"
24046 .vindex "&$host_address$&"
24047 The value of this option must be the absolute path to a file which contains the
24048 client's private key. This is used when sending a message over an encrypted
24049 connection using a client certificate. The values of &$host$& and
24050 &$host_address$& are set to the name and address of the server during the
24051 expansion. If this option is unset, or the expansion is forced to fail, or the
24052 result is an empty string, the private key is assumed to be in the same file as
24053 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24054
24055
24056 .option tls_require_ciphers smtp string&!! unset
24057 .cindex "TLS" "requiring specific ciphers"
24058 .cindex "cipher" "requiring specific"
24059 .vindex "&$host$&"
24060 .vindex "&$host_address$&"
24061 The value of this option must be a list of permitted cipher suites, for use
24062 when setting up an outgoing encrypted connection. (There is a global option of
24063 the same name for controlling incoming connections.) The values of &$host$& and
24064 &$host_address$& are set to the name and address of the server during the
24065 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24066 is used in different ways by OpenSSL and GnuTLS (see sections
24067 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24068 ciphers is a preference order.
24069
24070
24071
24072 .option tls_sni smtp string&!! unset
24073 .cindex "TLS" "Server Name Indication"
24074 .vindex "&$tls_sni$&"
24075 If this option is set then it sets the $tls_out_sni variable and causes any
24076 TLS session to pass this value as the Server Name Indication extension to
24077 the remote side, which can be used by the remote side to select an appropriate
24078 certificate and private key for the session.
24079
24080 See &<<SECTtlssni>>& for more information.
24081
24082 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24083 TLS extensions.
24084
24085
24086
24087
24088 .option tls_tempfail_tryclear smtp boolean true
24089 .cindex "4&'xx'& responses" "to STARTTLS"
24090 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24091 setting up a TLS session, this option determines whether or not Exim should try
24092 to deliver the message unencrypted. If it is set false, delivery to the
24093 current host is deferred; if there are other hosts, they are tried. If this
24094 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24095 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24096 TLS negotiation fails, Exim closes the current connection (because it is in an
24097 unknown state), opens a new one to the same host, and then tries the delivery
24098 in clear.
24099
24100
24101 .option tls_try_verify_hosts smtp "host list&!!" *
24102 .cindex "TLS" "server certificate verification"
24103 .cindex "certificate" "verification of server"
24104 This option gives a list of hosts for which, on encrypted connections,
24105 certificate verification will be tried but need not succeed.
24106 The &%tls_verify_certificates%& option must also be set.
24107 Note that unless the host is in this list
24108 TLS connections will be denied to hosts using self-signed certificates
24109 when &%tls_verify_certificates%& is matched.
24110 The &$tls_out_certificate_verified$& variable is set when
24111 certificate verification succeeds.
24112
24113
24114 .option tls_verify_cert_hostnames smtp "host list&!!" *
24115 .cindex "TLS" "server certificate hostname verification"
24116 .cindex "certificate" "verification of server"
24117 This option give a list of hosts for which,
24118 while verifying the server certificate,
24119 checks will be included on the host name
24120 (note that this will generally be the result of a DNS MX lookup)
24121 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24122 limited to being the initial component of a 3-or-more component FQDN.
24123
24124 There is no equivalent checking on client certificates.
24125
24126
24127 .option tls_verify_certificates smtp string&!! system
24128 .cindex "TLS" "server certificate verification"
24129 .cindex "certificate" "verification of server"
24130 .vindex "&$host$&"
24131 .vindex "&$host_address$&"
24132 The value of this option must be either the
24133 word "system"
24134 or the absolute path to
24135 a file or directory containing permitted certificates for servers,
24136 for use when setting up an encrypted connection.
24137
24138 The "system" value for the option will use a location compiled into the SSL library.
24139 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24140 is taken as empty and an explicit location
24141 must be specified.
24142
24143 The use of a directory for the option value is not available for GnuTLS versions
24144 preceding 3.3.6 and a single file must be used.
24145
24146 With OpenSSL the certificates specified
24147 explicitly
24148 either by file or directory
24149 are added to those given by the system default location.
24150
24151 The values of &$host$& and
24152 &$host_address$& are set to the name and address of the server during the
24153 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24154
24155 For back-compatibility,
24156 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24157 (a single-colon empty list counts as being set)
24158 and certificate verification fails the TLS connection is closed.
24159
24160
24161 .option tls_verify_hosts smtp "host list&!!" unset
24162 .cindex "TLS" "server certificate verification"
24163 .cindex "certificate" "verification of server"
24164 This option gives a list of hosts for which, on encrypted connections,
24165 certificate verification must succeed.
24166 The &%tls_verify_certificates%& option must also be set.
24167 If both this option and &%tls_try_verify_hosts%& are unset
24168 operation is as if this option selected all hosts.
24169
24170
24171
24172
24173 .section "How the limits for the number of hosts to try are used" &&&
24174          "SECTvalhosmax"
24175 .cindex "host" "maximum number to try"
24176 .cindex "limit" "hosts; maximum number tried"
24177 There are two options that are concerned with the number of hosts that are
24178 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24179 &%hosts_max_try_hardlimit%&.
24180
24181
24182 The &%hosts_max_try%& option limits the number of hosts that are tried
24183 for a single delivery. However, despite the term &"host"& in its name, the
24184 option actually applies to each IP address independently. In other words, a
24185 multihomed host is treated as several independent hosts, just as it is for
24186 retrying.
24187
24188 Many of the larger ISPs have multiple MX records which often point to
24189 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24190 created as a result of routing one of these domains.
24191
24192 Trying every single IP address on such a long list does not seem sensible; if
24193 several at the top of the list fail, it is reasonable to assume there is some
24194 problem that is likely to affect all of them. Roughly speaking, the value of
24195 &%hosts_max_try%& is the maximum number that are tried before deferring the
24196 delivery. However, the logic cannot be quite that simple.
24197
24198 Firstly, IP addresses that are skipped because their retry times have not
24199 arrived do not count, and in addition, addresses that are past their retry
24200 limits are also not counted, even when they are tried. This means that when
24201 some IP addresses are past their retry limits, more than the value of
24202 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24203 that all IP addresses are considered before timing out an email address (but
24204 see below for an exception).
24205
24206 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24207 list to see if there is a subsequent host with a different (higher valued) MX.
24208 If there is, that host is considered next, and the current IP address is used
24209 but not counted. This behaviour helps in the case of a domain with a retry rule
24210 that hardly ever delays any hosts, as is now explained:
24211
24212 Consider the case of a long list of hosts with one MX value, and a few with a
24213 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24214 hosts at the top of the list are tried at first. With the default retry rule,
24215 which specifies increasing retry times, the higher MX hosts are eventually
24216 tried when those at the top of the list are skipped because they have not
24217 reached their retry times.
24218
24219 However, it is common practice to put a fixed short retry time on domains for
24220 large ISPs, on the grounds that their servers are rarely down for very long.
24221 Unfortunately, these are exactly the domains that tend to resolve to long lists
24222 of hosts. The short retry time means that the lowest MX hosts are tried every
24223 time. The attempts may be in a different order because of random sorting, but
24224 without the special MX check, the higher MX hosts would never be tried until
24225 all the lower MX hosts had timed out (which might be several days), because
24226 there are always some lower MX hosts that have reached their retry times. With
24227 the special check, Exim considers at least one IP address from each MX value at
24228 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24229 reached.
24230
24231 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24232 particular, Exim normally eventually tries all the IP addresses before timing
24233 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24234 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24235 been set up with hundreds of IP addresses for some domains. It can
24236 take a very long time indeed for an address to time out in these cases.
24237
24238 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24239 Exim never tries more than this number of IP addresses; if it hits this limit
24240 and they are all timed out, the email address is bounced, even though not all
24241 possible IP addresses have been tried.
24242 .ecindex IIDsmttra1
24243 .ecindex IIDsmttra2
24244
24245
24246
24247
24248
24249 . ////////////////////////////////////////////////////////////////////////////
24250 . ////////////////////////////////////////////////////////////////////////////
24251
24252 .chapter "Address rewriting" "CHAPrewrite"
24253 .scindex IIDaddrew "rewriting" "addresses"
24254 There are some circumstances in which Exim automatically rewrites domains in
24255 addresses. The two most common are when an address is given without a domain
24256 (referred to as an &"unqualified address"&) or when an address contains an
24257 abbreviated domain that is expanded by DNS lookup.
24258
24259 Unqualified envelope addresses are accepted only for locally submitted
24260 messages, or for messages that are received from hosts matching
24261 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24262 appropriate. Unqualified addresses in header lines are qualified if they are in
24263 locally submitted messages, or messages from hosts that are permitted to send
24264 unqualified envelope addresses. Otherwise, unqualified addresses in header
24265 lines are neither qualified nor rewritten.
24266
24267 One situation in which Exim does &'not'& automatically rewrite a domain is
24268 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24269 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24270 do this. The new RFCs do not contain this suggestion.
24271
24272
24273 .section "Explicitly configured address rewriting" "SECID147"
24274 This chapter describes the rewriting rules that can be used in the
24275 main rewrite section of the configuration file, and also in the generic
24276 &%headers_rewrite%& option that can be set on any transport.
24277
24278 Some people believe that configured address rewriting is a Mortal Sin.
24279 Others believe that life is not possible without it. Exim provides the
24280 facility; you do not have to use it.
24281
24282 The main rewriting rules that appear in the &"rewrite"& section of the
24283 configuration file are applied to addresses in incoming messages, both envelope
24284 addresses and addresses in header lines. Each rule specifies the types of
24285 address to which it applies.
24286
24287 Whether or not addresses in header lines are rewritten depends on the origin of
24288 the headers and the type of rewriting. Global rewriting, that is, rewriting
24289 rules from the rewrite section of the configuration file, is applied only to
24290 those headers that were received with the message. Header lines that are added
24291 by ACLs or by a system filter or by individual routers or transports (which
24292 are specific to individual recipient addresses) are not rewritten by the global
24293 rules.
24294
24295 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24296 applies all headers except those added by routers and transports. That is, as
24297 well as the headers that were received with the message, it also applies to
24298 headers that were added by an ACL or a system filter.
24299
24300
24301 In general, rewriting addresses from your own system or domain has some
24302 legitimacy. Rewriting other addresses should be done only with great care and
24303 in special circumstances. The author of Exim believes that rewriting should be
24304 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24305 Although it can sometimes be used as a routing tool, this is very strongly
24306 discouraged.
24307
24308 There are two commonly encountered circumstances where rewriting is used, as
24309 illustrated by these examples:
24310
24311 .ilist
24312 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24313 exchange mail with each other behind a firewall, but there is only a single
24314 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24315 &'hitch.fict.example'& when sending mail off-site.
24316 .next
24317 A host rewrites the local parts of its own users so that, for example,
24318 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24319 .endlist
24320
24321
24322
24323 .section "When does rewriting happen?" "SECID148"
24324 .cindex "rewriting" "timing of"
24325 .cindex "&ACL;" "rewriting addresses in"
24326 Configured address rewriting can take place at several different stages of a
24327 message's processing.
24328
24329 .vindex "&$sender_address$&"
24330 At the start of an ACL for MAIL, the sender address may have been rewritten
24331 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24332 ordinary rewrite rules have yet been applied. If, however, the sender address
24333 is verified in the ACL, it is rewritten before verification, and remains
24334 rewritten thereafter. The subsequent value of &$sender_address$& is the
24335 rewritten address. This also applies if sender verification happens in a
24336 RCPT ACL. Otherwise, when the sender address is not verified, it is
24337 rewritten as soon as a message's header lines have been received.
24338
24339 .vindex "&$domain$&"
24340 .vindex "&$local_part$&"
24341 Similarly, at the start of an ACL for RCPT, the current recipient's address
24342 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24343 rewrite rules have yet been applied to it. However, the behaviour is different
24344 from the sender address when a recipient is verified. The address is rewritten
24345 for the verification, but the rewriting is not remembered at this stage. The
24346 value of &$local_part$& and &$domain$& after verification are always the same
24347 as they were before (that is, they contain the unrewritten &-- except for
24348 SMTP-time rewriting &-- address).
24349
24350 As soon as a message's header lines have been received, all the envelope
24351 recipient addresses are permanently rewritten, and rewriting is also applied to
24352 the addresses in the header lines (if configured). This happens before adding
24353 any header lines that were specified in MAIL or RCPT ACLs, and
24354 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24355 before the DATA ACL and &[local_scan()]& functions are run.
24356
24357 When an address is being routed, either for delivery or for verification,
24358 rewriting is applied immediately to child addresses that are generated by
24359 redirection, unless &%no_rewrite%& is set on the router.
24360
24361 .cindex "envelope sender" "rewriting at transport time"
24362 .cindex "rewriting" "at transport time"
24363 .cindex "header lines" "rewriting at transport time"
24364 At transport time, additional rewriting of addresses in header lines can be
24365 specified by setting the generic &%headers_rewrite%& option on a transport.
24366 This option contains rules that are identical in form to those in the rewrite
24367 section of the configuration file. They are applied to the original message
24368 header lines and any that were added by ACLs or a system filter. They are not
24369 applied to header lines that are added by routers or the transport.
24370
24371 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24372 transport option. However, it is not possible to rewrite envelope recipients at
24373 transport time.
24374
24375
24376
24377
24378 .section "Testing the rewriting rules that apply on input" "SECID149"
24379 .cindex "rewriting" "testing"
24380 .cindex "testing" "rewriting"
24381 Exim's input rewriting configuration appears in a part of the run time
24382 configuration file headed by &"begin rewrite"&. It can be tested by the
24383 &%-brw%& command line option. This takes an address (which can be a full RFC
24384 2822 address) as its argument. The output is a list of how the address would be
24385 transformed by the rewriting rules for each of the different places it might
24386 appear in an incoming message, that is, for each different header and for the
24387 envelope sender and recipient fields. For example,
24388 .code
24389 exim -brw ph10@exim.workshop.example
24390 .endd
24391 might produce the output
24392 .code
24393 sender: Philip.Hazel@exim.workshop.example
24394 from: Philip.Hazel@exim.workshop.example
24395 to: ph10@exim.workshop.example
24396 cc: ph10@exim.workshop.example
24397 bcc: ph10@exim.workshop.example
24398 reply-to: Philip.Hazel@exim.workshop.example
24399 env-from: Philip.Hazel@exim.workshop.example
24400 env-to: ph10@exim.workshop.example
24401 .endd
24402 which shows that rewriting has been set up for that address when used in any of
24403 the source fields, but not when it appears as a recipient address. At the
24404 present time, there is no equivalent way of testing rewriting rules that are
24405 set for a particular transport.
24406
24407
24408 .section "Rewriting rules" "SECID150"
24409 .cindex "rewriting" "rules"
24410 The rewrite section of the configuration file consists of lines of rewriting
24411 rules in the form
24412 .display
24413 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24414 .endd
24415 Rewriting rules that are specified for the &%headers_rewrite%& generic
24416 transport option are given as a colon-separated list. Each item in the list
24417 takes the same form as a line in the main rewriting configuration (except that
24418 any colons must be doubled, of course).
24419
24420 The formats of source patterns and replacement strings are described below.
24421 Each is terminated by white space, unless enclosed in double quotes, in which
24422 case normal quoting conventions apply inside the quotes. The flags are single
24423 characters which may appear in any order. Spaces and tabs between them are
24424 ignored.
24425
24426 For each address that could potentially be rewritten, the rules are scanned in
24427 order, and replacements for the address from earlier rules can themselves be
24428 replaced by later rules (but see the &"q"& and &"R"& flags).
24429
24430 The order in which addresses are rewritten is undefined, may change between
24431 releases, and must not be relied on, with one exception: when a message is
24432 received, the envelope sender is always rewritten first, before any header
24433 lines are rewritten. For example, the replacement string for a rewrite of an
24434 address in &'To:'& must not assume that the message's address in &'From:'& has
24435 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24436 that the envelope sender has already been rewritten.
24437
24438 .vindex "&$domain$&"
24439 .vindex "&$local_part$&"
24440 The variables &$local_part$& and &$domain$& can be used in the replacement
24441 string to refer to the address that is being rewritten. Note that lookup-driven
24442 rewriting can be done by a rule of the form
24443 .code
24444 *@*   ${lookup ...
24445 .endd
24446 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24447 refer to the address that is being rewritten.
24448
24449
24450 .section "Rewriting patterns" "SECID151"
24451 .cindex "rewriting" "patterns"
24452 .cindex "address list" "in a rewriting pattern"
24453 The source pattern in a rewriting rule is any item which may appear in an
24454 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24455 single-item address list, which means that it is expanded before being tested
24456 against the address. As always, if you use a regular expression as a pattern,
24457 you must take care to escape dollar and backslash characters, or use the &`\N`&
24458 facility to suppress string expansion within the regular expression.
24459
24460 Domains in patterns should be given in lower case. Local parts in patterns are
24461 case-sensitive. If you want to do case-insensitive matching of local parts, you
24462 can use a regular expression that starts with &`^(?i)`&.
24463
24464 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24465 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24466 depending on the type of match which occurred. These can be used in the
24467 replacement string to insert portions of the incoming address. &$0$& always
24468 refers to the complete incoming address. When a regular expression is used, the
24469 numerical variables are set from its capturing subexpressions. For other types
24470 of pattern they are set as follows:
24471
24472 .ilist
24473 If a local part or domain starts with an asterisk, the numerical variables
24474 refer to the character strings matched by asterisks, with &$1$& associated with
24475 the first asterisk, and &$2$& with the second, if present. For example, if the
24476 pattern
24477 .code
24478 *queen@*.fict.example
24479 .endd
24480 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24481 .code
24482 $0 = hearts-queen@wonderland.fict.example
24483 $1 = hearts-
24484 $2 = wonderland
24485 .endd
24486 Note that if the local part does not start with an asterisk, but the domain
24487 does, it is &$1$& that contains the wild part of the domain.
24488
24489 .next
24490 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24491 of the domain are placed in the next available numerical variables. Suppose,
24492 for example, that the address &'foo@bar.baz.example'& is processed by a
24493 rewriting rule of the form
24494 .display
24495 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24496 .endd
24497 and the key in the file that matches the domain is &`*.baz.example`&. Then
24498 .code
24499 $1 = foo
24500 $2 = bar
24501 $3 = baz.example
24502 .endd
24503 If the address &'foo@baz.example'& is looked up, this matches the same
24504 wildcard file entry, and in this case &$2$& is set to the empty string, but
24505 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24506 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24507 whole domain. For non-partial domain lookups, no numerical variables are set.
24508 .endlist
24509
24510
24511 .section "Rewriting replacements" "SECID152"
24512 .cindex "rewriting" "replacements"
24513 If the replacement string for a rule is a single asterisk, addresses that
24514 match the pattern and the flags are &'not'& rewritten, and no subsequent
24515 rewriting rules are scanned. For example,
24516 .code
24517 hatta@lookingglass.fict.example  *  f
24518 .endd
24519 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24520 &'From:'& headers.
24521
24522 .vindex "&$domain$&"
24523 .vindex "&$local_part$&"
24524 If the replacement string is not a single asterisk, it is expanded, and must
24525 yield a fully qualified address. Within the expansion, the variables
24526 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24527 Any letters they contain retain their original case &-- they are not lower
24528 cased. The numerical variables are set up according to the type of pattern that
24529 matched the address, as described above. If the expansion is forced to fail by
24530 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24531 current rule is abandoned, but subsequent rules may take effect. Any other
24532 expansion failure causes the entire rewriting operation to be abandoned, and an
24533 entry written to the panic log.
24534
24535
24536
24537 .section "Rewriting flags" "SECID153"
24538 There are three different kinds of flag that may appear on rewriting rules:
24539
24540 .ilist
24541 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24542 c, f, h, r, s, t.
24543 .next
24544 A flag that specifies rewriting at SMTP time: S.
24545 .next
24546 Flags that control the rewriting process: Q, q, R, w.
24547 .endlist
24548
24549 For rules that are part of the &%headers_rewrite%& generic transport option,
24550 E, F, T, and S are not permitted.
24551
24552
24553
24554 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24555          "SECID154"
24556 .cindex "rewriting" "flags"
24557 If none of the following flag letters, nor the &"S"& flag (see section
24558 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24559 and to both the sender and recipient fields of the envelope, whereas a
24560 transport-time rewriting rule just applies to all headers. Otherwise, the
24561 rewriting rule is skipped unless the relevant addresses are being processed.
24562 .display
24563 &`E`&       rewrite all envelope fields
24564 &`F`&       rewrite the envelope From field
24565 &`T`&       rewrite the envelope To field
24566 &`b`&       rewrite the &'Bcc:'& header
24567 &`c`&       rewrite the &'Cc:'& header
24568 &`f`&       rewrite the &'From:'& header
24569 &`h`&       rewrite all headers
24570 &`r`&       rewrite the &'Reply-To:'& header
24571 &`s`&       rewrite the &'Sender:'& header
24572 &`t`&       rewrite the &'To:'& header
24573 .endd
24574 "All headers" means all of the headers listed above that can be selected
24575 individually, plus their &'Resent-'& versions. It does not include
24576 other headers such as &'Subject:'& etc.
24577
24578 You should be particularly careful about rewriting &'Sender:'& headers, and
24579 restrict this to special known cases in your own domains.
24580
24581
24582 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24583 .cindex "SMTP" "rewriting malformed addresses"
24584 .cindex "RCPT" "rewriting argument of"
24585 .cindex "MAIL" "rewriting argument of"
24586 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24587 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24588 before any other processing; even before syntax checking. The pattern is
24589 required to be a regular expression, and it is matched against the whole of the
24590 data for the command, including any surrounding angle brackets.
24591
24592 .vindex "&$domain$&"
24593 .vindex "&$local_part$&"
24594 This form of rewrite rule allows for the handling of addresses that are not
24595 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24596 input). Because the input is not required to be a syntactically valid address,
24597 the variables &$local_part$& and &$domain$& are not available during the
24598 expansion of the replacement string. The result of rewriting replaces the
24599 original address in the MAIL or RCPT command.
24600
24601
24602 .section "Flags controlling the rewriting process" "SECID155"
24603 There are four flags which control the way the rewriting process works. These
24604 take effect only when a rule is invoked, that is, when the address is of the
24605 correct type (matches the flags) and matches the pattern:
24606
24607 .ilist
24608 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24609 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24610 absence of &"Q"& the rewritten address must always include a domain.
24611 .next
24612 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24613 even if no rewriting actually takes place because of a &"fail"& in the
24614 expansion. The &"q"& flag is not effective if the address is of the wrong type
24615 (does not match the flags) or does not match the pattern.
24616 .next
24617 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24618 address, up to ten times. It can be combined with the &"q"& flag, to stop
24619 rewriting once it fails to match (after at least one successful rewrite).
24620 .next
24621 .cindex "rewriting" "whole addresses"
24622 When an address in a header is rewritten, the rewriting normally applies only
24623 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24624 left unchanged. For example, rewriting might change
24625 .code
24626 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24627 .endd
24628 into
24629 .code
24630 From: Ford Prefect <prefectf@hitch.fict.example>
24631 .endd
24632 .cindex "RFC 2047"
24633 Sometimes there is a need to replace the whole address item, and this can be
24634 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24635 causes an address in a header line to be rewritten, the entire address is
24636 replaced, not just the working part. The replacement must be a complete RFC
24637 2822 address, including the angle brackets if necessary. If text outside angle
24638 brackets contains a character whose value is greater than 126 or less than 32
24639 (except for tab), the text is encoded according to RFC 2047. The character set
24640 is taken from &%headers_charset%&, which gets its default at build time.
24641
24642 When the &"w"& flag is set on a rule that causes an envelope address to be
24643 rewritten, all but the working part of the replacement address is discarded.
24644 .endlist
24645
24646
24647 .section "Rewriting examples" "SECID156"
24648 Here is an example of the two common rewriting paradigms:
24649 .code
24650 *@*.hitch.fict.example  $1@hitch.fict.example
24651 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24652                      {$value}fail}@hitch.fict.example bctfrF
24653 .endd
24654 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24655 the string expansion to fail if the lookup does not succeed. In this context it
24656 has the effect of leaving the original address unchanged, but Exim goes on to
24657 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24658 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24659 explicitly, which would cause the rewritten address to be the same as before,
24660 at the cost of a small bit of processing. Not supplying either of these is an
24661 error, since the rewritten address would then contain no local part.
24662
24663 The first example above replaces the domain with a superior, more general
24664 domain. This may not be desirable for certain local parts. If the rule
24665 .code
24666 root@*.hitch.fict.example  *
24667 .endd
24668 were inserted before the first rule, rewriting would be suppressed for the
24669 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24670
24671 Rewriting can be made conditional on a number of tests, by making use of
24672 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24673 messages that originate outside the local host:
24674 .code
24675 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24676                          {$1@hitch.fict.example}fail}"
24677 .endd
24678 The replacement string is quoted in this example because it contains white
24679 space.
24680
24681 .cindex "rewriting" "bang paths"
24682 .cindex "bang paths" "rewriting"
24683 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24684 an address it treats it as an unqualified local part which it qualifies with
24685 the local qualification domain (if the source of the message is local or if the
24686 remote host is permitted to send unqualified addresses). Rewriting can
24687 sometimes be used to handle simple bang paths with a fixed number of
24688 components. For example, the rule
24689 .code
24690 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24691 .endd
24692 rewrites a two-component bang path &'host.name!user'& as the domain address
24693 &'user@host.name'&. However, there is a security implication in using this as
24694 a global rewriting rule for envelope addresses. It can provide a backdoor
24695 method for using your system as a relay, because the incoming addresses appear
24696 to be local. If the bang path addresses are received via SMTP, it is safer to
24697 use the &"S"& flag to rewrite them as they are received, so that relay checking
24698 can be done on the rewritten addresses.
24699 .ecindex IIDaddrew
24700
24701
24702
24703
24704
24705 . ////////////////////////////////////////////////////////////////////////////
24706 . ////////////////////////////////////////////////////////////////////////////
24707
24708 .chapter "Retry configuration" "CHAPretry"
24709 .scindex IIDretconf1 "retry" "configuration, description of"
24710 .scindex IIDregconf2 "configuration file" "retry section"
24711 The &"retry"& section of the runtime configuration file contains a list of
24712 retry rules that control how often Exim tries to deliver messages that cannot
24713 be delivered at the first attempt. If there are no retry rules (the section is
24714 empty or not present), there are no retries. In this situation, temporary
24715 errors are treated as permanent. The default configuration contains a single,
24716 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24717 line option can be used to test which retry rule will be used for a given
24718 address, domain and error.
24719
24720 The most common cause of retries is temporary failure to deliver to a remote
24721 host because the host is down, or inaccessible because of a network problem.
24722 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24723 address) basis, not on a per-message basis. Thus, if one message has recently
24724 been delayed, delivery of a new message to the same host is not immediately
24725 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24726 log selector is set, the message
24727 .cindex "retry" "time not reached"
24728 &"retry time not reached"& is written to the main log whenever a delivery is
24729 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24730 the handling of errors during remote deliveries.
24731
24732 Retry processing applies to routing as well as to delivering, except as covered
24733 in the next paragraph. The retry rules do not distinguish between these
24734 actions. It is not possible, for example, to specify different behaviour for
24735 failures to route the domain &'snark.fict.example'& and failures to deliver to
24736 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24737 added complication, so did not implement it. However, although they share the
24738 same retry rule, the actual retry times for routing and transporting a given
24739 domain are maintained independently.
24740
24741 When a delivery is not part of a queue run (typically an immediate delivery on
24742 receipt of a message), the routers are always run, and local deliveries are
24743 always attempted, even if retry times are set for them. This makes for better
24744 behaviour if one particular message is causing problems (for example, causing
24745 quota overflow, or provoking an error in a filter file). If such a delivery
24746 suffers a temporary failure, the retry data is updated as normal, and
24747 subsequent delivery attempts from queue runs occur only when the retry time for
24748 the local address is reached.
24749
24750 .section "Changing retry rules" "SECID157"
24751 If you change the retry rules in your configuration, you should consider
24752 whether or not to delete the retry data that is stored in Exim's spool area in
24753 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24754 always safe; that is why they are called &"hints"&.
24755
24756 The hints retry data contains suggested retry times based on the previous
24757 rules. In the case of a long-running problem with a remote host, it might
24758 record the fact that the host has timed out. If your new rules increase the
24759 timeout time for such a host, you should definitely remove the old retry data
24760 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24761 messages that it should now be retaining.
24762
24763
24764
24765 .section "Format of retry rules" "SECID158"
24766 .cindex "retry" "rules"
24767 Each retry rule occupies one line and consists of three or four parts,
24768 separated by white space: a pattern, an error name, an optional list of sender
24769 addresses, and a list of retry parameters. The pattern and sender lists must be
24770 enclosed in double quotes if they contain white space. The rules are searched
24771 in order until one is found where the pattern, error name, and sender list (if
24772 present) match the failing host or address, the error that occurred, and the
24773 message's sender, respectively.
24774
24775
24776 The pattern is any single item that may appear in an address list (see section
24777 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24778 which means that it is expanded before being tested against the address that
24779 has been delayed. A negated address list item is permitted. Address
24780 list processing treats a plain domain name as if it were preceded by &"*@"&,
24781 which makes it possible for many retry rules to start with just a domain. For
24782 example,
24783 .code
24784 lookingglass.fict.example        *  F,24h,30m;
24785 .endd
24786 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24787 whereas
24788 .code
24789 alice@lookingglass.fict.example  *  F,24h,30m;
24790 .endd
24791 applies only to temporary failures involving the local part &%alice%&.
24792 In practice, almost all rules start with a domain name pattern without a local
24793 part.
24794
24795 .cindex "regular expressions" "in retry rules"
24796 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24797 must match a complete address, not just a domain, because that is how regular
24798 expressions work in address lists.
24799 .display
24800 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24801 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24802 .endd
24803
24804
24805 .section "Choosing which retry rule to use for address errors" "SECID159"
24806 When Exim is looking for a retry rule after a routing attempt has failed (for
24807 example, after a DNS timeout), each line in the retry configuration is tested
24808 against the complete address only if &%retry_use_local_part%& is set for the
24809 router. Otherwise, only the domain is used, except when matching against a
24810 regular expression, when the local part of the address is replaced with &"*"&.
24811 A domain on its own can match a domain pattern, or a pattern that starts with
24812 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24813 &%check_local_user%& is true, and false for other routers.
24814
24815 Similarly, when Exim is looking for a retry rule after a local delivery has
24816 failed (for example, after a mailbox full error), each line in the retry
24817 configuration is tested against the complete address only if
24818 &%retry_use_local_part%& is set for the transport (it defaults true for all
24819 local transports).
24820
24821 .cindex "4&'xx'& responses" "retry rules for"
24822 However, when Exim is looking for a retry rule after a remote delivery attempt
24823 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24824 whole address is always used as the key when searching the retry rules. The
24825 rule that is found is used to create a retry time for the combination of the
24826 failing address and the message's sender. It is the combination of sender and
24827 recipient that is delayed in subsequent queue runs until its retry time is
24828 reached. You can delay the recipient without regard to the sender by setting
24829 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24830 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24831 commands.
24832
24833
24834
24835 .section "Choosing which retry rule to use for host and message errors" &&&
24836          "SECID160"
24837 For a temporary error that is not related to an individual address (for
24838 example, a connection timeout), each line in the retry configuration is checked
24839 twice. First, the name of the remote host is used as a domain name (preceded by
24840 &"*@"& when matching a regular expression). If this does not match the line,
24841 the domain from the email address is tried in a similar fashion. For example,
24842 suppose the MX records for &'a.b.c.example'& are
24843 .code
24844 a.b.c.example  MX  5  x.y.z.example
24845                MX  6  p.q.r.example
24846                MX  7  m.n.o.example
24847 .endd
24848 and the retry rules are
24849 .code
24850 p.q.r.example    *      F,24h,30m;
24851 a.b.c.example    *      F,4d,45m;
24852 .endd
24853 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24854 first rule matches neither the host nor the domain, so Exim looks at the second
24855 rule. This does not match the host, but it does match the domain, so it is used
24856 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24857 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24858 first retry rule is used, because it matches the host.
24859
24860 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24861 first rule to determine retry times, but for all the other hosts for the domain
24862 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24863 routing to &'a.b.c.example'& suffers a temporary failure.
24864
24865 &*Note*&: The host name is used when matching the patterns, not its IP address.
24866 However, if a message is routed directly to an IP address without the use of a
24867 host name, for example, if a &(manualroute)& router contains a setting such as:
24868 .code
24869 route_list = *.a.example  192.168.34.23
24870 .endd
24871 then the &"host name"& that is used when searching for a retry rule is the
24872 textual form of the IP address.
24873
24874 .section "Retry rules for specific errors" "SECID161"
24875 .cindex "retry" "specific errors; specifying"
24876 The second field in a retry rule is the name of a particular error, or an
24877 asterisk, which matches any error. The errors that can be tested for are:
24878
24879 .vlist
24880 .vitem &%auth_failed%&
24881 Authentication failed when trying to send to a host in the
24882 &%hosts_require_auth%& list in an &(smtp)& transport.
24883
24884 .vitem &%data_4xx%&
24885 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24886 after the command, or after sending the message's data.
24887
24888 .vitem &%mail_4xx%&
24889 A 4&'xx'& error was received for an outgoing MAIL command.
24890
24891 .vitem &%rcpt_4xx%&
24892 A 4&'xx'& error was received for an outgoing RCPT command.
24893 .endlist
24894
24895 For the three 4&'xx'& errors, either the first or both of the x's can be given
24896 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24897 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24898 and have retries every ten minutes with a one-hour timeout, you could set up a
24899 retry rule of this form:
24900 .code
24901 the.domain.name  rcpt_452   F,1h,10m
24902 .endd
24903 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24904 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24905
24906 .vlist
24907 .vitem &%lost_connection%&
24908 A server unexpectedly closed the SMTP connection. There may, of course,
24909 legitimate reasons for this (host died, network died), but if it repeats a lot
24910 for the same host, it indicates something odd.
24911
24912 .vitem &%lookup%&
24913 A DNS lookup for a host failed.
24914 Note that a &%dnslookup%& router will need to have matched
24915 its &%fail_defer_domains%& option for this retry type to be usable.
24916 Also note that a &%manualroute%& router will probably need
24917 its &%host_find_failed%& option set to &%defer%&.
24918
24919 .vitem &%refused_MX%&
24920 A connection to a host obtained from an MX record was refused.
24921
24922 .vitem &%refused_A%&
24923 A connection to a host not obtained from an MX record was refused.
24924
24925 .vitem &%refused%&
24926 A connection was refused.
24927
24928 .vitem &%timeout_connect_MX%&
24929 A connection attempt to a host obtained from an MX record timed out.
24930
24931 .vitem &%timeout_connect_A%&
24932 A connection attempt to a host not obtained from an MX record timed out.
24933
24934 .vitem &%timeout_connect%&
24935 A connection attempt timed out.
24936
24937 .vitem &%timeout_MX%&
24938 There was a timeout while connecting or during an SMTP session with a host
24939 obtained from an MX record.
24940
24941 .vitem &%timeout_A%&
24942 There was a timeout while connecting or during an SMTP session with a host not
24943 obtained from an MX record.
24944
24945 .vitem &%timeout%&
24946 There was a timeout while connecting or during an SMTP session.
24947
24948 .vitem &%tls_required%&
24949 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24950 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24951 to STARTTLS, or there was a problem setting up the TLS connection.
24952
24953 .vitem &%quota%&
24954 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24955 transport.
24956
24957 .vitem &%quota_%&<&'time'&>
24958 .cindex "quota" "error testing in retry rule"
24959 .cindex "retry" "quota error testing"
24960 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24961 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24962 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24963 for four days.
24964 .endlist
24965
24966 .cindex "mailbox" "time of last read"
24967 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24968 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24969 it should be based on the last time that the user accessed the mailbox.
24970 However, it is not always possible to determine this. Exim uses the following
24971 heuristic rules:
24972
24973 .ilist
24974 If the mailbox is a single file, the time of last access (the &"atime"&) is
24975 used. As no new messages are being delivered (because the mailbox is over
24976 quota), Exim does not access the file, so this is the time of last user access.
24977 .next
24978 .cindex "maildir format" "time of last read"
24979 For a maildir delivery, the time of last modification of the &_new_&
24980 subdirectory is used. As the mailbox is over quota, no new files are created in
24981 the &_new_& subdirectory, because no new messages are being delivered. Any
24982 change to the &_new_& subdirectory is therefore assumed to be the result of an
24983 MUA moving a new message to the &_cur_& directory when it is first read. The
24984 time that is used is therefore the last time that the user read a new message.
24985 .next
24986 For other kinds of multi-file mailbox, the time of last access cannot be
24987 obtained, so a retry rule that uses this type of error field is never matched.
24988 .endlist
24989
24990 The quota errors apply both to system-enforced quotas and to Exim's own quota
24991 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24992 when a local delivery is deferred because a partition is full (the ENOSPC
24993 error).
24994
24995
24996
24997 .section "Retry rules for specified senders" "SECID162"
24998 .cindex "retry" "rules; sender-specific"
24999 You can specify retry rules that apply only when the failing message has a
25000 specific sender. In particular, this can be used to define retry rules that
25001 apply only to bounce messages. The third item in a retry rule can be of this
25002 form:
25003 .display
25004 &`senders=`&<&'address list'&>
25005 .endd
25006 The retry timings themselves are then the fourth item. For example:
25007 .code
25008 *   rcpt_4xx   senders=:   F,1h,30m
25009 .endd
25010 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25011 host. If the address list contains white space, it must be enclosed in quotes.
25012 For example:
25013 .code
25014 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25015 .endd
25016 &*Warning*&: This facility can be unhelpful if it is used for host errors
25017 (which do not depend on the recipient). The reason is that the sender is used
25018 only to match the retry rule. Once the rule has been found for a host error,
25019 its contents are used to set a retry time for the host, and this will apply to
25020 all messages, not just those with specific senders.
25021
25022 When testing retry rules using &%-brt%&, you can supply a sender using the
25023 &%-f%& command line option, like this:
25024 .code
25025 exim -f "" -brt user@dom.ain
25026 .endd
25027 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25028 list is never matched.
25029
25030
25031
25032
25033
25034 .section "Retry parameters" "SECID163"
25035 .cindex "retry" "parameters in rules"
25036 The third (or fourth, if a senders list is present) field in a retry rule is a
25037 sequence of retry parameter sets, separated by semicolons. Each set consists of
25038 .display
25039 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25040 .endd
25041 The letter identifies the algorithm for computing a new retry time; the cutoff
25042 time is the time beyond which this algorithm no longer applies, and the
25043 arguments vary the algorithm's action. The cutoff time is measured from the
25044 time that the first failure for the domain (combined with the local part if
25045 relevant) was detected, not from the time the message was received.
25046
25047 .cindex "retry" "algorithms"
25048 .cindex "retry" "fixed intervals"
25049 .cindex "retry" "increasing intervals"
25050 .cindex "retry" "random intervals"
25051 The available algorithms are:
25052
25053 .ilist
25054 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25055 the interval.
25056 .next
25057 &'G'&: retry at geometrically increasing intervals. The first argument
25058 specifies a starting value for the interval, and the second a multiplier, which
25059 is used to increase the size of the interval at each retry.
25060 .next
25061 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25062 retry, the previous interval is multiplied by the factor in order to get a
25063 maximum for the next interval. The minimum interval is the first argument of
25064 the parameter, and an actual interval is chosen randomly between them. Such a
25065 rule has been found to be helpful in cluster configurations when all the
25066 members of the cluster restart at once, and may therefore synchronize their
25067 queue processing times.
25068 .endlist
25069
25070 When computing the next retry time, the algorithm definitions are scanned in
25071 order until one whose cutoff time has not yet passed is reached. This is then
25072 used to compute a new retry time that is later than the current time. In the
25073 case of fixed interval retries, this simply means adding the interval to the
25074 current time. For geometrically increasing intervals, retry intervals are
25075 computed from the rule's parameters until one that is greater than the previous
25076 interval is found. The main configuration variable
25077 .cindex "limit" "retry interval"
25078 .cindex "retry" "interval, maximum"
25079 .oindex "&%retry_interval_max%&"
25080 &%retry_interval_max%& limits the maximum interval between retries. It
25081 cannot be set greater than &`24h`&, which is its default value.
25082
25083 A single remote domain may have a number of hosts associated with it, and each
25084 host may have more than one IP address. Retry algorithms are selected on the
25085 basis of the domain name, but are applied to each IP address independently. If,
25086 for example, a host has two IP addresses and one is unusable, Exim will
25087 generate retry times for it and will not try to use it until its next retry
25088 time comes. Thus the good IP address is likely to be tried first most of the
25089 time.
25090
25091 .cindex "hints database" "use for retrying"
25092 Retry times are hints rather than promises. Exim does not make any attempt to
25093 run deliveries exactly at the computed times. Instead, a queue runner process
25094 starts delivery processes for delayed messages periodically, and these attempt
25095 new deliveries only for those addresses that have passed their next retry time.
25096 If a new message arrives for a deferred address, an immediate delivery attempt
25097 occurs only if the address has passed its retry time. In the absence of new
25098 messages, the minimum time between retries is the interval between queue runner
25099 processes. There is not much point in setting retry times of five minutes if
25100 your queue runners happen only once an hour, unless there are a significant
25101 number of incoming messages (which might be the case on a system that is
25102 sending everything to a smart host, for example).
25103
25104 The data in the retry hints database can be inspected by using the
25105 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25106 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25107 &'exinext'& utility script can be used to find out what the next retry times
25108 are for the hosts associated with a particular mail domain, and also for local
25109 deliveries that have been deferred.
25110
25111
25112 .section "Retry rule examples" "SECID164"
25113 Here are some example retry rules:
25114 .code
25115 alice@wonderland.fict.example quota_5d  F,7d,3h
25116 wonderland.fict.example       quota_5d
25117 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25118 lookingglass.fict.example     *         F,24h,30m;
25119 *                 refused_A   F,2h,20m;
25120 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25121 .endd
25122 The first rule sets up special handling for mail to
25123 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25124 mailbox has not been read for at least 5 days. Retries continue every three
25125 hours for 7 days. The second rule handles over-quota errors for all other local
25126 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25127 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25128 fail are bounced immediately if the mailbox has not been read for at least 5
25129 days.
25130
25131 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25132 happen every 15 minutes for an hour, then with geometrically increasing
25133 intervals until two days have passed since a delivery first failed. After the
25134 first hour there is a delay of one hour, then two hours, then four hours, and
25135 so on (this is a rather extreme example).
25136
25137 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25138 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25139 all other domains, with special action for connection refusal from hosts that
25140 were not obtained from an MX record.
25141
25142 The final rule in a retry configuration should always have asterisks in the
25143 first two fields so as to provide a general catch-all for any addresses that do
25144 not have their own special handling. This example tries every 15 minutes for 2
25145 hours, then with intervals starting at one hour and increasing by a factor of
25146 1.5 up to 16 hours, then every 8 hours up to 5 days.
25147
25148
25149
25150 .section "Timeout of retry data" "SECID165"
25151 .cindex "timeout" "of retry data"
25152 .oindex "&%retry_data_expire%&"
25153 .cindex "hints database" "data expiry"
25154 .cindex "retry" "timeout of data"
25155 Exim timestamps the data that it writes to its retry hints database. When it
25156 consults the data during a delivery it ignores any that is older than the value
25157 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25158 been tried for 7 days, Exim will try to deliver to it immediately a message
25159 arrives, and if that fails, it will calculate a retry time as if it were
25160 failing for the first time.
25161
25162 This improves the behaviour for messages routed to rarely-used hosts such as MX
25163 backups. If such a host was down at one time, and happens to be down again when
25164 Exim tries a month later, using the old retry data would imply that it had been
25165 down all the time, which is not a justified assumption.
25166
25167 If a host really is permanently dead, this behaviour causes a burst of retries
25168 every now and again, but only if messages routed to it are rare. If there is a
25169 message at least once every 7 days the retry data never expires.
25170
25171
25172
25173
25174 .section "Long-term failures" "SECID166"
25175 .cindex "delivery failure, long-term"
25176 .cindex "retry" "after long-term failure"
25177 Special processing happens when an email address has been failing for so long
25178 that the cutoff time for the last algorithm is reached. For example, using the
25179 default retry rule:
25180 .code
25181 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25182 .endd
25183 the cutoff time is four days. Reaching the retry cutoff is independent of how
25184 long any specific message has been failing; it is the length of continuous
25185 failure for the recipient address that counts.
25186
25187 When the cutoff time is reached for a local delivery, or for all the IP
25188 addresses associated with a remote delivery, a subsequent delivery failure
25189 causes Exim to give up on the address, and a bounce message is generated.
25190 In order to cater for new messages that use the failing address, a next retry
25191 time is still computed from the final algorithm, and is used as follows:
25192
25193 For local deliveries, one delivery attempt is always made for any subsequent
25194 messages. If this delivery fails, the address fails immediately. The
25195 post-cutoff retry time is not used.
25196
25197 If the delivery is remote, there are two possibilities, controlled by the
25198 .oindex "&%delay_after_cutoff%&"
25199 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25200 default. Until the post-cutoff retry time for one of the IP addresses is
25201 reached, the failing email address is bounced immediately, without a delivery
25202 attempt taking place. After that time, one new delivery attempt is made to
25203 those IP addresses that are past their retry times, and if that still fails,
25204 the address is bounced and new retry times are computed.
25205
25206 In other words, when all the hosts for a given email address have been failing
25207 for a long time, Exim bounces rather then defers until one of the hosts' retry
25208 times is reached. Then it tries once, and bounces if that attempt fails. This
25209 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25210 to a broken destination, but if the host does recover, Exim will eventually
25211 notice.
25212
25213 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25214 addresses are past their final cutoff time, Exim tries to deliver to those IP
25215 addresses that have not been tried since the message arrived. If there are
25216 no suitable IP addresses, or if they all fail, the address is bounced. In other
25217 words, it does not delay when a new message arrives, but tries the expired
25218 addresses immediately, unless they have been tried since the message arrived.
25219 If there is a continuous stream of messages for the failing domains, setting
25220 &%delay_after_cutoff%& false means that there will be many more attempts to
25221 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25222 true.
25223
25224 .section "Deliveries that work intermittently" "SECID167"
25225 .cindex "retry" "intermittently working deliveries"
25226 Some additional logic is needed to cope with cases where a host is
25227 intermittently available, or when a message has some attribute that prevents
25228 its delivery when others to the same address get through. In this situation,
25229 because some messages are successfully delivered, the &"retry clock"& for the
25230 host or address keeps getting reset by the successful deliveries, and so
25231 failing messages remain on the queue for ever because the cutoff time is never
25232 reached.
25233
25234 Two exceptional actions are applied to prevent this happening. The first
25235 applies to errors that are related to a message rather than a remote host.
25236 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25237 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25238 commands, and quota failures. For this type of error, if a message's arrival
25239 time is earlier than the &"first failed"& time for the error, the earlier time
25240 is used when scanning the retry rules to decide when to try next and when to
25241 time out the address.
25242
25243 The exceptional second action applies in all cases. If a message has been on
25244 the queue for longer than the cutoff time of any applicable retry rule for a
25245 given address, a delivery is attempted for that address, even if it is not yet
25246 time, and if this delivery fails, the address is timed out. A new retry time is
25247 not computed in this case, so that other messages for the same address are
25248 considered immediately.
25249 .ecindex IIDretconf1
25250 .ecindex IIDregconf2
25251
25252
25253
25254
25255
25256
25257 . ////////////////////////////////////////////////////////////////////////////
25258 . ////////////////////////////////////////////////////////////////////////////
25259
25260 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25261 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25262 .scindex IIDauthconf2 "authentication"
25263 The &"authenticators"& section of Exim's run time configuration is concerned
25264 with SMTP authentication. This facility is an extension to the SMTP protocol,
25265 described in RFC 2554, which allows a client SMTP host to authenticate itself
25266 to a server. This is a common way for a server to recognize clients that are
25267 permitted to use it as a relay. SMTP authentication is not of relevance to the
25268 transfer of mail between servers that have no managerial connection with each
25269 other.
25270
25271 .cindex "AUTH" "description of"
25272 Very briefly, the way SMTP authentication works is as follows:
25273
25274 .ilist
25275 The server advertises a number of authentication &'mechanisms'& in response to
25276 the client's EHLO command.
25277 .next
25278 The client issues an AUTH command, naming a specific mechanism. The command
25279 may, optionally, contain some authentication data.
25280 .next
25281 The server may issue one or more &'challenges'&, to which the client must send
25282 appropriate responses. In simple authentication mechanisms, the challenges are
25283 just prompts for user names and passwords. The server does not have to issue
25284 any challenges &-- in some mechanisms the relevant data may all be transmitted
25285 with the AUTH command.
25286 .next
25287 The server either accepts or denies authentication.
25288 .next
25289 If authentication succeeds, the client may optionally make use of the AUTH
25290 option on the MAIL command to pass an authenticated sender in subsequent
25291 mail transactions. Authentication lasts for the remainder of the SMTP
25292 connection.
25293 .next
25294 If authentication fails, the client may give up, or it may try a different
25295 authentication mechanism, or it may try transferring mail over the
25296 unauthenticated connection.
25297 .endlist
25298
25299 If you are setting up a client, and want to know which authentication
25300 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25301 SMTP port) on the server, and issue an EHLO command. The response to this
25302 includes the list of supported mechanisms. For example:
25303 .display
25304 &`$ `&&*&`telnet server.example 25`&*&
25305 &`Trying 192.168.34.25...`&
25306 &`Connected to server.example.`&
25307 &`Escape character is &#x0027;^]&#x0027;.`&
25308 &`220 server.example ESMTP Exim 4.20 ...`&
25309 &*&`ehlo client.example`&*&
25310 &`250-server.example Hello client.example [10.8.4.5]`&
25311 &`250-SIZE 52428800`&
25312 &`250-PIPELINING`&
25313 &`250-AUTH PLAIN`&
25314 &`250 HELP`&
25315 .endd
25316 The second-last line of this example output shows that the server supports
25317 authentication using the PLAIN mechanism. In Exim, the different authentication
25318 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25319 routers and transports, which authenticators are included in the binary is
25320 controlled by build-time definitions. The following are currently available,
25321 included by setting
25322 .code
25323 AUTH_CRAM_MD5=yes
25324 AUTH_CYRUS_SASL=yes
25325 AUTH_DOVECOT=yes
25326 AUTH_GSASL=yes
25327 AUTH_HEIMDAL_GSSAPI=yes
25328 AUTH_PLAINTEXT=yes
25329 AUTH_SPA=yes
25330 AUTH_TLS=yes
25331 .endd
25332 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25333 authentication mechanism (RFC 2195), and the second provides an interface to
25334 the Cyrus SASL authentication library.
25335 The third is an interface to Dovecot's authentication system, delegating the
25336 work via a socket interface.
25337 The fourth provides an interface to the GNU SASL authentication library, which
25338 provides mechanisms but typically not data sources.
25339 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25340 supporting setting a server keytab.
25341 The sixth can be configured to support
25342 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25343 not formally documented, but used by several MUAs. The seventh authenticator
25344 supports Microsoft's &'Secure Password Authentication'& mechanism.
25345 The eighth is an Exim authenticator but not an SMTP one;
25346 instead it can use information from a TLS negotiation.
25347
25348 The authenticators are configured using the same syntax as other drivers (see
25349 section &<<SECTfordricon>>&). If no authenticators are required, no
25350 authentication section need be present in the configuration file. Each
25351 authenticator can in principle have both server and client functions. When Exim
25352 is receiving SMTP mail, it is acting as a server; when it is sending out
25353 messages over SMTP, it is acting as a client. Authenticator configuration
25354 options are provided for use in both these circumstances.
25355
25356 To make it clear which options apply to which situation, the prefixes
25357 &%server_%& and &%client_%& are used on option names that are specific to
25358 either the server or the client function, respectively. Server and client
25359 functions are disabled if none of their options are set. If an authenticator is
25360 to be used for both server and client functions, a single definition, using
25361 both sets of options, is required. For example:
25362 .code
25363 cram:
25364   driver = cram_md5
25365   public_name = CRAM-MD5
25366   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25367   client_name = ph10
25368   client_secret = secret2
25369 .endd
25370 The &%server_%& option is used when Exim is acting as a server, and the
25371 &%client_%& options when it is acting as a client.
25372
25373 Descriptions of the individual authenticators are given in subsequent chapters.
25374 The remainder of this chapter covers the generic options for the
25375 authenticators, followed by general discussion of the way authentication works
25376 in Exim.
25377
25378 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25379 per-mechanism basis.  Please read carefully to determine which variables hold
25380 account labels such as usercodes and which hold passwords or other
25381 authenticating data.
25382
25383 Note that some mechanisms support two different identifiers for accounts: the
25384 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25385 and &'authz'& are commonly encountered.  The American spelling is standard here.
25386 Conceptually, authentication data such as passwords are tied to the identifier
25387 used to authenticate; servers may have rules to permit one user to act as a
25388 second user, so that after login the session is treated as though that second
25389 user had logged in.  That second user is the &'authorization id'&.  A robust
25390 configuration might confirm that the &'authz'& field is empty or matches the
25391 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25392 as verified data, the &'authz'& as an unverified request which the server might
25393 choose to honour.
25394
25395 A &'realm'& is a text string, typically a domain name, presented by a server
25396 to a client to help it select an account and credentials to use.  In some
25397 mechanisms, the client and server provably agree on the realm, but clients
25398 typically can not treat the realm as secure data to be blindly trusted.
25399
25400
25401
25402 .section "Generic options for authenticators" "SECID168"
25403 .cindex "authentication" "generic options"
25404 .cindex "options" "generic; for authenticators"
25405
25406 .option client_condition authenticators string&!! unset
25407 When Exim is authenticating as a client, it skips any authenticator whose
25408 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25409 used, for example, to skip plain text authenticators when the connection is not
25410 encrypted by a setting such as:
25411 .code
25412 client_condition = ${if !eq{$tls_out_cipher}{}}
25413 .endd
25414
25415
25416 .option client_set_id authenticators string&!! unset
25417 When client authentication succeeds, this condition is expanded; the
25418 result is used in the log lines for outbound messages.
25419 Typically it will be the user name used for authentication.
25420
25421
25422 .option driver authenticators string unset
25423 This option must always be set. It specifies which of the available
25424 authenticators is to be used.
25425
25426
25427 .option public_name authenticators string unset
25428 This option specifies the name of the authentication mechanism that the driver
25429 implements, and by which it is known to the outside world. These names should
25430 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25431 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25432 defaults to the driver's instance name.
25433
25434
25435 .option server_advertise_condition authenticators string&!! unset
25436 When a server is about to advertise an authentication mechanism, the condition
25437 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25438 mechanism is not advertised.
25439 If the expansion fails, the mechanism is not advertised. If the failure was not
25440 forced, and was not caused by a lookup defer, the incident is logged.
25441 See section &<<SECTauthexiser>>& below for further discussion.
25442
25443
25444 .option server_condition authenticators string&!! unset
25445 This option must be set for a &%plaintext%& server authenticator, where it
25446 is used directly to control authentication. See section &<<SECTplainserver>>&
25447 for details.
25448
25449 For the &(gsasl)& authenticator, this option is required for various
25450 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25451
25452 For the other authenticators, &%server_condition%& can be used as an additional
25453 authentication or authorization mechanism that is applied after the other
25454 authenticator conditions succeed. If it is set, it is expanded when the
25455 authenticator would otherwise return a success code. If the expansion is forced
25456 to fail, authentication fails. Any other expansion failure causes a temporary
25457 error code to be returned. If the result of a successful expansion is an empty
25458 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25459 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25460 other result, a temporary error code is returned, with the expanded string as
25461 the error text.
25462
25463
25464 .option server_debug_print authenticators string&!! unset
25465 If this option is set and authentication debugging is enabled (see the &%-d%&
25466 command line option), the string is expanded and included in the debugging
25467 output when the authenticator is run as a server. This can help with checking
25468 out the values of variables.
25469 If expansion of the string fails, the error message is written to the debugging
25470 output, and Exim carries on processing.
25471
25472
25473 .option server_set_id authenticators string&!! unset
25474 .vindex "&$authenticated_id$&"
25475 When an Exim server successfully authenticates a client, this string is
25476 expanded using data from the authentication, and preserved for any incoming
25477 messages in the variable &$authenticated_id$&. It is also included in the log
25478 lines for incoming messages. For example, a user/password authenticator
25479 configuration might preserve the user name that was used to authenticate, and
25480 refer to it subsequently during delivery of the message.
25481 If expansion fails, the option is ignored.
25482
25483
25484 .option server_mail_auth_condition authenticators string&!! unset
25485 This option allows a server to discard authenticated sender addresses supplied
25486 as part of MAIL commands in SMTP connections that are authenticated by the
25487 driver on which &%server_mail_auth_condition%& is set. The option is not used
25488 as part of the authentication process; instead its (unexpanded) value is
25489 remembered for later use.
25490 How it is used is described in the following section.
25491
25492
25493
25494
25495
25496 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25497 .cindex "authentication" "sender; authenticated"
25498 .cindex "AUTH" "on MAIL command"
25499 When a client supplied an AUTH= item on a MAIL command, Exim applies
25500 the following checks before accepting it as the authenticated sender of the
25501 message:
25502
25503 .ilist
25504 If the connection is not using extended SMTP (that is, HELO was used rather
25505 than EHLO), the use of AUTH= is a syntax error.
25506 .next
25507 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25508 .next
25509 .vindex "&$authenticated_sender$&"
25510 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25511 running, the value of &$authenticated_sender$& is set to the value obtained
25512 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25513 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25514 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25515 given for the MAIL command.
25516 .next
25517 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25518 is accepted and placed in &$authenticated_sender$& only if the client has
25519 authenticated.
25520 .next
25521 If the AUTH= value was accepted by either of the two previous rules, and
25522 the client has authenticated, and the authenticator has a setting for the
25523 &%server_mail_auth_condition%&, the condition is checked at this point. The
25524 valued that was saved from the authenticator is expanded. If the expansion
25525 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25526 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25527 the value of &$authenticated_sender$& is retained and passed on with the
25528 message.
25529 .endlist
25530
25531
25532 When &$authenticated_sender$& is set for a message, it is passed on to other
25533 hosts to which Exim authenticates as a client. Do not confuse this value with
25534 &$authenticated_id$&, which is a string obtained from the authentication
25535 process, and which is not usually a complete email address.
25536
25537 .vindex "&$sender_address$&"
25538 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25539 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25540 therefore make use of &$authenticated_sender$&. The converse is not true: the
25541 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25542 ACL is run.
25543
25544
25545
25546 .section "Authentication on an Exim server" "SECTauthexiser"
25547 .cindex "authentication" "on an Exim server"
25548 When Exim receives an EHLO command, it advertises the public names of those
25549 authenticators that are configured as servers, subject to the following
25550 conditions:
25551
25552 .ilist
25553 The client host must match &%auth_advertise_hosts%& (default *).
25554 .next
25555 It the &%server_advertise_condition%& option is set, its expansion must not
25556 yield the empty string, &"0"&, &"no"&, or &"false"&.
25557 .endlist
25558
25559 The order in which the authenticators are defined controls the order in which
25560 the mechanisms are advertised.
25561
25562 Some mail clients (for example, some versions of Netscape) require the user to
25563 provide a name and password for authentication whenever AUTH is advertised,
25564 even though authentication may not in fact be needed (for example, Exim may be
25565 set up to allow unconditional relaying from the client by an IP address check).
25566 You can make such clients more friendly by not advertising AUTH to them.
25567 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25568 that runs for RCPT) to relay without authentication, you should set
25569 .code
25570 auth_advertise_hosts = ! 10.9.8.0/24
25571 .endd
25572 so that no authentication mechanisms are advertised to them.
25573
25574 The &%server_advertise_condition%& controls the advertisement of individual
25575 authentication mechanisms. For example, it can be used to restrict the
25576 advertisement of a particular mechanism to encrypted connections, by a setting
25577 such as:
25578 .code
25579 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25580 .endd
25581 .vindex "&$tls_in_cipher$&"
25582 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25583 yields &"yes"&, which allows the advertisement to happen.
25584
25585 When an Exim server receives an AUTH command from a client, it rejects it
25586 immediately if AUTH was not advertised in response to an earlier EHLO
25587 command. This is the case if
25588
25589 .ilist
25590 The client host does not match &%auth_advertise_hosts%&; or
25591 .next
25592 No authenticators are configured with server options; or
25593 .next
25594 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25595 server authenticators.
25596 .endlist
25597
25598
25599 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25600 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25601 AUTH is accepted from any client host.
25602
25603 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25604 server authentication mechanism that was advertised in response to EHLO and
25605 that matches the one named in the AUTH command. If it finds one, it runs
25606 the appropriate authentication protocol, and authentication either succeeds or
25607 fails. If there is no matching advertised mechanism, the AUTH command is
25608 rejected with a 504 error.
25609
25610 .vindex "&$received_protocol$&"
25611 .vindex "&$sender_host_authenticated$&"
25612 When a message is received from an authenticated host, the value of
25613 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25614 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25615 public name) of the authenticator driver that successfully authenticated the
25616 client from which the message was received. This variable is empty if there was
25617 no successful authentication.
25618
25619
25620
25621
25622 .section "Testing server authentication" "SECID169"
25623 .cindex "authentication" "testing a server"
25624 .cindex "AUTH" "testing a server"
25625 .cindex "base64 encoding" "creating authentication test data"
25626 Exim's &%-bh%& option can be useful for testing server authentication
25627 configurations. The data for the AUTH command has to be sent using base64
25628 encoding. A quick way to produce such data for testing is the following Perl
25629 script:
25630 .code
25631 use MIME::Base64;
25632 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25633 .endd
25634 .cindex "binary zero" "in authentication data"
25635 This interprets its argument as a Perl string, and then encodes it. The
25636 interpretation as a Perl string allows binary zeros, which are required for
25637 some kinds of authentication, to be included in the data. For example, a
25638 command line to run this script on such data might be
25639 .code
25640 encode '\0user\0password'
25641 .endd
25642 Note the use of single quotes to prevent the shell interpreting the
25643 backslashes, so that they can be interpreted by Perl to specify characters
25644 whose code value is zero.
25645
25646 &*Warning 1*&: If either of the user or password strings starts with an octal
25647 digit, you must use three zeros instead of one after the leading backslash. If
25648 you do not, the octal digit that starts your string will be incorrectly
25649 interpreted as part of the code for the first character.
25650
25651 &*Warning 2*&: If there are characters in the strings that Perl interprets
25652 specially, you must use a Perl escape to prevent them being misinterpreted. For
25653 example, a command such as
25654 .code
25655 encode '\0user@domain.com\0pas$$word'
25656 .endd
25657 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25658
25659 If you have the &%mimencode%& command installed, another way to do produce
25660 base64-encoded strings is to run the command
25661 .code
25662 echo -e -n `\0user\0password' | mimencode
25663 .endd
25664 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25665 in the argument, and the &%-n%& option specifies no newline at the end of its
25666 output. However, not all versions of &%echo%& recognize these options, so you
25667 should check your version before relying on this suggestion.
25668
25669
25670
25671 .section "Authentication by an Exim client" "SECID170"
25672 .cindex "authentication" "on an Exim client"
25673 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25674 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25675 announces support for authentication, and the host matches an entry in either
25676 of these options, Exim (as a client) tries to authenticate as follows:
25677
25678 .ilist
25679 For each authenticator that is configured as a client, in the order in which
25680 they are defined in the configuration, it searches the authentication
25681 mechanisms announced by the server for one whose name matches the public name
25682 of the authenticator.
25683 .next
25684 .vindex "&$host$&"
25685 .vindex "&$host_address$&"
25686 When it finds one that matches, it runs the authenticator's client code. The
25687 variables &$host$& and &$host_address$& are available for any string expansions
25688 that the client might do. They are set to the server's name and IP address. If
25689 any expansion is forced to fail, the authentication attempt is abandoned, and
25690 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25691 delivery to be deferred.
25692 .next
25693 If the result of the authentication attempt is a temporary error or a timeout,
25694 Exim abandons trying to send the message to the host for the moment. It will
25695 try again later. If there are any backup hosts available, they are tried in the
25696 usual way.
25697 .next
25698 If the response to authentication is a permanent error (5&'xx'& code), Exim
25699 carries on searching the list of authenticators and tries another one if
25700 possible. If all authentication attempts give permanent errors, or if there are
25701 no attempts because no mechanisms match (or option expansions force failure),
25702 what happens depends on whether the host matches &%hosts_require_auth%& or
25703 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25704 delivery is deferred. The error can be detected in the retry rules, and thereby
25705 turned into a permanent error if you wish. In the second case, Exim tries to
25706 deliver the message unauthenticated.
25707 .endlist
25708
25709 .cindex "AUTH" "on MAIL command"
25710 When Exim has authenticated itself to a remote server, it adds the AUTH
25711 parameter to the MAIL commands it sends, if it has an authenticated sender for
25712 the message. If the message came from a remote host, the authenticated sender
25713 is the one that was receiving on an incoming MAIL command, provided that the
25714 incoming connection was authenticated and the &%server_mail_auth%& condition
25715 allowed the authenticated sender to be retained. If a local process calls Exim
25716 to send a message, the sender address that is built from the login name and
25717 &%qualify_domain%& is treated as authenticated. However, if the
25718 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25719 the authenticated sender that was received with the message.
25720 .ecindex IIDauthconf1
25721 .ecindex IIDauthconf2
25722
25723
25724
25725
25726
25727
25728 . ////////////////////////////////////////////////////////////////////////////
25729 . ////////////////////////////////////////////////////////////////////////////
25730
25731 .chapter "The plaintext authenticator" "CHAPplaintext"
25732 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25733 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25734 The &(plaintext)& authenticator can be configured to support the PLAIN and
25735 LOGIN authentication mechanisms, both of which transfer authentication data as
25736 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25737 security risk; you are strongly advised to insist on the use of SMTP encryption
25738 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25739 use unencrypted plain text, you should not use the same passwords for SMTP
25740 connections as you do for login accounts.
25741
25742 .section "Plaintext options" "SECID171"
25743 .cindex "options" "&(plaintext)& authenticator (server)"
25744 When configured as a server, &(plaintext)& uses the following options:
25745
25746 .option server_condition authenticators string&!! unset
25747 This is actually a global authentication option, but it must be set in order to
25748 configure the &(plaintext)& driver as a server. Its use is described below.
25749
25750 .option server_prompts plaintext string&!! unset
25751 The contents of this option, after expansion, must be a colon-separated list of
25752 prompt strings. If expansion fails, a temporary authentication rejection is
25753 given.
25754
25755 .section "Using plaintext in a server" "SECTplainserver"
25756 .cindex "AUTH" "in &(plaintext)& authenticator"
25757 .cindex "binary zero" "in &(plaintext)& authenticator"
25758 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25759         "in &(plaintext)& authenticator"
25760 .vindex "&$auth1$&, &$auth2$&, etc"
25761 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25762
25763 When running as a server, &(plaintext)& performs the authentication test by
25764 expanding a string. The data sent by the client with the AUTH command, or in
25765 response to subsequent prompts, is base64 encoded, and so may contain any byte
25766 values when decoded. If any data is supplied with the command, it is treated as
25767 a list of strings, separated by NULs (binary zeros), the first three of which
25768 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25769 (neither LOGIN nor PLAIN uses more than three strings).
25770
25771 For compatibility with previous releases of Exim, the values are also placed in
25772 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25773 variables for this purpose is now deprecated, as it can lead to confusion in
25774 string expansions that also use them for other things.
25775
25776 If there are more strings in &%server_prompts%& than the number of strings
25777 supplied with the AUTH command, the remaining prompts are used to obtain more
25778 data. Each response from the client may be a list of NUL-separated strings.
25779
25780 .vindex "&$authenticated_id$&"
25781 Once a sufficient number of data strings have been received,
25782 &%server_condition%& is expanded. If the expansion is forced to fail,
25783 authentication fails. Any other expansion failure causes a temporary error code
25784 to be returned. If the result of a successful expansion is an empty string,
25785 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25786 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25787 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25788 For any other result, a temporary error code is returned, with the expanded
25789 string as the error text
25790
25791 &*Warning*&: If you use a lookup in the expansion to find the user's
25792 password, be sure to make the authentication fail if the user is unknown.
25793 There are good and bad examples at the end of the next section.
25794
25795
25796
25797 .section "The PLAIN authentication mechanism" "SECID172"
25798 .cindex "PLAIN authentication mechanism"
25799 .cindex "authentication" "PLAIN mechanism"
25800 .cindex "binary zero" "in &(plaintext)& authenticator"
25801 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25802 sent as one item of data (that is, one combined string containing two NUL
25803 separators). The data is sent either as part of the AUTH command, or
25804 subsequently in response to an empty prompt from the server.
25805
25806 The second and third strings are a user name and a corresponding password.
25807 Using a single fixed user name and password as an example, this could be
25808 configured as follows:
25809 .code
25810 fixed_plain:
25811   driver = plaintext
25812   public_name = PLAIN
25813   server_prompts = :
25814   server_condition = \
25815     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25816   server_set_id = $auth2
25817 .endd
25818 Note that the default result strings from &%if%& (&"true"& or an empty string)
25819 are exactly what we want here, so they need not be specified. Obviously, if the
25820 password contains expansion-significant characters such as dollar, backslash,
25821 or closing brace, they have to be escaped.
25822
25823 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25824 the end of a string list are ignored). If all the data comes as part of the
25825 AUTH command, as is commonly the case, the prompt is not used. This
25826 authenticator is advertised in the response to EHLO as
25827 .code
25828 250-AUTH PLAIN
25829 .endd
25830 and a client host can authenticate itself by sending the command
25831 .code
25832 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25833 .endd
25834 As this contains three strings (more than the number of prompts), no further
25835 data is required from the client. Alternatively, the client may just send
25836 .code
25837 AUTH PLAIN
25838 .endd
25839 to initiate authentication, in which case the server replies with an empty
25840 prompt. The client must respond with the combined data string.
25841
25842 The data string is base64 encoded, as required by the RFC. This example,
25843 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25844 represents a zero byte. This is split up into three strings, the first of which
25845 is empty. The &%server_condition%& option in the authenticator checks that the
25846 second two are &`username`& and &`mysecret`& respectively.
25847
25848 Having just one fixed user name and password, as in this example, is not very
25849 realistic, though for a small organization with only a handful of
25850 authenticating clients it could make sense.
25851
25852 A more sophisticated instance of this authenticator could use the user name in
25853 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25854 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25855 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25856 This is an incorrect example:
25857 .code
25858 server_condition = \
25859   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25860 .endd
25861 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25862 which it then compares to the supplied password (&$auth3$&). Why is this example
25863 incorrect? It works fine for existing users, but consider what happens if a
25864 non-existent user name is given. The lookup fails, but as no success/failure
25865 strings are given for the lookup, it yields an empty string. Thus, to defeat
25866 the authentication, all a client has to do is to supply a non-existent user
25867 name and an empty password. The correct way of writing this test is:
25868 .code
25869 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25870   {${if eq{$value}{$auth3}}} {false}}
25871 .endd
25872 In this case, if the lookup succeeds, the result is checked; if the lookup
25873 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25874 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25875 always fails if its second argument is empty. However, the second way of
25876 writing the test makes the logic clearer.
25877
25878
25879 .section "The LOGIN authentication mechanism" "SECID173"
25880 .cindex "LOGIN authentication mechanism"
25881 .cindex "authentication" "LOGIN mechanism"
25882 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25883 in a number of programs. No data is sent with the AUTH command. Instead, a
25884 user name and password are supplied separately, in response to prompts. The
25885 plaintext authenticator can be configured to support this as in this example:
25886 .code
25887 fixed_login:
25888   driver = plaintext
25889   public_name = LOGIN
25890   server_prompts = User Name : Password
25891   server_condition = \
25892     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25893   server_set_id = $auth1
25894 .endd
25895 Because of the way plaintext operates, this authenticator accepts data supplied
25896 with the AUTH command (in contravention of the specification of LOGIN), but
25897 if the client does not supply it (as is the case for LOGIN clients), the prompt
25898 strings are used to obtain two data items.
25899
25900 Some clients are very particular about the precise text of the prompts. For
25901 example, Outlook Express is reported to recognize only &"Username:"& and
25902 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25903 strings. It uses the &%ldapauth%& expansion condition to check the user
25904 name and password by binding to an LDAP server:
25905 .code
25906 login:
25907   driver = plaintext
25908   public_name = LOGIN
25909   server_prompts = Username:: : Password::
25910   server_condition = ${if and{{ \
25911     !eq{}{$auth1} }{ \
25912     ldapauth{\
25913       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25914       pass=${quote:$auth2} \
25915       ldap://ldap.example.org/} }} }
25916   server_set_id = uid=$auth1,ou=people,o=example.org
25917 .endd
25918 We have to check that the username is not empty before using it, because LDAP
25919 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25920 operator to correctly quote the DN for authentication. However, the basic
25921 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25922 correct one to use for the password, because quoting is needed only to make
25923 the password conform to the Exim syntax. At the LDAP level, the password is an
25924 uninterpreted string.
25925
25926
25927 .section "Support for different kinds of authentication" "SECID174"
25928 A number of string expansion features are provided for the purpose of
25929 interfacing to different ways of user authentication. These include checking
25930 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25931 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25932 &<<SECTexpcond>>&.
25933
25934
25935
25936
25937 .section "Using plaintext in a client" "SECID175"
25938 .cindex "options" "&(plaintext)& authenticator (client)"
25939 The &(plaintext)& authenticator has two client options:
25940
25941 .option client_ignore_invalid_base64 plaintext boolean false
25942 If the client receives a server prompt that is not a valid base64 string,
25943 authentication is abandoned by default. However, if this option is set true,
25944 the error in the challenge is ignored and the client sends the response as
25945 usual.
25946
25947 .option client_send plaintext string&!! unset
25948 The string is a colon-separated list of authentication data strings. Each
25949 string is independently expanded before being sent to the server. The first
25950 string is sent with the AUTH command; any more strings are sent in response
25951 to prompts from the server. Before each string is expanded, the value of the
25952 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25953 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25954 way. Thus, the prompt that is received in response to sending the first string
25955 (with the AUTH command) can be used in the expansion of the second string, and
25956 so on. If an invalid base64 string is received when
25957 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25958 &$auth$&<&'n'&> variable.
25959
25960 &*Note*&: You cannot use expansion to create multiple strings, because
25961 splitting takes priority and happens first.
25962
25963 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25964 the data, further processing is applied to each string before it is sent. If
25965 there are any single circumflex characters in the string, they are converted to
25966 NULs. Should an actual circumflex be required as data, it must be doubled in
25967 the string.
25968
25969 This is an example of a client configuration that implements the PLAIN
25970 authentication mechanism with a fixed user name and password:
25971 .code
25972 fixed_plain:
25973   driver = plaintext
25974   public_name = PLAIN
25975   client_send = ^username^mysecret
25976 .endd
25977 The lack of colons means that the entire text is sent with the AUTH
25978 command, with the circumflex characters converted to NULs. A similar example
25979 that uses the LOGIN mechanism is:
25980 .code
25981 fixed_login:
25982   driver = plaintext
25983   public_name = LOGIN
25984   client_send = : username : mysecret
25985 .endd
25986 The initial colon means that the first string is empty, so no data is sent with
25987 the AUTH command itself. The remaining strings are sent in response to
25988 prompts.
25989 .ecindex IIDplaiauth1
25990 .ecindex IIDplaiauth2
25991
25992
25993
25994
25995 . ////////////////////////////////////////////////////////////////////////////
25996 . ////////////////////////////////////////////////////////////////////////////
25997
25998 .chapter "The cram_md5 authenticator" "CHID9"
25999 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26000 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26001 .cindex "CRAM-MD5 authentication mechanism"
26002 .cindex "authentication" "CRAM-MD5 mechanism"
26003 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26004 sends a challenge string to the client, and the response consists of a user
26005 name and the CRAM-MD5 digest of the challenge string combined with a secret
26006 string (password) which is known to both server and client. Thus, the secret
26007 is not sent over the network as plain text, which makes this authenticator more
26008 secure than &(plaintext)&. However, the downside is that the secret has to be
26009 available in plain text at either end.
26010
26011
26012 .section "Using cram_md5 as a server" "SECID176"
26013 .cindex "options" "&(cram_md5)& authenticator (server)"
26014 This authenticator has one server option, which must be set to configure the
26015 authenticator as a server:
26016
26017 .option server_secret cram_md5 string&!! unset
26018 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26019 When the server receives the client's response, the user name is placed in
26020 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26021 obtain the password for that user. The server then computes the CRAM-MD5 digest
26022 that the client should have sent, and checks that it received the correct
26023 string. If the expansion of &%server_secret%& is forced to fail, authentication
26024 fails. If the expansion fails for some other reason, a temporary error code is
26025 returned to the client.
26026
26027 For compatibility with previous releases of Exim, the user name is also placed
26028 in &$1$&. However, the use of this variables for this purpose is now
26029 deprecated, as it can lead to confusion in string expansions that also use
26030 numeric variables for other things.
26031
26032 For example, the following authenticator checks that the user name given by the
26033 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26034 user name, authentication fails.
26035 .code
26036 fixed_cram:
26037   driver = cram_md5
26038   public_name = CRAM-MD5
26039   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26040   server_set_id = $auth1
26041 .endd
26042 .vindex "&$authenticated_id$&"
26043 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26044 name in &$authenticated_id$&. A more typical configuration might look up the
26045 secret string in a file, using the user name as the key. For example:
26046 .code
26047 lookup_cram:
26048   driver = cram_md5
26049   public_name = CRAM-MD5
26050   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26051                   {$value}fail}
26052   server_set_id = $auth1
26053 .endd
26054 Note that this expansion explicitly forces failure if the lookup fails
26055 because &$auth1$& contains an unknown user name.
26056
26057 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26058 using the relevant libraries, you need to know the realm to specify in the
26059 lookup and then ask for the &"userPassword"& attribute for that user in that
26060 realm, with:
26061 .code
26062 cyrusless_crammd5:
26063   driver = cram_md5
26064   public_name = CRAM-MD5
26065   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26066                   dbmjz{/etc/sasldb2}{$value}fail}
26067   server_set_id = $auth1
26068 .endd
26069
26070 .section "Using cram_md5 as a client" "SECID177"
26071 .cindex "options" "&(cram_md5)& authenticator (client)"
26072 When used as a client, the &(cram_md5)& authenticator has two options:
26073
26074
26075
26076 .option client_name cram_md5 string&!! "the primary host name"
26077 This string is expanded, and the result used as the user name data when
26078 computing the response to the server's challenge.
26079
26080
26081 .option client_secret cram_md5 string&!! unset
26082 This option must be set for the authenticator to work as a client. Its value is
26083 expanded and the result used as the secret string when computing the response.
26084
26085
26086 .vindex "&$host$&"
26087 .vindex "&$host_address$&"
26088 Different user names and secrets can be used for different servers by referring
26089 to &$host$& or &$host_address$& in the options. Forced failure of either
26090 expansion string is treated as an indication that this authenticator is not
26091 prepared to handle this case. Exim moves on to the next configured client
26092 authenticator. Any other expansion failure causes Exim to give up trying to
26093 send the message to the current server.
26094
26095 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26096 strings, is:
26097 .code
26098 fixed_cram:
26099   driver = cram_md5
26100   public_name = CRAM-MD5
26101   client_name = ph10
26102   client_secret = secret
26103 .endd
26104 .ecindex IIDcramauth1
26105 .ecindex IIDcramauth2
26106
26107
26108
26109 . ////////////////////////////////////////////////////////////////////////////
26110 . ////////////////////////////////////////////////////////////////////////////
26111
26112 .chapter "The cyrus_sasl authenticator" "CHID10"
26113 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26114 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26115 .cindex "Cyrus" "SASL library"
26116 .cindex "Kerberos"
26117 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26118 Digital Ltd (&url(http://www.aldigital.co.uk)).
26119
26120 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26121 library implementation of the RFC 2222 (&"Simple Authentication and Security
26122 Layer"&). This library supports a number of authentication mechanisms,
26123 including PLAIN and LOGIN, but also several others that Exim does not support
26124 directly. In particular, there is support for Kerberos authentication.
26125
26126 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26127 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26128 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26129 name of the driver to determine which mechanism to support.
26130
26131 Where access to some kind of secret file is required, for example in GSSAPI
26132 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26133 user, and that the Cyrus SASL library has no way of escalating privileges
26134 by default. You may also find you need to set environment variables,
26135 depending on the driver you are using.
26136
26137 The application name provided by Exim is &"exim"&, so various SASL options may
26138 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26139 Kerberos, note that because of limitations in the GSSAPI interface,
26140 changing the server keytab might need to be communicated down to the Kerberos
26141 layer independently. The mechanism for doing so is dependent upon the Kerberos
26142 implementation.
26143
26144 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26145 may be set to point to an alternative keytab file. Exim will pass this
26146 variable through from its own inherited environment when started as root or the
26147 Exim user. The keytab file needs to be readable by the Exim user.
26148 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26149 environment variable.  In practice, for those releases, the Cyrus authenticator
26150 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26151 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26152
26153
26154 .section "Using cyrus_sasl as a server" "SECID178"
26155 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26156 (on a successful authentication) into &$auth1$&. For compatibility with
26157 previous releases of Exim, the username is also placed in &$1$&. However, the
26158 use of this variable for this purpose is now deprecated, as it can lead to
26159 confusion in string expansions that also use numeric variables for other
26160 things.
26161
26162
26163 .option server_hostname cyrus_sasl string&!! "see below"
26164 This option selects the hostname that is used when communicating with the
26165 library. The default value is &`$primary_hostname`&. It is up to the underlying
26166 SASL plug-in what it does with this data.
26167
26168
26169 .option server_mech cyrus_sasl string "see below"
26170 This option selects the authentication mechanism this driver should use. The
26171 default is the value of the generic &%public_name%& option. This option allows
26172 you to use a different underlying mechanism from the advertised name. For
26173 example:
26174 .code
26175 sasl:
26176   driver = cyrus_sasl
26177   public_name = X-ANYTHING
26178   server_mech = CRAM-MD5
26179   server_set_id = $auth1
26180 .endd
26181
26182 .option server_realm cyrus_sasl string&!! unset
26183 This specifies the SASL realm that the server claims to be in.
26184
26185
26186 .option server_service cyrus_sasl string &`smtp`&
26187 This is the SASL service that the server claims to implement.
26188
26189
26190 For straightforward cases, you do not need to set any of the authenticator's
26191 private options. All you need to do is to specify an appropriate mechanism as
26192 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26193 PLAIN, you could have two authenticators as follows:
26194 .code
26195 sasl_cram_md5:
26196   driver = cyrus_sasl
26197   public_name = CRAM-MD5
26198   server_set_id = $auth1
26199
26200 sasl_plain:
26201   driver = cyrus_sasl
26202   public_name = PLAIN
26203   server_set_id = $auth2
26204 .endd
26205 Cyrus SASL does implement the LOGIN authentication method, even though it is
26206 not a standard method. It is disabled by default in the source distribution,
26207 but it is present in many binary distributions.
26208 .ecindex IIDcyrauth1
26209 .ecindex IIDcyrauth2
26210
26211
26212
26213
26214 . ////////////////////////////////////////////////////////////////////////////
26215 . ////////////////////////////////////////////////////////////////////////////
26216 .chapter "The dovecot authenticator" "CHAPdovecot"
26217 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26218 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26219 This authenticator is an interface to the authentication facility of the
26220 Dovecot POP/IMAP server, which can support a number of authentication methods.
26221 Note that Dovecot must be configured to use auth-client not auth-userdb.
26222 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26223 to use the same mechanisms for SMTP authentication. This is a server
26224 authenticator only. There is only one option:
26225
26226 .option server_socket dovecot string unset
26227
26228 This option must specify the socket that is the interface to Dovecot
26229 authentication. The &%public_name%& option must specify an authentication
26230 mechanism that Dovecot is configured to support. You can have several
26231 authenticators for different mechanisms. For example:
26232 .code
26233 dovecot_plain:
26234   driver = dovecot
26235   public_name = PLAIN
26236   server_socket = /var/run/dovecot/auth-client
26237   server_set_id = $auth1
26238
26239 dovecot_ntlm:
26240   driver = dovecot
26241   public_name = NTLM
26242   server_socket = /var/run/dovecot/auth-client
26243   server_set_id = $auth1
26244 .endd
26245 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26246 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26247 option is passed in the Dovecot authentication command. If, for a TLS
26248 connection, a client certificate has been verified, the &"valid-client-cert"&
26249 option is passed. When authentication succeeds, the identity of the user
26250 who authenticated is placed in &$auth1$&.
26251 .ecindex IIDdcotauth1
26252 .ecindex IIDdcotauth2
26253
26254
26255 . ////////////////////////////////////////////////////////////////////////////
26256 . ////////////////////////////////////////////////////////////////////////////
26257 .chapter "The gsasl authenticator" "CHAPgsasl"
26258 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26259 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26260 .cindex "authentication" "GNU SASL"
26261 .cindex "authentication" "SASL"
26262 .cindex "authentication" "EXTERNAL"
26263 .cindex "authentication" "ANONYMOUS"
26264 .cindex "authentication" "PLAIN"
26265 .cindex "authentication" "LOGIN"
26266 .cindex "authentication" "DIGEST-MD5"
26267 .cindex "authentication" "CRAM-MD5"
26268 .cindex "authentication" "SCRAM-SHA-1"
26269 The &(gsasl)& authenticator provides server integration for the GNU SASL
26270 library and the mechanisms it provides.  This is new as of the 4.80 release
26271 and there are a few areas where the library does not let Exim smoothly
26272 scale to handle future authentication mechanisms, so no guarantee can be
26273 made that any particular new authentication mechanism will be supported
26274 without code changes in Exim.
26275
26276
26277 .option server_channelbinding gsasl boolean false
26278 Some authentication mechanisms are able to use external context at both ends
26279 of the session to bind the authentication to that context, and fail the
26280 authentication process if that context differs.  Specifically, some TLS
26281 ciphersuites can provide identifying information about the cryptographic
26282 context.
26283
26284 This means that certificate identity and verification becomes a non-issue,
26285 as a man-in-the-middle attack will cause the correct client and server to
26286 see different identifiers and authentication will fail.
26287
26288 This is currently only supported when using the GnuTLS library.  This is
26289 only usable by mechanisms which support "channel binding"; at time of
26290 writing, that's the SCRAM family.
26291
26292 This defaults off to ensure smooth upgrade across Exim releases, in case
26293 this option causes some clients to start failing.  Some future release
26294 of Exim may switch the default to be true.
26295
26296
26297 .option server_hostname gsasl string&!! "see below"
26298 This option selects the hostname that is used when communicating with the
26299 library. The default value is &`$primary_hostname`&.
26300 Some mechanisms will use this data.
26301
26302
26303 .option server_mech gsasl string "see below"
26304 This option selects the authentication mechanism this driver should use. The
26305 default is the value of the generic &%public_name%& option. This option allows
26306 you to use a different underlying mechanism from the advertised name. For
26307 example:
26308 .code
26309 sasl:
26310   driver = gsasl
26311   public_name = X-ANYTHING
26312   server_mech = CRAM-MD5
26313   server_set_id = $auth1
26314 .endd
26315
26316
26317 .option server_password gsasl string&!! unset
26318 Various mechanisms need access to the cleartext password on the server, so
26319 that proof-of-possession can be demonstrated on the wire, without sending
26320 the password itself.
26321
26322 The data available for lookup varies per mechanism.
26323 In all cases, &$auth1$& is set to the &'authentication id'&.
26324 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26325 if available, else the empty string.
26326 The &$auth3$& variable will always be the &'realm'& if available,
26327 else the empty string.
26328
26329 A forced failure will cause authentication to defer.
26330
26331 If using this option, it may make sense to set the &%server_condition%&
26332 option to be simply "true".
26333
26334
26335 .option server_realm gsasl string&!! unset
26336 This specifies the SASL realm that the server claims to be in.
26337 Some mechanisms will use this data.
26338
26339
26340 .option server_scram_iter gsasl string&!! unset
26341 This option provides data for the SCRAM family of mechanisms.
26342 &$auth1$& is not available at evaluation time.
26343 (This may change, as we receive feedback on use)
26344
26345
26346 .option server_scram_salt gsasl string&!! unset
26347 This option provides data for the SCRAM family of mechanisms.
26348 &$auth1$& is not available at evaluation time.
26349 (This may change, as we receive feedback on use)
26350
26351
26352 .option server_service gsasl string &`smtp`&
26353 This is the SASL service that the server claims to implement.
26354 Some mechanisms will use this data.
26355
26356
26357 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26358 .vindex "&$auth1$&, &$auth2$&, etc"
26359 These may be set when evaluating specific options, as detailed above.
26360 They will also be set when evaluating &%server_condition%&.
26361
26362 Unless otherwise stated below, the &(gsasl)& integration will use the following
26363 meanings for these variables:
26364
26365 .ilist
26366 .vindex "&$auth1$&"
26367 &$auth1$&: the &'authentication id'&
26368 .next
26369 .vindex "&$auth2$&"
26370 &$auth2$&: the &'authorization id'&
26371 .next
26372 .vindex "&$auth3$&"
26373 &$auth3$&: the &'realm'&
26374 .endlist
26375
26376 On a per-mechanism basis:
26377
26378 .ilist
26379 .cindex "authentication" "EXTERNAL"
26380 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26381 the &%server_condition%& option must be present.
26382 .next
26383 .cindex "authentication" "ANONYMOUS"
26384 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26385 the &%server_condition%& option must be present.
26386 .next
26387 .cindex "authentication" "GSSAPI"
26388 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26389 &$auth2$& will be set to the &'authorization id'&,
26390 the &%server_condition%& option must be present.
26391 .endlist
26392
26393 An &'anonymous token'& is something passed along as an unauthenticated
26394 identifier; this is analogous to FTP anonymous authentication passing an
26395 email address, or software-identifier@, as the "password".
26396
26397
26398 An example showing the password having the realm specified in the callback
26399 and demonstrating a Cyrus SASL to GSASL migration approach is:
26400 .code
26401 gsasl_cyrusless_crammd5:
26402   driver = gsasl
26403   public_name = CRAM-MD5
26404   server_realm = imap.example.org
26405   server_password = ${lookup{$auth1:$auth3:userPassword}\
26406                     dbmjz{/etc/sasldb2}{$value}fail}
26407   server_set_id = ${quote:$auth1}
26408   server_condition = yes
26409 .endd
26410
26411
26412 . ////////////////////////////////////////////////////////////////////////////
26413 . ////////////////////////////////////////////////////////////////////////////
26414
26415 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26416 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26417 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26418 .cindex "authentication" "GSSAPI"
26419 .cindex "authentication" "Kerberos"
26420 The &(heimdal_gssapi)& authenticator provides server integration for the
26421 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26422 reliably.
26423
26424 .option server_hostname heimdal_gssapi string&!! "see below"
26425 This option selects the hostname that is used, with &%server_service%&,
26426 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26427 identifier.  The default value is &`$primary_hostname`&.
26428
26429 .option server_keytab heimdal_gssapi string&!! unset
26430 If set, then Heimdal will not use the system default keytab (typically
26431 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26432 The value should be a pathname, with no &"file:"& prefix.
26433
26434 .option server_service heimdal_gssapi string&!! "smtp"
26435 This option specifies the service identifier used, in conjunction with
26436 &%server_hostname%&, for building the identifier for finding credentials
26437 from the keytab.
26438
26439
26440 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26441 Beware that these variables will typically include a realm, thus will appear
26442 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26443 not verified, so a malicious client can set it to anything.
26444
26445 The &$auth1$& field should be safely trustable as a value from the Key
26446 Distribution Center.  Note that these are not quite email addresses.
26447 Each identifier is for a role, and so the left-hand-side may include a
26448 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26449
26450 .vindex "&$auth1$&, &$auth2$&, etc"
26451 .ilist
26452 .vindex "&$auth1$&"
26453 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26454 .next
26455 .vindex "&$auth2$&"
26456 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26457 authentication.  If that was empty, this will also be set to the
26458 GSS Display Name.
26459 .endlist
26460
26461
26462 . ////////////////////////////////////////////////////////////////////////////
26463 . ////////////////////////////////////////////////////////////////////////////
26464
26465 .chapter "The spa authenticator" "CHAPspa"
26466 .scindex IIDspaauth1 "&(spa)& authenticator"
26467 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26468 .cindex "authentication" "Microsoft Secure Password"
26469 .cindex "authentication" "NTLM"
26470 .cindex "Microsoft Secure Password Authentication"
26471 .cindex "NTLM authentication"
26472 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26473 Password Authentication'& mechanism,
26474 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26475 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26476 taken from the Samba project (&url(http://www.samba.org)). The code for the
26477 server side was subsequently contributed by Tom Kistner. The mechanism works as
26478 follows:
26479
26480 .ilist
26481 After the AUTH command has been accepted, the client sends an SPA
26482 authentication request based on the user name and optional domain.
26483 .next
26484 The server sends back a challenge.
26485 .next
26486 The client builds a challenge response which makes use of the user's password
26487 and sends it to the server, which then accepts or rejects it.
26488 .endlist
26489
26490 Encryption is used to protect the password in transit.
26491
26492
26493
26494 .section "Using spa as a server" "SECID179"
26495 .cindex "options" "&(spa)& authenticator (server)"
26496 The &(spa)& authenticator has just one server option:
26497
26498 .option server_password spa string&!! unset
26499 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26500 This option is expanded, and the result must be the cleartext password for the
26501 authenticating user, whose name is at this point in &$auth1$&. For
26502 compatibility with previous releases of Exim, the user name is also placed in
26503 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26504 it can lead to confusion in string expansions that also use numeric variables
26505 for other things. For example:
26506 .code
26507 spa:
26508   driver = spa
26509   public_name = NTLM
26510   server_password = \
26511     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26512 .endd
26513 If the expansion is forced to fail, authentication fails. Any other expansion
26514 failure causes a temporary error code to be returned.
26515
26516
26517
26518
26519
26520 .section "Using spa as a client" "SECID180"
26521 .cindex "options" "&(spa)& authenticator (client)"
26522 The &(spa)& authenticator has the following client options:
26523
26524
26525
26526 .option client_domain spa string&!! unset
26527 This option specifies an optional domain for the authentication.
26528
26529
26530 .option client_password spa string&!! unset
26531 This option specifies the user's password, and must be set.
26532
26533
26534 .option client_username spa string&!! unset
26535 This option specifies the user name, and must be set. Here is an example of a
26536 configuration of this authenticator for use with the mail servers at
26537 &'msn.com'&:
26538 .code
26539 msn:
26540   driver = spa
26541   public_name = MSN
26542   client_username = msn/msn_username
26543   client_password = msn_plaintext_password
26544   client_domain = DOMAIN_OR_UNSET
26545 .endd
26546 .ecindex IIDspaauth1
26547 .ecindex IIDspaauth2
26548
26549
26550
26551
26552
26553 . ////////////////////////////////////////////////////////////////////////////
26554 . ////////////////////////////////////////////////////////////////////////////
26555
26556 .chapter "The tls authenticator" "CHAPtlsauth"
26557 .scindex IIDtlsauth1 "&(tls)& authenticator"
26558 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26559 .cindex "authentication" "Client Certificate"
26560 .cindex "authentication" "X509"
26561 .cindex "Certificate-based authentication"
26562 The &(tls)& authenticator provides server support for
26563 authentication based on client certificates.
26564
26565 It is not an SMTP authentication mechanism and is not
26566 advertised by the server as part of the SMTP EHLO response.
26567 It is an Exim authenticator in the sense that it affects
26568 the protocol element of the log line, can be tested for
26569 by the &%authenticated%& ACL condition, and can set
26570 the &$authenticated_id$& variable.
26571
26572 The client must present a verifiable certificate,
26573 for which it must have been requested via the
26574 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26575 (see &<<CHAPTLS>>&).
26576
26577 If an authenticator of this type is configured it is
26578 run before any SMTP-level communication is done,
26579 and can authenticate the connection.
26580 If it does, SMTP authentication is not offered.
26581
26582 A maximum of one authenticator of this type may be present.
26583
26584
26585 .cindex "options" "&(tls)& authenticator (server)"
26586 The &(tls)& authenticator has three server options:
26587
26588 .option server_param1 tls string&!! unset
26589 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26590 This option is expanded after the TLS negotiation and
26591 the result is placed in &$auth1$&.
26592 If the expansion is forced to fail, authentication fails. Any other expansion
26593 failure causes a temporary error code to be returned.
26594
26595 .option server_param2 tls string&!! unset
26596 .option server_param3 tls string&!! unset
26597 As above, for &$auth2$& and &$auth3$&.
26598
26599 &%server_param1%& may also be spelled &%server_param%&.
26600
26601
26602 Example:
26603 .code
26604 tls:
26605   driver = tls
26606   server_param1 =     ${certextract {subj_altname,mail,>:} \
26607                                     {$tls_in_peercert}}
26608   server_condition =  ${if forany {$auth1} \
26609                             {!= {0} \
26610                                 {${lookup ldap{ldap:///\
26611                          mailname=${quote_ldap_dn:${lc:$item}},\
26612                          ou=users,LDAP_DC?mailid} {$value}{0} \
26613                        }    }   } }
26614   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26615 .endd
26616 This accepts a client certificate that is verifiable against any
26617 of your configured trust-anchors
26618 which usually means the full set of public CAs)
26619 and which has a SAN with a good account name.
26620 Note that the client cert is on the wire in-clear, including the SAN,
26621 whereas a plaintext SMTP AUTH done inside TLS is not.
26622
26623 . An alternative might use
26624 . .code
26625 .   server_param1 = ${sha256:$tls_in_peercert}
26626 . .endd
26627 . to require one of a set of specific certs that define a given account
26628 . (the verification is still required, but mostly irrelevant).
26629 . This would help for per-device use.
26630
26631 . However, for the future we really need support for checking a
26632 . user cert in LDAP - which probably wants a base-64 DER.
26633
26634 .ecindex IIDtlsauth1
26635 .ecindex IIDtlsauth2
26636
26637
26638 Note that because authentication is traditionally an SMTP operation,
26639 the &%authenticated%& ACL condition cannot be used in
26640 a connect- or helo-ACL.
26641
26642
26643
26644 . ////////////////////////////////////////////////////////////////////////////
26645 . ////////////////////////////////////////////////////////////////////////////
26646
26647 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26648          "Encrypted SMTP connections"
26649 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26650 .scindex IIDencsmtp2 "SMTP" "encryption"
26651 .cindex "TLS" "on SMTP connection"
26652 .cindex "OpenSSL"
26653 .cindex "GnuTLS"
26654 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26655 Sockets Layer), is implemented by making use of the OpenSSL library or the
26656 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26657 cryptographic code in the Exim distribution itself for implementing TLS. In
26658 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26659 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26660 You also need to understand the basic concepts of encryption at a managerial
26661 level, and in particular, the way that public keys, private keys, and
26662 certificates are used.
26663
26664 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26665 connection is established, the client issues a STARTTLS command. If the
26666 server accepts this, the client and the server negotiate an encryption
26667 mechanism. If the negotiation succeeds, the data that subsequently passes
26668 between them is encrypted.
26669
26670 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26671 and if so, what cipher suite is in use, whether the client supplied a
26672 certificate, and whether or not that certificate was verified. This makes it
26673 possible for an Exim server to deny or accept certain commands based on the
26674 encryption state.
26675
26676 &*Warning*&: Certain types of firewall and certain anti-virus products can
26677 disrupt TLS connections. You need to turn off SMTP scanning for these products
26678 in order to get TLS to work.
26679
26680
26681
26682 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26683          "SECID284"
26684 .cindex "ssmtp protocol"
26685 .cindex "smtps protocol"
26686 .cindex "SMTP" "ssmtp protocol"
26687 .cindex "SMTP" "smtps protocol"
26688 Early implementations of encrypted SMTP used a different TCP port from normal
26689 SMTP, and expected an encryption negotiation to start immediately, instead of
26690 waiting for a STARTTLS command from the client using the standard SMTP
26691 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26692 allocated for this purpose.
26693
26694 This approach was abandoned when encrypted SMTP was standardized, but there are
26695 still some legacy clients that use it. Exim supports these clients by means of
26696 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26697 numbers; the most common use is expected to be:
26698 .code
26699 tls_on_connect_ports = 465
26700 .endd
26701 The port numbers specified by this option apply to all SMTP connections, both
26702 via the daemon and via &'inetd'&. You still need to specify all the ports that
26703 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26704 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26705 an extra port &-- rather, it specifies different behaviour on a port that is
26706 defined elsewhere.
26707
26708 There is also a &%-tls-on-connect%& command line option. This overrides
26709 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26710
26711
26712
26713
26714
26715
26716 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26717 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26718 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26719 followed later, when the first versions of GnuTLS were released. To build Exim
26720 to use GnuTLS, you need to set
26721 .code
26722 USE_GNUTLS=yes
26723 .endd
26724 in Local/Makefile, in addition to
26725 .code
26726 SUPPORT_TLS=yes
26727 .endd
26728 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26729 include files and libraries for GnuTLS can be found.
26730
26731 There are some differences in usage when using GnuTLS instead of OpenSSL:
26732
26733 .ilist
26734 The &%tls_verify_certificates%& option
26735 cannot be the path of a directory
26736 for GnuTLS versions before 3.3.6
26737 (for later versions, or OpenSSL, it can be either).
26738 .next
26739 The default value for &%tls_dhparam%& differs for historical reasons.
26740 .next
26741 .vindex "&$tls_in_peerdn$&"
26742 .vindex "&$tls_out_peerdn$&"
26743 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26744 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26745 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26746 .next
26747 OpenSSL identifies cipher suites using hyphens as separators, for example:
26748 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26749 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26750 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26751 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26752 to handle its own older variants) when processing lists of cipher suites in the
26753 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26754 option).
26755 .next
26756 The &%tls_require_ciphers%& options operate differently, as described in the
26757 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26758 .next
26759 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26760 When using OpenSSL, this option is ignored.
26761 (If an API is found to let OpenSSL be configured in this way,
26762 let the Exim Maintainers know and we'll likely use it).
26763 .next
26764 Some other recently added features may only be available in one or the other.
26765 This should be documented with the feature.  If the documentation does not
26766 explicitly state that the feature is infeasible in the other TLS
26767 implementation, then patches are welcome.
26768 .endlist
26769
26770
26771 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26772 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26773 an explicit path; if the latter, then the text about generation still applies,
26774 but not the chosen filename.
26775 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26776 See the documentation of &%tls_dhparam%& for more information.
26777
26778 GnuTLS uses D-H parameters that may take a substantial amount of time
26779 to compute. It is unreasonable to re-compute them for every TLS session.
26780 Therefore, Exim keeps this data in a file in its spool directory, called
26781 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26782 of bits requested.
26783 The file is owned by the Exim user and is readable only by
26784 its owner. Every Exim process that start up GnuTLS reads the D-H
26785 parameters from this file. If the file does not exist, the first Exim process
26786 that needs it computes the data and writes it to a temporary file which is
26787 renamed once it is complete. It does not matter if several Exim processes do
26788 this simultaneously (apart from wasting a few resources). Once a file is in
26789 place, new Exim processes immediately start using it.
26790
26791 For maximum security, the parameters that are stored in this file should be
26792 recalculated periodically, the frequency depending on your paranoia level.
26793 If you are avoiding using the fixed D-H primes published in RFCs, then you
26794 are concerned about some advanced attacks and will wish to do this; if you do
26795 not regenerate then you might as well stick to the standard primes.
26796
26797 Arranging this is easy in principle; just delete the file when you want new
26798 values to be computed. However, there may be a problem. The calculation of new
26799 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26800 If the system is not very active, &_/dev/random_& may delay returning data
26801 until enough randomness (entropy) is available. This may cause Exim to hang for
26802 a substantial amount of time, causing timeouts on incoming connections.
26803
26804 The solution is to generate the parameters externally to Exim. They are stored
26805 in &_gnutls-params-N_& in PEM format, which means that they can be
26806 generated externally using the &(certtool)& command that is part of GnuTLS.
26807
26808 To replace the parameters with new ones, instead of deleting the file
26809 and letting Exim re-create it, you can generate new parameters using
26810 &(certtool)& and, when this has been done, replace Exim's cache file by
26811 renaming. The relevant commands are something like this:
26812 .code
26813 # ls
26814 [ look for file; assume gnutls-params-2236 is the most recent ]
26815 # rm -f new-params
26816 # touch new-params
26817 # chown exim:exim new-params
26818 # chmod 0600 new-params
26819 # certtool --generate-dh-params --bits 2236 >>new-params
26820 # openssl dhparam -noout -text -in new-params | head
26821 [ check the first line, make sure it's not more than 2236;
26822   if it is, then go back to the start ("rm") and repeat
26823   until the size generated is at most the size requested ]
26824 # chmod 0400 new-params
26825 # mv new-params gnutls-params-2236
26826 .endd
26827 If Exim never has to generate the parameters itself, the possibility of
26828 stalling is removed.
26829
26830 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26831 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26832 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26833 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26834 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26835 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26836 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26837 which applies to all D-H usage, client or server.  If the value returned by
26838 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26839 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26840 limit, which is still much higher than Exim historically used.
26841
26842 The filename and bits used will change as the GnuTLS maintainers change the
26843 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26844 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26845 2432 bits, while NSS is limited to 2236 bits.
26846
26847 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26848 increase the chance of the generated prime actually being within acceptable
26849 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26850 procedure above.  There is no sane procedure available to Exim to double-check
26851 the size of the generated prime, so it might still be too large.
26852
26853
26854 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26855 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26856 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26857 There is a function in the OpenSSL library that can be passed a list of cipher
26858 suites before the cipher negotiation takes place. This specifies which ciphers
26859 are acceptable. The list is colon separated and may contain names like
26860 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26861 directly to this function call.
26862 Many systems will install the OpenSSL manual-pages, so you may have
26863 &'ciphers(1)'& available to you.
26864 The following quotation from the OpenSSL
26865 documentation specifies what forms of item are allowed in the cipher string:
26866
26867 .ilist
26868 It can consist of a single cipher suite such as RC4-SHA.
26869 .next
26870 It can represent a list of cipher suites containing a certain algorithm,
26871 or cipher suites of a certain type. For example SHA1 represents all
26872 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26873 SSL v3 algorithms.
26874 .next
26875 Lists of cipher suites can be combined in a single cipher string using
26876 the + character. This is used as a logical and operation. For example
26877 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26878 algorithms.
26879 .endlist
26880
26881 Each cipher string can be optionally preceded by one of the characters &`!`&,
26882 &`-`& or &`+`&.
26883 .ilist
26884 If &`!`& is used, the ciphers are permanently deleted from the list. The
26885 ciphers deleted can never reappear in the list even if they are explicitly
26886 stated.
26887 .next
26888 If &`-`& is used, the ciphers are deleted from the list, but some or all
26889 of the ciphers can be added again by later options.
26890 .next
26891 If &`+`& is used, the ciphers are moved to the end of the list. This
26892 option does not add any new ciphers; it just moves matching existing ones.
26893 .endlist
26894
26895 If none of these characters is present, the string is interpreted as
26896 a list of ciphers to be appended to the current preference list. If the list
26897 includes any ciphers already present they will be ignored: that is, they will
26898 not be moved to the end of the list.
26899 .endlist
26900
26901 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26902 string:
26903 .code
26904 # note single-quotes to get ! past any shell history expansion
26905 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26906 .endd
26907
26908 This example will let the library defaults be permitted on the MX port, where
26909 there's probably no identity verification anyway, but ups the ante on the
26910 submission ports where the administrator might have some influence on the
26911 choice of clients used:
26912 .code
26913 # OpenSSL variant; see man ciphers(1)
26914 tls_require_ciphers = ${if =={$received_port}{25}\
26915                            {DEFAULT}\
26916                            {HIGH:!MD5:!SHA1}}
26917 .endd
26918
26919
26920
26921 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26922          "SECTreqciphgnu"
26923 .cindex "GnuTLS" "specifying parameters for"
26924 .cindex "TLS" "specifying ciphers (GnuTLS)"
26925 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26926 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26927 .cindex "TLS" "specifying protocols (GnuTLS)"
26928 .cindex "TLS" "specifying priority string (GnuTLS)"
26929 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26930 The GnuTLS library allows the caller to provide a "priority string", documented
26931 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26932 ciphersuite specification in OpenSSL.
26933
26934 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26935 and controls both protocols and ciphers.
26936
26937 The &%tls_require_ciphers%& option is available both as an global option,
26938 controlling how Exim behaves as a server, and also as an option of the
26939 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26940 the value is string expanded.  The resulting string is not an Exim list and
26941 the string is given to the GnuTLS library, so that Exim does not need to be
26942 aware of future feature enhancements of GnuTLS.
26943
26944 Documentation of the strings accepted may be found in the GnuTLS manual, under
26945 "Priority strings".  This is online as
26946 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26947 but beware that this relates to GnuTLS 3, which may be newer than the version
26948 installed on your system.  If you are using GnuTLS 3,
26949 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26950 on that site can be used to test a given string.
26951
26952 For example:
26953 .code
26954 # Disable older versions of protocols
26955 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26956 .endd
26957
26958 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26959 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26960 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26961
26962 This example will let the library defaults be permitted on the MX port, where
26963 there's probably no identity verification anyway, and lowers security further
26964 by increasing compatibility; but this ups the ante on the submission ports
26965 where the administrator might have some influence on the choice of clients
26966 used:
26967 .code
26968 # GnuTLS variant
26969 tls_require_ciphers = ${if =={$received_port}{25}\
26970                            {NORMAL:%COMPAT}\
26971                            {SECURE128}}
26972 .endd
26973
26974
26975 .section "Configuring an Exim server to use TLS" "SECID182"
26976 .cindex "TLS" "configuring an Exim server"
26977 When Exim has been built with TLS support, it advertises the availability of
26978 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26979 but not to any others. The default value of this option is unset, which means
26980 that STARTTLS is not advertised at all. This default is chosen because you
26981 need to set some other options in order to make TLS available, and also it is
26982 sensible for systems that want to use TLS only as a client.
26983
26984 If a client issues a STARTTLS command and there is some configuration
26985 problem in the server, the command is rejected with a 454 error. If the client
26986 persists in trying to issue SMTP commands, all except QUIT are rejected
26987 with the error
26988 .code
26989 554 Security failure
26990 .endd
26991 If a STARTTLS command is issued within an existing TLS session, it is
26992 rejected with a 554 error code.
26993
26994 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26995 match some hosts. You can, of course, set it to * to match all hosts.
26996 However, this is not all you need to do. TLS sessions to a server won't work
26997 without some further configuration at the server end.
26998
26999 It is rumoured that all existing clients that support TLS/SSL use RSA
27000 encryption. To make this work you need to set, in the server,
27001 .code
27002 tls_certificate = /some/file/name
27003 tls_privatekey = /some/file/name
27004 .endd
27005 These options are, in fact, expanded strings, so you can make them depend on
27006 the identity of the client that is connected if you wish. The first file
27007 contains the server's X509 certificate, and the second contains the private key
27008 that goes with it. These files need to be
27009 PEM format and readable by the Exim user, and must
27010 always be given as full path names.
27011 The key must not be password-protected.
27012 They can be the same file if both the
27013 certificate and the key are contained within it. If &%tls_privatekey%& is not
27014 set, or if its expansion is forced to fail or results in an empty string, this
27015 is assumed to be the case. The certificate file may also contain intermediate
27016 certificates that need to be sent to the client to enable it to authenticate
27017 the server's certificate.
27018
27019 If you do not understand about certificates and keys, please try to find a
27020 source of this background information, which is not Exim-specific. (There are a
27021 few comments below in section &<<SECTcerandall>>&.)
27022
27023 &*Note*&: These options do not apply when Exim is operating as a client &--
27024 they apply only in the case of a server. If you need to use a certificate in an
27025 Exim client, you must set the options of the same names in an &(smtp)&
27026 transport.
27027
27028 With just these options, an Exim server will be able to use TLS. It does not
27029 require the client to have a certificate (but see below for how to insist on
27030 this). There is one other option that may be needed in other situations. If
27031 .code
27032 tls_dhparam = /some/file/name
27033 .endd
27034 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27035 with the parameters contained in the file.
27036 Set this to &`none`& to disable use of DH entirely, by making no prime
27037 available:
27038 .code
27039 tls_dhparam = none
27040 .endd
27041 This may also be set to a string identifying a standard prime to be used for
27042 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27043 used is &`ike23`&.  There are a few standard primes available, see the
27044 documentation for &%tls_dhparam%& for the complete list.
27045
27046 See the command
27047 .code
27048 openssl dhparam
27049 .endd
27050 for a way of generating file data.
27051
27052 The strings supplied for these three options are expanded every time a client
27053 host connects. It is therefore possible to use different certificates and keys
27054 for different hosts, if you so wish, by making use of the client's IP address
27055 in &$sender_host_address$& to control the expansion. If a string expansion is
27056 forced to fail, Exim behaves as if the option is not set.
27057
27058 .cindex "cipher" "logging"
27059 .cindex "log" "TLS cipher"
27060 .vindex "&$tls_in_cipher$&"
27061 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27062 an incoming TLS connection. It is included in the &'Received:'& header of an
27063 incoming message (by default &-- you can, of course, change this), and it is
27064 also included in the log line that records a message's arrival, keyed by
27065 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27066 condition can be used to test for specific cipher suites in ACLs.
27067
27068 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27069 can check the name of the cipher suite and vary their actions accordingly. The
27070 cipher suite names vary, depending on which TLS library is being used. For
27071 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27072 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27073 documentation for more details.
27074
27075 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27076 (again depending on the &%tls_cipher%& log selector).
27077
27078
27079 .section "Requesting and verifying client certificates" "SECID183"
27080 .cindex "certificate" "verification of client"
27081 .cindex "TLS" "client certificate verification"
27082 If you want an Exim server to request a certificate when negotiating a TLS
27083 session with a client, you must set either &%tls_verify_hosts%& or
27084 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27085 apply to all TLS connections. For any host that matches one of these options,
27086 Exim requests a certificate as part of the setup of the TLS session. The
27087 contents of the certificate are verified by comparing it with a list of
27088 expected certificates.
27089 These may be the system default set (depending on library version),
27090 an explicit file or,
27091 depending on library version, a directory, identified by
27092 &%tls_verify_certificates%&.
27093
27094 A file can contain multiple certificates, concatenated end to end. If a
27095 directory is used
27096 (OpenSSL only),
27097 each certificate must be in a separate file, with a name (or a symbolic link)
27098 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27099 certificate. You can compute the relevant hash by running the command
27100 .code
27101 openssl x509 -hash -noout -in /cert/file
27102 .endd
27103 where &_/cert/file_& contains a single certificate.
27104
27105 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27106 what happens if the client does not supply a certificate, or if the certificate
27107 does not match any of the certificates in the collection named by
27108 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27109 attempt to set up a TLS session is aborted, and the incoming connection is
27110 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27111 session continues. ACLs that run for subsequent SMTP commands can detect the
27112 fact that no certificate was verified, and vary their actions accordingly. For
27113 example, you can insist on a certificate before accepting a message for
27114 relaying, but not when the message is destined for local delivery.
27115
27116 .vindex "&$tls_in_peerdn$&"
27117 When a client supplies a certificate (whether it verifies or not), the value of
27118 the Distinguished Name of the certificate is made available in the variable
27119 &$tls_in_peerdn$& during subsequent processing of the message.
27120
27121 .cindex "log" "distinguished name"
27122 Because it is often a long text string, it is not included in the log line or
27123 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27124 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27125 &%received_header_text%& to change the &'Received:'& header. When no
27126 certificate is supplied, &$tls_in_peerdn$& is empty.
27127
27128
27129 .section "Revoked certificates" "SECID184"
27130 .cindex "TLS" "revoked certificates"
27131 .cindex "revocation list"
27132 .cindex "certificate" "revocation list"
27133 .cindex "OCSP" "stapling"
27134 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27135 certificates are revoked. If you have such a list, you can pass it to an Exim
27136 server using the global option called &%tls_crl%& and to an Exim client using
27137 an identically named option for the &(smtp)& transport. In each case, the value
27138 of the option is expanded and must then be the name of a file that contains a
27139 CRL in PEM format.
27140 The downside is that clients have to periodically re-download a potentially huge
27141 file from every certificate authority they know of.
27142
27143 The way with most moving parts at query time is Online Certificate
27144 Status Protocol (OCSP), where the client verifies the certificate
27145 against an OCSP server run by the CA.  This lets the CA track all
27146 usage of the certs.  It requires running software with access to the
27147 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27148 is based on HTTP and can be proxied accordingly.
27149
27150 The only widespread OCSP server implementation (known to this writer)
27151 comes as part of OpenSSL and aborts on an invalid request, such as
27152 connecting to the port and then disconnecting.  This requires
27153 re-entering the passphrase each time some random client does this.
27154
27155 The third way is OCSP Stapling; in this, the server using a certificate
27156 issued by the CA periodically requests an OCSP proof of validity from
27157 the OCSP server, then serves it up inline as part of the TLS
27158 negotiation.   This approach adds no extra round trips, does not let the
27159 CA track users, scales well with number of certs issued by the CA and is
27160 resilient to temporary OCSP server failures, as long as the server
27161 starts retrying to fetch an OCSP proof some time before its current
27162 proof expires.  The downside is that it requires server support.
27163
27164 Unless Exim is built with the support disabled,
27165 .new
27166 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27167 .wen
27168 support for OCSP stapling is included.
27169
27170 There is a global option called &%tls_ocsp_file%&.
27171 The file specified therein is expected to be in DER format, and contain
27172 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27173 option will be re-expanded for SNI, if the &%tls_certificate%& option
27174 contains &`tls_in_sni`&, as per other TLS options.
27175
27176 Exim does not at this time implement any support for fetching a new OCSP
27177 proof.  The burden is on the administrator to handle this, outside of
27178 Exim.  The file specified should be replaced atomically, so that the
27179 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27180 on each connection, so a new file will be handled transparently on the
27181 next connection.
27182
27183 When built with OpenSSL Exim will check for a valid next update timestamp
27184 in the OCSP proof; if not present, or if the proof has expired, it will be
27185 ignored.
27186
27187 For the client to be able to verify the stapled OCSP the server must
27188 also supply, in its stapled information, any intermediate
27189 certificates for the chain leading to the OCSP proof from the signer
27190 of the server certificate.  There may be zero or one such. These
27191 intermediate certificates should be added to the server OCSP stapling
27192 file named by &%tls_ocsp_file%&.
27193
27194 Note that the proof only covers the terminal server certificate,
27195 not any of the chain from CA to it.
27196
27197 There is no current way to staple a proof for a client certificate.
27198
27199 .code
27200   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27201   OCSP server is supplied.  The server URL may be included in the
27202   server certificate, if the CA is helpful.
27203
27204   One failure mode seen was the OCSP Signer cert expiring before the end
27205   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27206   noted this as invalid overall, but the re-fetch script did not.
27207 .endd
27208
27209
27210
27211
27212 .section "Configuring an Exim client to use TLS" "SECID185"
27213 .cindex "cipher" "logging"
27214 .cindex "log" "TLS cipher"
27215 .cindex "log" "distinguished name"
27216 .cindex "TLS" "configuring an Exim client"
27217 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27218 deliveries as well as to incoming, the latter one causing logging of the
27219 server certificate's DN. The remaining client configuration for TLS is all
27220 within the &(smtp)& transport.
27221
27222 It is not necessary to set any options to have TLS work in the &(smtp)&
27223 transport. If Exim is built with TLS support, and TLS is advertised by a
27224 server, the &(smtp)& transport always tries to start a TLS session. However,
27225 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27226 transport) to a list of server hosts for which TLS should not be used.
27227
27228 If you do not want Exim to attempt to send messages unencrypted when an attempt
27229 to set up an encrypted connection fails in any way, you can set
27230 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27231 those hosts, delivery is always deferred if an encrypted connection cannot be
27232 set up. If there are any other hosts for the address, they are tried in the
27233 usual way.
27234
27235 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27236 the message unencrypted. It always does this if the response to STARTTLS is
27237 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27238 session after a success response code, what happens is controlled by the
27239 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27240 delivery to this host is deferred, and other hosts (if available) are tried. If
27241 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27242 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27243 negotiation fails, Exim closes the current connection (because it is in an
27244 unknown state), opens a new one to the same host, and then tries the delivery
27245 unencrypted.
27246
27247 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27248 transport provide the client with a certificate, which is passed to the server
27249 if it requests it. If the server is Exim, it will request a certificate only if
27250 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27251
27252 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27253 specifies a collection of expected server certificates.
27254 These may be the system default set (depending on library version),
27255 a file or,
27256 depending on library version, a directory,
27257 must name a file or,
27258 for OpenSSL only (not GnuTLS), a directory.
27259 The client verifies the server's certificate
27260 against this collection, taking into account any revoked certificates that are
27261 in the list defined by &%tls_crl%&.
27262 Failure to verify fails the TLS connection unless either of the
27263 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27264
27265 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27266 certificate verification to the listed servers.  Verification either must
27267 or need not succeed respectively.
27268
27269 The &(smtp)& transport has two OCSP-related options:
27270 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27271 is requested and required for the connection to proceed.  The default
27272 value is empty.
27273 &%hosts_request_ocsp%&; a host-list for which (additionally)
27274 a Certificate Status is requested (but not necessarily verified).  The default
27275 value is "*" meaning that requests are made unless configured
27276 otherwise.
27277
27278 The host(s) should also be in &%hosts_require_tls%&, and
27279 &%tls_verify_certificates%& configured for the transport,
27280 for OCSP to be relevant.
27281
27282 If
27283 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27284 list of permitted cipher suites. If either of these checks fails, delivery to
27285 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27286 alternative hosts, if any.
27287
27288  &*Note*&:
27289 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27290 is operating as a client. Exim does not assume that a server certificate (set
27291 by the global options of the same name) should also be used when operating as a
27292 client.
27293
27294 .vindex "&$host$&"
27295 .vindex "&$host_address$&"
27296 All the TLS options in the &(smtp)& transport are expanded before use, with
27297 &$host$& and &$host_address$& containing the name and address of the server to
27298 which the client is connected. Forced failure of an expansion causes Exim to
27299 behave as if the relevant option were unset.
27300
27301 .vindex &$tls_out_bits$&
27302 .vindex &$tls_out_cipher$&
27303 .vindex &$tls_out_peerdn$&
27304 .vindex &$tls_out_sni$&
27305 Before an SMTP connection is established, the
27306 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27307 variables are emptied. (Until the first connection, they contain the values
27308 that were set when the message was received.) If STARTTLS is subsequently
27309 successfully obeyed, these variables are set to the relevant values for the
27310 outgoing connection.
27311
27312
27313
27314 .section "Use of TLS Server Name Indication" "SECTtlssni"
27315 .cindex "TLS" "Server Name Indication"
27316 .vindex "&$tls_in_sni$&"
27317 .oindex "&%tls_in_sni%&"
27318 With TLS1.0 or above, there is an extension mechanism by which extra
27319 information can be included at various points in the protocol.  One of these
27320 extensions, documented in RFC 6066 (and before that RFC 4366) is
27321 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27322 client in the initial handshake, so that the server can examine the servername
27323 within and possibly choose to use different certificates and keys (and more)
27324 for this session.
27325
27326 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27327 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27328 address.
27329
27330 With SMTP to MX, there are the same problems here as in choosing the identity
27331 against which to validate a certificate: you can't rely on insecure DNS to
27332 provide the identity which you then cryptographically verify.  So this will
27333 be of limited use in that environment.
27334
27335 With SMTP to Submission, there is a well-defined hostname which clients are
27336 connecting to and can validate certificates against.  Thus clients &*can*&
27337 choose to include this information in the TLS negotiation.  If this becomes
27338 wide-spread, then hosters can choose to present different certificates to
27339 different clients.  Or even negotiate different cipher suites.
27340
27341 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27342 if not empty, will be sent on a TLS session as part of the handshake.  There's
27343 nothing more to it.  Choosing a sensible value not derived insecurely is the
27344 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27345 for the lifetime of the client connection (including during authentication).
27346
27347 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27348 received from a client.
27349 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27350
27351 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27352 option (prior to expansion) then the following options will be re-expanded
27353 during TLS session handshake, to permit alternative values to be chosen:
27354
27355 .ilist
27356 .vindex "&%tls_certificate%&"
27357 &%tls_certificate%&
27358 .next
27359 .vindex "&%tls_crl%&"
27360 &%tls_crl%&
27361 .next
27362 .vindex "&%tls_privatekey%&"
27363 &%tls_privatekey%&
27364 .next
27365 .vindex "&%tls_verify_certificates%&"
27366 &%tls_verify_certificates%&
27367 .next
27368 .vindex "&%tls_ocsp_file%&"
27369 &%tls_ocsp_file%&
27370 .endlist
27371
27372 Great care should be taken to deal with matters of case, various injection
27373 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27374 can always be referenced; it is important to remember that &$tls_sni$& is
27375 arbitrary unverified data provided prior to authentication.
27376
27377 The Exim developers are proceeding cautiously and so far no other TLS options
27378 are re-expanded.
27379
27380 When Exim is built against OpenSSL, OpenSSL must have been built with support
27381 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27382 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27383 see &`-servername`& in the output, then OpenSSL has support.
27384
27385 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27386 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27387 built, then you have SNI support).
27388
27389
27390
27391 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27392          "SECTmulmessam"
27393 .cindex "multiple SMTP deliveries with TLS"
27394 .cindex "TLS" "multiple message deliveries"
27395 Exim sends multiple messages down the same TCP/IP connection by starting up
27396 an entirely new delivery process for each message, passing the socket from
27397 one process to the next. This implementation does not fit well with the use
27398 of TLS, because there is quite a lot of state information associated with a TLS
27399 connection, not just a socket identification. Passing all the state information
27400 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27401 session before passing the socket to a new process. The new process may then
27402 try to start a new TLS session, and if successful, may try to re-authenticate
27403 if AUTH is in use, before sending the next message.
27404
27405 The RFC is not clear as to whether or not an SMTP session continues in clear
27406 after TLS has been shut down, or whether TLS may be restarted again later, as
27407 just described. However, if the server is Exim, this shutdown and
27408 reinitialization works. It is not known which (if any) other servers operate
27409 successfully if the client closes a TLS session and continues with unencrypted
27410 SMTP, but there are certainly some that do not work. For such servers, Exim
27411 should not pass the socket to another process, because the failure of the
27412 subsequent attempt to use it would cause Exim to record a temporary host error,
27413 and delay other deliveries to that host.
27414
27415 To test for this case, Exim sends an EHLO command to the server after
27416 closing down the TLS session. If this fails in any way, the connection is
27417 closed instead of being passed to a new delivery process, but no retry
27418 information is recorded.
27419
27420 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27421 &(smtp)& transport to match those hosts for which Exim should not pass
27422 connections to new processes if TLS has been used.
27423
27424
27425
27426
27427 .section "Certificates and all that" "SECTcerandall"
27428 .cindex "certificate" "references to discussion"
27429 In order to understand fully how TLS works, you need to know about
27430 certificates, certificate signing, and certificate authorities. This is not the
27431 place to give a tutorial, especially as I do not know very much about it
27432 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27433 to Apache, currently at
27434 .display
27435 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27436 .endd
27437 Other parts of the &'modssl'& documentation are also helpful, and have
27438 links to further files.
27439 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27440 0-201-61598-3), contains both introductory and more in-depth descriptions.
27441 Some sample programs taken from the book are available from
27442 .display
27443 &url(http://www.rtfm.com/openssl-examples/)
27444 .endd
27445
27446
27447 .section "Certificate chains" "SECID186"
27448 The file named by &%tls_certificate%& may contain more than one
27449 certificate. This is useful in the case where the certificate that is being
27450 sent is validated by an intermediate certificate which the other end does
27451 not have. Multiple certificates must be in the correct order in the file.
27452 First the host's certificate itself, then the first intermediate
27453 certificate to validate the issuer of the host certificate, then the next
27454 intermediate certificate to validate the issuer of the first intermediate
27455 certificate, and so on, until finally (optionally) the root certificate.
27456 The root certificate must already be trusted by the recipient for
27457 validation to succeed, of course, but if it's not preinstalled, sending the
27458 root certificate along with the rest makes it available for the user to
27459 install if the receiving end is a client MUA that can interact with a user.
27460
27461 Note that certificates using MD5 are unlikely to work on today's Internet;
27462 even if your libraries allow loading them for use in Exim when acting as a
27463 server, increasingly clients will not accept such certificates.  The error
27464 diagnostics in such a case can be frustratingly vague.
27465
27466
27467
27468 .section "Self-signed certificates" "SECID187"
27469 .cindex "certificate" "self-signed"
27470 You can create a self-signed certificate using the &'req'& command provided
27471 with OpenSSL, like this:
27472 . ==== Do not shorten the duration here without reading and considering
27473 . ==== the text below.  Please leave it at 9999 days.
27474 .code
27475 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27476             -days 9999 -nodes
27477 .endd
27478 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27479 delimited and so can be identified independently. The &%-days%& option
27480 specifies a period for which the certificate is valid. The &%-nodes%& option is
27481 important: if you do not set it, the key is encrypted with a passphrase
27482 that you are prompted for, and any use that is made of the key causes more
27483 prompting for the passphrase. This is not helpful if you are going to use
27484 this certificate and key in an MTA, where prompting is not possible.
27485
27486 . ==== I expect to still be working 26 years from now.  The less technical
27487 . ==== debt I create, in terms of storing up trouble for my later years, the
27488 . ==== happier I will be then.  We really have reached the point where we
27489 . ==== should start, at the very least, provoking thought and making folks
27490 . ==== pause before proceeding, instead of leaving all the fixes until two
27491 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27492 . ==== -pdp, 2012
27493 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27494 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27495 the above command might produce a date in the past.  Think carefully about
27496 the lifetime of the systems you're deploying, and either reduce the duration
27497 of the certificate or reconsider your platform deployment.  (At time of
27498 writing, reducing the duration is the most likely choice, but the inexorable
27499 progression of time takes us steadily towards an era where this will not
27500 be a sensible resolution).
27501
27502 A self-signed certificate made in this way is sufficient for testing, and
27503 may be adequate for all your requirements if you are mainly interested in
27504 encrypting transfers, and not in secure identification.
27505
27506 However, many clients require that the certificate presented by the server be a
27507 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27508 certificate. In this situation, the self-signed certificate described above
27509 must be installed on the client host as a trusted root &'certification
27510 authority'& (CA), and the certificate used by Exim must be a user certificate
27511 signed with that self-signed certificate.
27512
27513 For information on creating self-signed CA certificates and using them to sign
27514 user certificates, see the &'General implementation overview'& chapter of the
27515 Open-source PKI book, available online at
27516 &url(http://ospkibook.sourceforge.net/).
27517 .ecindex IIDencsmtp1
27518 .ecindex IIDencsmtp2
27519
27520
27521
27522 . ////////////////////////////////////////////////////////////////////////////
27523 . ////////////////////////////////////////////////////////////////////////////
27524
27525 .chapter "Access control lists" "CHAPACL"
27526 .scindex IIDacl "&ACL;" "description"
27527 .cindex "control of incoming mail"
27528 .cindex "message" "controlling incoming"
27529 .cindex "policy control" "access control lists"
27530 Access Control Lists (ACLs) are defined in a separate section of the run time
27531 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27532 name, terminated by a colon. Here is a complete ACL section that contains just
27533 one very small ACL:
27534 .code
27535 begin acl
27536 small_acl:
27537   accept   hosts = one.host.only
27538 .endd
27539 You can have as many lists as you like in the ACL section, and the order in
27540 which they appear does not matter. The lists are self-terminating.
27541
27542 The majority of ACLs are used to control Exim's behaviour when it receives
27543 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27544 when a local process submits a message using SMTP by specifying the &%-bs%&
27545 option. The most common use is for controlling which recipients are accepted
27546 in incoming messages. In addition, you can define an ACL that is used to check
27547 local non-SMTP messages. The default configuration file contains an example of
27548 a realistic ACL for checking RCPT commands. This is discussed in chapter
27549 &<<CHAPdefconfil>>&.
27550
27551
27552 .section "Testing ACLs" "SECID188"
27553 The &%-bh%& command line option provides a way of testing your ACL
27554 configuration locally by running a fake SMTP session with which you interact.
27555
27556
27557 .section "Specifying when ACLs are used" "SECID189"
27558 .cindex "&ACL;" "options for specifying"
27559 In order to cause an ACL to be used, you have to name it in one of the relevant
27560 options in the main part of the configuration. These options are:
27561 .cindex "AUTH" "ACL for"
27562 .cindex "DATA" "ACLs for"
27563 .cindex "ETRN" "ACL for"
27564 .cindex "EXPN" "ACL for"
27565 .cindex "HELO" "ACL for"
27566 .cindex "EHLO" "ACL for"
27567 .cindex "DKIM" "ACL for"
27568 .cindex "MAIL" "ACL for"
27569 .cindex "QUIT, ACL for"
27570 .cindex "RCPT" "ACL for"
27571 .cindex "STARTTLS, ACL for"
27572 .cindex "VRFY" "ACL for"
27573 .cindex "SMTP" "connection, ACL for"
27574 .cindex "non-SMTP messages" "ACLs for"
27575 .cindex "MIME content scanning" "ACL for"
27576 .cindex "PRDR" "ACL for"
27577
27578 .table2 140pt
27579 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27580 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27581 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27582 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27583 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27584 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27585 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27586 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27587 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27588 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27589 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27590 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27591 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27592 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27593 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27594 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27595 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27596 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27597 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27598 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27599 .endtable
27600
27601 For example, if you set
27602 .code
27603 acl_smtp_rcpt = small_acl
27604 .endd
27605 the little ACL defined above is used whenever Exim receives a RCPT command
27606 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27607 done when RCPT commands arrive. A rejection of RCPT should cause the
27608 sending MTA to give up on the recipient address contained in the RCPT
27609 command, whereas rejection at other times may cause the client MTA to keep on
27610 trying to deliver the message. It is therefore recommended that you do as much
27611 testing as possible at RCPT time.
27612
27613
27614 .section "The non-SMTP ACLs" "SECID190"
27615 .cindex "non-SMTP messages" "ACLs for"
27616 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27617 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27618 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27619 the state of the SMTP connection such as encryption and authentication) are not
27620 relevant and are forbidden in these ACLs. However, the sender and recipients
27621 are known, so the &%senders%& and &%sender_domains%& conditions and the
27622 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27623 &$authenticated_sender$& are also available. You can specify added header lines
27624 in any of these ACLs.
27625
27626 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27627 non-SMTP message, before any of the message has been read. (This is the
27628 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27629 batched SMTP input, it runs after the DATA command has been reached. The
27630 result of this ACL is ignored; it cannot be used to reject a message. If you
27631 really need to, you could set a value in an ACL variable here and reject based
27632 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27633 controls, and in particular, it can be used to set
27634 .code
27635 control = suppress_local_fixups
27636 .endd
27637 This cannot be used in the other non-SMTP ACLs because by the time they are
27638 run, it is too late.
27639
27640 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27641 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27642
27643 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27644 kind of rejection is treated as permanent, because there is no way of sending a
27645 temporary error for these kinds of message.
27646
27647
27648 .section "The SMTP connect ACL" "SECID191"
27649 .cindex "SMTP" "connection, ACL for"
27650 .oindex &%smtp_banner%&
27651 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27652 session, after the test specified by &%host_reject_connection%& (which is now
27653 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27654 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27655 the message override the banner message that is otherwise specified by the
27656 &%smtp_banner%& option.
27657
27658
27659 .section "The EHLO/HELO ACL" "SECID192"
27660 .cindex "EHLO" "ACL for"
27661 .cindex "HELO" "ACL for"
27662 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27663 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27664 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27665 Note that a client may issue more than one EHLO or HELO command in an SMTP
27666 session, and indeed is required to issue a new EHLO or HELO after successfully
27667 setting up encryption following a STARTTLS command.
27668
27669 .new
27670 Note also that a deny neither forces the client to go away nor means that
27671 mail will be refused on the connection.  Consider checking for
27672 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27673 .wen
27674
27675 If the command is accepted by an &%accept%& verb that has a &%message%&
27676 modifier, the message may not contain more than one line (it will be truncated
27677 at the first newline and a panic logged if it does). Such a message cannot
27678 affect the EHLO options that are listed on the second and subsequent lines of
27679 an EHLO response.
27680
27681
27682 .section "The DATA ACLs" "SECID193"
27683 .cindex "DATA" "ACLs for"
27684 Two ACLs are associated with the DATA command, because it is two-stage
27685 command, with two responses being sent to the client.
27686 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27687 is obeyed. This gives you control after all the RCPT commands, but before
27688 the message itself is received. It offers the opportunity to give a negative
27689 response to the DATA command before the data is transmitted. Header lines
27690 added by MAIL or RCPT ACLs are not visible at this time, but any that
27691 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27692
27693 You cannot test the contents of the message, for example, to verify addresses
27694 in the headers, at RCPT time or when the DATA command is received. Such
27695 tests have to appear in the ACL that is run after the message itself has been
27696 received, before the final response to the DATA command is sent. This is
27697 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27698 associated with the DATA command.
27699
27700 For both of these ACLs, it is not possible to reject individual recipients. An
27701 error response rejects the entire message. Unfortunately, it is known that some
27702 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27703 before or after the data) correctly &-- they keep the message on their queues
27704 and try again later, but that is their problem, though it does waste some of
27705 your resources.
27706
27707 The &%acl_smtp_data%& ACL is run after
27708 the &%acl_smtp_data_prdr%&,
27709 the &%acl_smtp_dkim%&
27710 and the &%acl_smtp_mime%& ACLs.
27711
27712 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27713 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27714 enabled (which is the default).
27715
27716 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27717 received, and is executed for each DKIM signature found in a message.  If not
27718 otherwise specified, the default action is to accept.
27719
27720 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27721
27722 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27723
27724
27725 .section "The SMTP MIME ACL" "SECID194"
27726 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27727 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27728
27729 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27730
27731
27732 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27733 .cindex "PRDR" "ACL for"
27734 .oindex "&%prdr_enable%&"
27735 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27736 with PRDR support enabled (which is the default).
27737 It becomes active only when the PRDR feature is negotiated between
27738 client and server for a message, and more than one recipient
27739 has been accepted.
27740
27741 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27742 has been received, and is executed once for each recipient of the message
27743 with &$local_part$& and &$domain$& valid.
27744 The test may accept, defer or deny for individual recipients.
27745 The &%acl_smtp_data%& will still be called after this ACL and
27746 can reject the message overall, even if this ACL has accepted it
27747 for some or all recipients.
27748
27749 PRDR may be used to support per-user content filtering.  Without it
27750 one must defer any recipient after the first that has a different
27751 content-filter configuration.  With PRDR, the RCPT-time check
27752 .new
27753 .cindex "PRDR" "variable for"
27754 for this can be disabled when the variable &$prdr_requested$&
27755 is &"yes"&.
27756 .wen
27757 Any required difference in behaviour of the main DATA-time
27758 ACL should however depend on the PRDR-time ACL having run, as Exim
27759 will avoid doing so in some situations (e.g.  single-recipient mails).
27760
27761 See also the &%prdr_enable%& global option
27762 and the &%hosts_try_prdr%& smtp transport option.
27763
27764 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27765 If the ACL is not defined, processing completes as if
27766 the feature was not requested by the client.
27767
27768 .section "The QUIT ACL" "SECTQUITACL"
27769 .cindex "QUIT, ACL for"
27770 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27771 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27772 does not in fact control any access.
27773 For this reason, it may only accept
27774 or warn as its final result.
27775
27776 This ACL can be used for tasks such as custom logging at the end of an SMTP
27777 session. For example, you can use ACL variables in other ACLs to count
27778 messages, recipients, etc., and log the totals at QUIT time using one or
27779 more &%logwrite%& modifiers on a &%warn%& verb.
27780
27781 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27782 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27783
27784 You do not need to have a final &%accept%&, but if you do, you can use a
27785 &%message%& modifier to specify custom text that is sent as part of the 221
27786 response to QUIT.
27787
27788 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27789 failure (for example, failure to open a log file, or when Exim is bombing out
27790 because it has detected an unrecoverable error), all SMTP commands from the
27791 client are given temporary error responses until QUIT is received or the
27792 connection is closed. In these special cases, the QUIT ACL does not run.
27793
27794
27795 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27796 .vindex &$acl_smtp_notquit$&
27797 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27798 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27799 trouble, such as being unable to write to its log files, this ACL is not run,
27800 because it might try to do things (such as write to log files) that make the
27801 situation even worse.
27802
27803 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27804 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27805 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27806 and &%warn%&.
27807
27808 .vindex &$smtp_notquit_reason$&
27809 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27810 to a string that indicates the reason for the termination of the SMTP
27811 connection. The possible values are:
27812 .table2
27813 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27814 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27815 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27816 .irow &`connection-lost`&          "The SMTP connection has been lost"
27817 .irow &`data-timeout`&             "Timeout while reading message data"
27818 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27819 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27820 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27821 .irow &`synchronization-error`&    "SMTP synchronization error"
27822 .irow &`tls-failed`&               "TLS failed to start"
27823 .endtable
27824 In most cases when an SMTP connection is closed without having received QUIT,
27825 Exim sends an SMTP response message before actually closing the connection.
27826 With the exception of the &`acl-drop`& case, the default message can be
27827 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27828 &%drop%& verb in another ACL, it is the message from the other ACL that is
27829 used.
27830
27831
27832 .section "Finding an ACL to use" "SECID195"
27833 .cindex "&ACL;" "finding which to use"
27834 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27835 you can use different ACLs in different circumstances. For example,
27836 .code
27837 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27838                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27839 .endd
27840 In the default configuration file there are some example settings for
27841 providing an RFC 4409 message submission service on port 587 and a
27842 non-standard &"smtps"& service on port 465. You can use a string
27843 expansion like this to choose an ACL for MUAs on these ports which is
27844 more appropriate for this purpose than the default ACL on port 25.
27845
27846 The expanded string does not have to be the name of an ACL in the
27847 configuration file; there are other possibilities. Having expanded the
27848 string, Exim searches for an ACL as follows:
27849
27850 .ilist
27851 If the string begins with a slash, Exim uses it as a file name, and reads its
27852 contents as an ACL. The lines are processed in the same way as lines in the
27853 Exim configuration file. In particular, continuation lines are supported, blank
27854 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27855 If the file does not exist or cannot be read, an error occurs (typically
27856 causing a temporary failure of whatever caused the ACL to be run). For example:
27857 .code
27858 acl_smtp_data = /etc/acls/\
27859   ${lookup{$sender_host_address}lsearch\
27860   {/etc/acllist}{$value}{default}}
27861 .endd
27862 This looks up an ACL file to use on the basis of the host's IP address, falling
27863 back to a default if the lookup fails. If an ACL is successfully read from a
27864 file, it is retained in memory for the duration of the Exim process, so that it
27865 can be re-used without having to re-read the file.
27866 .next
27867 If the string does not start with a slash, and does not contain any spaces,
27868 Exim searches the ACL section of the configuration for an ACL whose name
27869 matches the string.
27870 .next
27871 If no named ACL is found, or if the string contains spaces, Exim parses
27872 the string as an inline ACL. This can save typing in cases where you just
27873 want to have something like
27874 .code
27875 acl_smtp_vrfy = accept
27876 .endd
27877 in order to allow free use of the VRFY command. Such a string may contain
27878 newlines; it is processed in the same way as an ACL that is read from a file.
27879 .endlist
27880
27881
27882
27883
27884 .section "ACL return codes" "SECID196"
27885 .cindex "&ACL;" "return codes"
27886 Except for the QUIT ACL, which does not affect the SMTP return code (see
27887 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27888 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27889 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27890 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27891 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27892 This also causes a 4&'xx'& return code.
27893
27894 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27895 &"deny"&, because there is no mechanism for passing temporary errors to the
27896 submitters of non-SMTP messages.
27897
27898
27899 ACLs that are relevant to message reception may also return &"discard"&. This
27900 has the effect of &"accept"&, but causes either the entire message or an
27901 individual recipient address to be discarded. In other words, it is a
27902 blackholing facility. Use it with care.
27903
27904 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27905 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27906 RCPT ACL is to discard just the one recipient address. If there are no
27907 recipients left when the message's data is received, the DATA ACL is not
27908 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27909 remaining recipients. The &"discard"& return is not permitted for the
27910 &%acl_smtp_predata%& ACL.
27911
27912
27913 .cindex "&[local_scan()]& function" "when all recipients discarded"
27914 The &[local_scan()]& function is always run, even if there are no remaining
27915 recipients; it may create new recipients.
27916
27917
27918
27919 .section "Unset ACL options" "SECID197"
27920 .cindex "&ACL;" "unset options"
27921 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27922 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27923 not defined at all. For any defined ACL, the default action when control
27924 reaches the end of the ACL statements is &"deny"&.
27925
27926 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27927 these two are ACLs that are used only for their side effects. They cannot be
27928 used to accept or reject anything.
27929
27930 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27931 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27932 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27933 when the ACL is not defined is &"accept"&.
27934
27935 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27936 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27937 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27938 messages over an SMTP connection. For an example, see the ACL in the default
27939 configuration file.
27940
27941
27942
27943
27944 .section "Data for message ACLs" "SECID198"
27945 .cindex "&ACL;" "data for message ACL"
27946 .vindex &$domain$&
27947 .vindex &$local_part$&
27948 .vindex &$sender_address$&
27949 .vindex &$sender_host_address$&
27950 .vindex &$smtp_command$&
27951 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27952 that contain information about the host and the message's sender (for example,
27953 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27954 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27955 &$local_part$& are set from the argument address. The entire SMTP command
27956 is available in &$smtp_command$&.
27957
27958 When an ACL for the AUTH parameter of MAIL is running, the variables that
27959 contain information about the host are set, but &$sender_address$& is not yet
27960 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27961 how it is used.
27962
27963 .vindex "&$message_size$&"
27964 The &$message_size$& variable is set to the value of the SIZE parameter on
27965 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27966 that parameter is not given. The value is updated to the true message size by
27967 the time the final DATA ACL is run (after the message data has been
27968 received).
27969
27970 .vindex "&$rcpt_count$&"
27971 .vindex "&$recipients_count$&"
27972 The &$rcpt_count$& variable increases by one for each RCPT command received.
27973 The &$recipients_count$& variable increases by one each time a RCPT command is
27974 accepted, so while an ACL for RCPT is being processed, it contains the number
27975 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27976 &$rcpt_count$& contains the total number of RCPT commands, and
27977 &$recipients_count$& contains the total number of accepted recipients.
27978
27979
27980
27981
27982
27983 .section "Data for non-message ACLs" "SECTdatfornon"
27984 .cindex "&ACL;" "data for non-message ACL"
27985 .vindex &$smtp_command_argument$&
27986 .vindex &$smtp_command$&
27987 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27988 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27989 and the entire SMTP command is available in &$smtp_command$&.
27990 These variables can be tested using a &%condition%& condition. For example,
27991 here is an ACL for use with AUTH, which insists that either the session is
27992 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27993 does not permit authentication methods that use cleartext passwords on
27994 unencrypted connections.
27995 .code
27996 acl_check_auth:
27997   accept encrypted = *
27998   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27999                      {CRAM-MD5}}
28000   deny   message   = TLS encryption or CRAM-MD5 required
28001 .endd
28002 (Another way of applying this restriction is to arrange for the authenticators
28003 that use cleartext passwords not to be advertised when the connection is not
28004 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28005 option to do this.)
28006
28007
28008
28009 .section "Format of an ACL" "SECID199"
28010 .cindex "&ACL;" "format of"
28011 .cindex "&ACL;" "verbs, definition of"
28012 An individual ACL consists of a number of statements. Each statement starts
28013 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28014 Modifiers can change the way the verb operates, define error and log messages,
28015 set variables, insert delays, and vary the processing of accepted messages.
28016
28017 If all the conditions are met, the verb is obeyed. The same condition may be
28018 used (with different arguments) more than once in the same statement. This
28019 provides a means of specifying an &"and"& conjunction between conditions. For
28020 example:
28021 .code
28022 deny  dnslists = list1.example
28023 dnslists = list2.example
28024 .endd
28025 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28026 the conditions and modifiers when it reaches a condition that fails. What
28027 happens then depends on the verb (and in one case, on a special modifier). Not
28028 all the conditions make sense at every testing point. For example, you cannot
28029 test a sender address in the ACL that is run for a VRFY command.
28030
28031
28032 .section "ACL verbs" "SECID200"
28033 The ACL verbs are as follows:
28034
28035 .ilist
28036 .cindex "&%accept%& ACL verb"
28037 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28038 of the conditions are not met, what happens depends on whether &%endpass%&
28039 appears among the conditions (for syntax see below). If the failing condition
28040 is before &%endpass%&, control is passed to the next ACL statement; if it is
28041 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28042 check a RCPT command:
28043 .code
28044 accept domains = +local_domains
28045 endpass
28046 verify = recipient
28047 .endd
28048 If the recipient domain does not match the &%domains%& condition, control
28049 passes to the next statement. If it does match, the recipient is verified, and
28050 the command is accepted if verification succeeds. However, if verification
28051 fails, the ACL yields &"deny"&, because the failing condition is after
28052 &%endpass%&.
28053
28054 The &%endpass%& feature has turned out to be confusing to many people, so its
28055 use is not recommended nowadays. It is always possible to rewrite an ACL so
28056 that &%endpass%& is not needed, and it is no longer used in the default
28057 configuration.
28058
28059 .cindex "&%message%& ACL modifier" "with &%accept%&"
28060 If a &%message%& modifier appears on an &%accept%& statement, its action
28061 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28062 (when an &%accept%& verb either accepts or passes control to the next
28063 statement), &%message%& can be used to vary the message that is sent when an
28064 SMTP command is accepted. For example, in a RCPT ACL you could have:
28065 .display
28066 &`accept  `&<&'some conditions'&>
28067 &`        message = OK, I will allow you through today`&
28068 .endd
28069 You can specify an SMTP response code, optionally followed by an &"extended
28070 response code"& at the start of the message, but the first digit must be the
28071 same as would be sent by default, which is 2 for an &%accept%& verb.
28072
28073 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28074 an error message that is used when access is denied. This behaviour is retained
28075 for backward compatibility, but current &"best practice"& is to avoid the use
28076 of &%endpass%&.
28077
28078
28079 .next
28080 .cindex "&%defer%& ACL verb"
28081 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28082 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28083 &%defer%& is the same as &%deny%&, because there is no way of sending a
28084 temporary error. For a RCPT command, &%defer%& is much the same as using a
28085 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28086 be used in any ACL, and even for a recipient it might be a simpler approach.
28087
28088
28089 .next
28090 .cindex "&%deny%& ACL verb"
28091 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28092 the conditions are not met, control is passed to the next ACL statement. For
28093 example,
28094 .code
28095 deny dnslists = blackholes.mail-abuse.org
28096 .endd
28097 rejects commands from hosts that are on a DNS black list.
28098
28099
28100 .next
28101 .cindex "&%discard%& ACL verb"
28102 &%discard%&: This verb behaves like &%accept%&, except that it returns
28103 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28104 that are concerned with receiving messages. When all the conditions are true,
28105 the sending entity receives a &"success"& response. However, &%discard%& causes
28106 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28107 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28108 message's recipients are discarded. Recipients that are discarded before DATA
28109 do not appear in the log line when the &%received_recipients%& log selector is set.
28110
28111 If the &%log_message%& modifier is set when &%discard%& operates,
28112 its contents are added to the line that is automatically written to the log.
28113 The &%message%& modifier operates exactly as it does for &%accept%&.
28114
28115
28116 .next
28117 .cindex "&%drop%& ACL verb"
28118 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28119 forcibly closed after the 5&'xx'& error message has been sent. For example:
28120 .code
28121 drop   message   = I don't take more than 20 RCPTs
28122        condition = ${if > {$rcpt_count}{20}}
28123 .endd
28124 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28125 The connection is always dropped after sending a 550 response.
28126
28127 .next
28128 .cindex "&%require%& ACL verb"
28129 &%require%&: If all the conditions are met, control is passed to the next ACL
28130 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28131 example, when checking a RCPT command,
28132 .code
28133 require message = Sender did not verify
28134         verify  = sender
28135 .endd
28136 passes control to subsequent statements only if the message's sender can be
28137 verified. Otherwise, it rejects the command. Note the positioning of the
28138 &%message%& modifier, before the &%verify%& condition. The reason for this is
28139 discussed in section &<<SECTcondmodproc>>&.
28140
28141 .next
28142 .cindex "&%warn%& ACL verb"
28143 &%warn%&: If all the conditions are true, a line specified by the
28144 &%log_message%& modifier is written to Exim's main log. Control always passes
28145 to the next ACL statement. If any condition is false, the log line is not
28146 written. If an identical log line is requested several times in the same
28147 message, only one copy is actually written to the log. If you want to force
28148 duplicates to be written, use the &%logwrite%& modifier instead.
28149
28150 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28151 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28152 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28153 first failing condition. There is more about adding header lines in section
28154 &<<SECTaddheadacl>>&.
28155
28156 If any condition on a &%warn%& statement cannot be completed (that is, there is
28157 some sort of defer), the log line specified by &%log_message%& is not written.
28158 This does not include the case of a forced failure from a lookup, which
28159 is considered to be a successful completion. After a defer, no further
28160 conditions or modifiers in the &%warn%& statement are processed. The incident
28161 is logged, and the ACL continues to be processed, from the next statement
28162 onwards.
28163
28164
28165 .vindex "&$acl_verify_message$&"
28166 When one of the &%warn%& conditions is an address verification that fails, the
28167 text of the verification failure message is in &$acl_verify_message$&. If you
28168 want this logged, you must set it up explicitly. For example:
28169 .code
28170 warn   !verify = sender
28171        log_message = sender verify failed: $acl_verify_message
28172 .endd
28173 .endlist
28174
28175 At the end of each ACL there is an implicit unconditional &%deny%&.
28176
28177 As you can see from the examples above, the conditions and modifiers are
28178 written one to a line, with the first one on the same line as the verb, and
28179 subsequent ones on following lines. If you have a very long condition, you can
28180 continue it onto several physical lines by the usual backslash continuation
28181 mechanism. It is conventional to align the conditions vertically.
28182
28183
28184
28185 .section "ACL variables" "SECTaclvariables"
28186 .cindex "&ACL;" "variables"
28187 There are some special variables that can be set during ACL processing. They
28188 can be used to pass information between different ACLs, different invocations
28189 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28190 transports, and filters that are used to deliver a message. The names of these
28191 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28192 an underscore, but the remainder of the name can be any sequence of
28193 alphanumeric characters and underscores that you choose. There is no limit on
28194 the number of ACL variables. The two sets act as follows:
28195 .ilist
28196 The values of those variables whose names begin with &$acl_c$& persist
28197 throughout an SMTP connection. They are never reset. Thus, a value that is set
28198 while receiving one message is still available when receiving the next message
28199 on the same SMTP connection.
28200 .next
28201 The values of those variables whose names begin with &$acl_m$& persist only
28202 while a message is being received. They are reset afterwards. They are also
28203 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28204 .endlist
28205
28206 When a message is accepted, the current values of all the ACL variables are
28207 preserved with the message and are subsequently made available at delivery
28208 time. The ACL variables are set by a modifier called &%set%&. For example:
28209 .code
28210 accept hosts = whatever
28211        set acl_m4 = some value
28212 accept authenticated = *
28213        set acl_c_auth = yes
28214 .endd
28215 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28216 be set. If you want to set a variable without taking any action, you can use a
28217 &%warn%& verb without any other modifiers or conditions.
28218
28219 .oindex &%strict_acl_vars%&
28220 What happens if a syntactically valid but undefined ACL variable is
28221 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28222 false (the default), an empty string is substituted; if it is true, an
28223 error is generated.
28224
28225 Versions of Exim before 4.64 have a limited set of numbered variables, but
28226 their names are compatible, so there is no problem with upgrading.
28227
28228
28229 .section "Condition and modifier processing" "SECTcondmodproc"
28230 .cindex "&ACL;" "conditions; processing"
28231 .cindex "&ACL;" "modifiers; processing"
28232 An exclamation mark preceding a condition negates its result. For example:
28233 .code
28234 deny   domains = *.dom.example
28235       !verify  = recipient
28236 .endd
28237 causes the ACL to return &"deny"& if the recipient domain ends in
28238 &'dom.example'& and the recipient address cannot be verified. Sometimes
28239 negation can be used on the right-hand side of a condition. For example, these
28240 two statements are equivalent:
28241 .code
28242 deny  hosts = !192.168.3.4
28243 deny !hosts =  192.168.3.4
28244 .endd
28245 However, for many conditions (&%verify%& being a good example), only left-hand
28246 side negation of the whole condition is possible.
28247
28248 The arguments of conditions and modifiers are expanded. A forced failure
28249 of an expansion causes a condition to be ignored, that is, it behaves as if the
28250 condition is true. Consider these two statements:
28251 .code
28252 accept  senders = ${lookup{$host_name}lsearch\
28253                   {/some/file}{$value}fail}
28254 accept  senders = ${lookup{$host_name}lsearch\
28255                   {/some/file}{$value}{}}
28256 .endd
28257 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28258 the returned list is searched, but if the lookup fails the behaviour is
28259 different in the two cases. The &%fail%& in the first statement causes the
28260 condition to be ignored, leaving no further conditions. The &%accept%& verb
28261 therefore succeeds. The second statement, however, generates an empty list when
28262 the lookup fails. No sender can match an empty list, so the condition fails,
28263 and therefore the &%accept%& also fails.
28264
28265 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28266 specify actions that are taken as the conditions for a statement are checked;
28267 others specify text for messages that are used when access is denied or a
28268 warning is generated. The &%control%& modifier affects the way an incoming
28269 message is handled.
28270
28271 The positioning of the modifiers in an ACL statement is important, because the
28272 processing of a verb ceases as soon as its outcome is known. Only those
28273 modifiers that have already been encountered will take effect. For example,
28274 consider this use of the &%message%& modifier:
28275 .code
28276 require message = Can't verify sender
28277         verify  = sender
28278         message = Can't verify recipient
28279         verify  = recipient
28280         message = This message cannot be used
28281 .endd
28282 If sender verification fails, Exim knows that the result of the statement is
28283 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28284 so its text is used as the error message. If sender verification succeeds, but
28285 recipient verification fails, the second message is used. If recipient
28286 verification succeeds, the third message becomes &"current"&, but is never used
28287 because there are no more conditions to cause failure.
28288
28289 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28290 modifier that is used, because all the conditions must be true for rejection to
28291 happen. Specifying more than one &%message%& modifier does not make sense, and
28292 the message can even be specified after all the conditions. For example:
28293 .code
28294 deny   hosts = ...
28295       !senders = *@my.domain.example
28296        message = Invalid sender from client host
28297 .endd
28298 The &"deny"& result does not happen until the end of the statement is reached,
28299 by which time Exim has set up the message.
28300
28301
28302
28303 .section "ACL modifiers" "SECTACLmodi"
28304 .cindex "&ACL;" "modifiers; list of"
28305 The ACL modifiers are as follows:
28306
28307 .vlist
28308 .vitem &*add_header*&&~=&~<&'text'&>
28309 This modifier specifies one or more header lines that are to be added to an
28310 incoming message, assuming, of course, that the message is ultimately
28311 accepted. For details, see section &<<SECTaddheadacl>>&.
28312
28313 .vitem &*continue*&&~=&~<&'text'&>
28314 .cindex "&%continue%& ACL modifier"
28315 .cindex "database" "updating in ACL"
28316 This modifier does nothing of itself, and processing of the ACL always
28317 continues with the next condition or modifier. The value of &%continue%& is in
28318 the side effects of expanding its argument. Typically this could be used to
28319 update a database. It is really just a syntactic tidiness, to avoid having to
28320 write rather ugly lines like this:
28321 .display
28322 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28323 .endd
28324 Instead, all you need is
28325 .display
28326 &`continue = `&<&'some expansion'&>
28327 .endd
28328
28329 .vitem &*control*&&~=&~<&'text'&>
28330 .cindex "&%control%& ACL modifier"
28331 This modifier affects the subsequent processing of the SMTP connection or of an
28332 incoming message that is accepted. The effect of the first type of control
28333 lasts for the duration of the connection, whereas the effect of the second type
28334 lasts only until the current message has been received. The message-specific
28335 controls always apply to the whole message, not to individual recipients,
28336 even if the &%control%& modifier appears in a RCPT ACL.
28337
28338 As there are now quite a few controls that can be applied, they are described
28339 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28340 in several different ways. For example:
28341
28342 . ==== As this is a nested list, any displays it contains must be indented
28343 . ==== as otherwise they are too far to the left. That comment applies only
28344 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28345 . ==== way.
28346
28347 .ilist
28348 It can be at the end of an &%accept%& statement:
28349 .code
28350     accept  ...some conditions
28351             control = queue_only
28352 .endd
28353 In this case, the control is applied when this statement yields &"accept"&, in
28354 other words, when the conditions are all true.
28355
28356 .next
28357 It can be in the middle of an &%accept%& statement:
28358 .code
28359     accept  ...some conditions...
28360             control = queue_only
28361             ...some more conditions...
28362 .endd
28363 If the first set of conditions are true, the control is applied, even if the
28364 statement does not accept because one of the second set of conditions is false.
28365 In this case, some subsequent statement must yield &"accept"& for the control
28366 to be relevant.
28367
28368 .next
28369 It can be used with &%warn%& to apply the control, leaving the
28370 decision about accepting or denying to a subsequent verb. For
28371 example:
28372 .code
28373     warn    ...some conditions...
28374             control = freeze
28375     accept  ...
28376 .endd
28377 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28378 &%logwrite%&, so it does not add anything to the message and does not write a
28379 log entry.
28380
28381 .next
28382 If you want to apply a control unconditionally, you can use it with a
28383 &%require%& verb. For example:
28384 .code
28385     require  control = no_multiline_responses
28386 .endd
28387 .endlist
28388
28389 .vitem &*delay*&&~=&~<&'time'&>
28390 .cindex "&%delay%& ACL modifier"
28391 .oindex "&%-bh%&"
28392 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28393 the time interval before proceeding. However, when testing Exim using the
28394 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28395 output instead). The time is given in the usual Exim notation, and the delay
28396 happens as soon as the modifier is processed. In an SMTP session, pending
28397 output is flushed before the delay is imposed.
28398
28399 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28400 example:
28401 .code
28402 deny    ...some conditions...
28403         delay = 30s
28404 .endd
28405 The delay happens if all the conditions are true, before the statement returns
28406 &"deny"&. Compare this with:
28407 .code
28408 deny    delay = 30s
28409         ...some conditions...
28410 .endd
28411 which waits for 30s before processing the conditions. The &%delay%& modifier
28412 can also be used with &%warn%& and together with &%control%&:
28413 .code
28414 warn    ...some conditions...
28415         delay = 2m
28416         control = freeze
28417 accept  ...
28418 .endd
28419
28420 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28421 responses to several commands are no longer buffered and sent in one packet (as
28422 they would normally be) because all output is flushed before imposing the
28423 delay. This optimization is disabled so that a number of small delays do not
28424 appear to the client as one large aggregated delay that might provoke an
28425 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28426 using a &%control%& modifier to set &%no_delay_flush%&.
28427
28428
28429 .vitem &*endpass*&
28430 .cindex "&%endpass%& ACL modifier"
28431 This modifier, which has no argument, is recognized only in &%accept%& and
28432 &%discard%& statements. It marks the boundary between the conditions whose
28433 failure causes control to pass to the next statement, and the conditions whose
28434 failure causes the ACL to return &"deny"&. This concept has proved to be
28435 confusing to some people, so the use of &%endpass%& is no longer recommended as
28436 &"best practice"&. See the description of &%accept%& above for more details.
28437
28438
28439 .vitem &*log_message*&&~=&~<&'text'&>
28440 .cindex "&%log_message%& ACL modifier"
28441 This modifier sets up a message that is used as part of the log message if the
28442 ACL denies access or a &%warn%& statement's conditions are true. For example:
28443 .code
28444 require log_message = wrong cipher suite $tls_in_cipher
28445         encrypted   = DES-CBC3-SHA
28446 .endd
28447 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28448 example:
28449 .display
28450 &`discard `&<&'some conditions'&>
28451 &`        log_message = Discarded $local_part@$domain because...`&
28452 .endd
28453 When access is denied, &%log_message%& adds to any underlying error message
28454 that may exist because of a condition failure. For example, while verifying a
28455 recipient address, a &':fail:'& redirection might have already set up a
28456 message.
28457
28458 The message may be defined before the conditions to which it applies, because
28459 the string expansion does not happen until Exim decides that access is to be
28460 denied. This means that any variables that are set by the condition are
28461 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28462 variables are set after a DNS black list lookup succeeds. If the expansion of
28463 &%log_message%& fails, or if the result is an empty string, the modifier is
28464 ignored.
28465
28466 .vindex "&$acl_verify_message$&"
28467 If you want to use a &%warn%& statement to log the result of an address
28468 verification, you can use &$acl_verify_message$& to include the verification
28469 error message.
28470
28471 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28472 the start of the logged message. If the same warning log message is requested
28473 more than once while receiving  a single email message, only one copy is
28474 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28475 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28476 is logged for a successful &%warn%& statement.
28477
28478 If &%log_message%& is not present and there is no underlying error message (for
28479 example, from the failure of address verification), but &%message%& is present,
28480 the &%message%& text is used for logging rejections. However, if any text for
28481 logging contains newlines, only the first line is logged. In the absence of
28482 both &%log_message%& and &%message%&, a default built-in message is used for
28483 logging rejections.
28484
28485
28486 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28487 .cindex "&%log_reject_target%& ACL modifier"
28488 .cindex "logging in ACL" "specifying which log"
28489 This modifier makes it possible to specify which logs are used for messages
28490 about ACL rejections. Its argument is a colon-separated list of words that can
28491 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28492 may be empty, in which case a rejection is not logged at all. For example, this
28493 ACL fragment writes no logging information when access is denied:
28494 .display
28495 &`deny `&<&'some conditions'&>
28496 &`     log_reject_target =`&
28497 .endd
28498 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28499 permanent and temporary rejections. Its effect lasts for the rest of the
28500 current ACL.
28501
28502
28503 .vitem &*logwrite*&&~=&~<&'text'&>
28504 .cindex "&%logwrite%& ACL modifier"
28505 .cindex "logging in ACL" "immediate"
28506 This modifier writes a message to a log file as soon as it is encountered when
28507 processing an ACL. (Compare &%log_message%&, which, except in the case of
28508 &%warn%& and &%discard%&, is used only if the ACL statement denies
28509 access.) The &%logwrite%& modifier can be used to log special incidents in
28510 ACLs. For example:
28511 .display
28512 &`accept `&<&'some special conditions'&>
28513 &`       control  = freeze`&
28514 &`       logwrite = froze message because ...`&
28515 .endd
28516 By default, the message is written to the main log. However, it may begin
28517 with a colon, followed by a comma-separated list of log names, and then
28518 another colon, to specify exactly which logs are to be written. For
28519 example:
28520 .code
28521 logwrite = :main,reject: text for main and reject logs
28522 logwrite = :panic: text for panic log only
28523 .endd
28524
28525
28526 .vitem &*message*&&~=&~<&'text'&>
28527 .cindex "&%message%& ACL modifier"
28528 This modifier sets up a text string that is expanded and used as a response
28529 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28530 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28531 there is some complication if &%endpass%& is involved; see the description of
28532 &%accept%& for details.)
28533
28534 The expansion of the message happens at the time Exim decides that the ACL is
28535 to end, not at the time it processes &%message%&. If the expansion fails, or
28536 generates an empty string, the modifier is ignored. Here is an example where
28537 &%message%& must be specified first, because the ACL ends with a rejection if
28538 the &%hosts%& condition fails:
28539 .code
28540 require  message = Host not recognized
28541          hosts = 10.0.0.0/8
28542 .endd
28543 (Once a condition has failed, no further conditions or modifiers are
28544 processed.)
28545
28546 .cindex "SMTP" "error codes"
28547 .oindex "&%smtp_banner%&
28548 For ACLs that are triggered by SMTP commands, the message is returned as part
28549 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28550 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28551 is accepted. In the case of the connect ACL, accepting with a message modifier
28552 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28553 accept message may not contain more than one line (otherwise it will be
28554 truncated at the first newline and a panic logged), and it cannot affect the
28555 EHLO options.
28556
28557 When SMTP is involved, the message may begin with an overriding response code,
28558 consisting of three digits optionally followed by an &"extended response code"&
28559 of the form &'n.n.n'&, each code being followed by a space. For example:
28560 .code
28561 deny  message = 599 1.2.3 Host not welcome
28562       hosts = 192.168.34.0/24
28563 .endd
28564 The first digit of the supplied response code must be the same as would be sent
28565 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28566 access, but for the predata ACL, note that the default success code is 354, not
28567 2&'xx'&.
28568
28569 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28570 the message modifier cannot override the 221 response code.
28571
28572 The text in a &%message%& modifier is literal; any quotes are taken as
28573 literals, but because the string is expanded, backslash escapes are processed
28574 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28575 response.
28576
28577 .vindex "&$acl_verify_message$&"
28578 For ACLs that are called by an &%acl =%& ACL condition, the message is
28579 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28580
28581 If &%message%& is used on a statement that verifies an address, the message
28582 specified overrides any message that is generated by the verification process.
28583 However, the original message is available in the variable
28584 &$acl_verify_message$&, so you can incorporate it into your message if you
28585 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28586 routers to be passed back as part of the SMTP response, you should either not
28587 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28588
28589 For compatibility with previous releases of Exim, a &%message%& modifier that
28590 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28591 modifier, but this usage is now deprecated. However, &%message%& acts only when
28592 all the conditions are true, wherever it appears in an ACL command, whereas
28593 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28594 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28595 effect.
28596
28597
28598 .vitem &*remove_header*&&~=&~<&'text'&>
28599 This modifier specifies one or more header names in a colon-separated list
28600  that are to be removed from an incoming message, assuming, of course, that
28601 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28602
28603
28604 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28605 .cindex "&%set%& ACL modifier"
28606 This modifier puts a value into one of the ACL variables (see section
28607 &<<SECTaclvariables>>&).
28608
28609
28610 .vitem &*udpsend*&&~=&~<&'parameters'&>
28611 This modifier sends a UDP packet, for purposes such as statistics
28612 collection or behaviour monitoring. The parameters are expanded, and
28613 the result of the expansion must be a colon-separated list consisting
28614 of a destination server, port number, and the packet contents. The
28615 server can be specified as a host name or IPv4 or IPv6 address. The
28616 separator can be changed with the usual angle bracket syntax. For
28617 example, you might want to collect information on which hosts connect
28618 when:
28619 .code
28620 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28621              $tod_zulu $sender_host_address
28622 .endd
28623 .endlist
28624
28625
28626
28627
28628 .section "Use of the control modifier" "SECTcontrols"
28629 .cindex "&%control%& ACL modifier"
28630 The &%control%& modifier supports the following settings:
28631
28632 .vlist
28633 .vitem &*control&~=&~allow_auth_unadvertised*&
28634 This modifier allows a client host to use the SMTP AUTH command even when it
28635 has not been advertised in response to EHLO. Furthermore, because there are
28636 apparently some really broken clients that do this, Exim will accept AUTH after
28637 HELO (rather than EHLO) when this control is set. It should be used only if you
28638 really need it, and you should limit its use to those broken clients that do
28639 not work without it. For example:
28640 .code
28641 warn hosts   = 192.168.34.25
28642      control = allow_auth_unadvertised
28643 .endd
28644 Normally, when an Exim server receives an AUTH command, it checks the name of
28645 the authentication mechanism that is given in the command to ensure that it
28646 matches an advertised mechanism. When this control is set, the check that a
28647 mechanism has been advertised is bypassed. Any configured mechanism can be used
28648 by the client. This control is permitted only in the connection and HELO ACLs.
28649
28650
28651 .vitem &*control&~=&~caseful_local_part*& &&&
28652        &*control&~=&~caselower_local_part*&
28653 .cindex "&ACL;" "case of local part in"
28654 .cindex "case of local parts"
28655 .vindex "&$local_part$&"
28656 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28657 (that is, during RCPT processing). By default, the contents of &$local_part$&
28658 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28659 any uppercase letters in the original local part are restored in &$local_part$&
28660 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28661 is encountered.
28662
28663 These controls affect only the current recipient. Moreover, they apply only to
28664 local part handling that takes place directly in the ACL (for example, as a key
28665 in lookups). If a test to verify the recipient is obeyed, the case-related
28666 handling of the local part during the verification is controlled by the router
28667 configuration (see the &%caseful_local_part%& generic router option).
28668
28669 This facility could be used, for example, to add a spam score to local parts
28670 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28671 spam score:
28672 .code
28673 warn  control = caseful_local_part
28674       set acl_m4 = ${eval:\
28675                      $acl_m4 + \
28676                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28677                     }
28678       control = caselower_local_part
28679 .endd
28680 Notice that we put back the lower cased version afterwards, assuming that
28681 is what is wanted for subsequent tests.
28682
28683
28684 .vitem &*control&~=&~cutthrough_delivery*&
28685 .cindex "&ACL;" "cutthrough routing"
28686 .cindex "cutthrough" "requesting"
28687 This option requests delivery be attempted while the item is being received.
28688
28689 The option is usable in the RCPT ACL.
28690 If enabled for a message received via smtp and routed to an smtp transport,
28691 and only one transport, interface, destination host and port combination
28692 is used for all recipients of the message,
28693 then the delivery connection is made while the receiving connection is open
28694 and data is copied from one to the other.
28695
28696 An attempt to set this option for any recipient but the first
28697 for a mail will be quietly ignored.
28698 If a recipient-verify callout
28699 .new
28700 (with use_sender)
28701 .wen
28702 connection is subsequently
28703 requested in the same ACL it is held open and used for
28704 any subsequent recipients and the data,
28705 otherwise one is made after the initial RCPT ACL completes.
28706
28707 Note that routers are used in verify mode,
28708 and cannot depend on content of received headers.
28709 Note also that headers cannot be
28710 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28711 Headers may be modified by routers (subject to the above) and transports.
28712
28713 .new
28714 All the usual ACLs are called; if one results in the message being
28715 rejected, all effort spent in delivery (including the costs on
28716 the ultimate destination) will be wasted.
28717 Note that in the case of data-time ACLs this includes the entire
28718 message body.
28719 .wen
28720
28721 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28722 of outgoing messages is done, because it sends data to the ultimate destination
28723 before the entire message has been received from the source.
28724 It is not supported for messages received with the SMTP PRDR option in use.
28725
28726 Should the ultimate destination system positively accept or reject the mail,
28727 a corresponding indication is given to the source system and nothing is queued.
28728 If there is a temporary error the item is queued for later delivery in the
28729 usual fashion. If the item is successfully delivered in cutthrough mode
28730 the delivery log lines are tagged with ">>" rather than "=>" and appear
28731 before the acceptance "<=" line.
28732
28733 Delivery in this mode avoids the generation of a bounce mail to a
28734 (possibly faked)
28735 sender when the destination system is doing content-scan based rejection.
28736
28737
28738 .vitem &*control&~=&~debug/*&<&'options'&>
28739 .cindex "&ACL;" "enabling debug logging"
28740 .cindex "debugging" "enabling from an ACL"
28741 This control turns on debug logging, almost as though Exim had been invoked
28742 with &`-d`&, with the output going to a new logfile, by default called
28743 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28744 may access any variables already defined.  The logging may be adjusted with
28745 the &'opts'& option, which takes the same values as the &`-d`& command-line
28746 option.  Some examples (which depend on variables that don't exist in all
28747 contexts):
28748 .code
28749       control = debug
28750       control = debug/tag=.$sender_host_address
28751       control = debug/opts=+expand+acl
28752       control = debug/tag=.$message_exim_id/opts=+expand
28753 .endd
28754
28755
28756 .vitem &*control&~=&~dkim_disable_verify*&
28757 .cindex "disable DKIM verify"
28758 .cindex "DKIM" "disable verify"
28759 This control turns off DKIM verification processing entirely.  For details on
28760 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28761
28762
28763 .vitem &*control&~=&~dscp/*&<&'value'&>
28764 .cindex "&ACL;" "setting DSCP value"
28765 .cindex "DSCP" "inbound"
28766 This option causes the DSCP value associated with the socket for the inbound
28767 connection to be adjusted to a given value, given as one of a number of fixed
28768 strings or to numeric value.
28769 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28770 Common values include &`throughput`&, &`mincost`&, and on newer systems
28771 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28772
28773 The outbound packets from Exim will be marked with this value in the header
28774 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28775 that these values will have any effect, not be stripped by networking
28776 equipment, or do much of anything without cooperation with your Network
28777 Engineer and those of all network operators between the source and destination.
28778
28779
28780 .vitem &*control&~=&~enforce_sync*& &&&
28781        &*control&~=&~no_enforce_sync*&
28782 .cindex "SMTP" "synchronization checking"
28783 .cindex "synchronization checking in SMTP"
28784 These controls make it possible to be selective about when SMTP synchronization
28785 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28786 state of the switch (it is true by default). See the description of this option
28787 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28788
28789 The effect of these two controls lasts for the remainder of the SMTP
28790 connection. They can appear in any ACL except the one for the non-SMTP
28791 messages. The most straightforward place to put them is in the ACL defined by
28792 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28793 before the first synchronization check. The expected use is to turn off the
28794 synchronization checks for badly-behaved hosts that you nevertheless need to
28795 work with.
28796
28797
28798 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28799 .cindex "fake defer"
28800 .cindex "defer, fake"
28801 This control works in exactly the same way as &%fakereject%& (described below)
28802 except that it causes an SMTP 450 response after the message data instead of a
28803 550 response. You must take care when using &%fakedefer%& because it causes the
28804 messages to be duplicated when the sender retries. Therefore, you should not
28805 use &%fakedefer%& if the message is to be delivered normally.
28806
28807 .vitem &*control&~=&~fakereject/*&<&'message'&>
28808 .cindex "fake rejection"
28809 .cindex "rejection, fake"
28810 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28811 words, only when an SMTP message is being received. If Exim accepts the
28812 message, instead the final 250 response, a 550 rejection message is sent.
28813 However, Exim proceeds to deliver the message as normal. The control applies
28814 only to the current message, not to any subsequent ones that may be received in
28815 the same SMTP connection.
28816
28817 The text for the 550 response is taken from the &%control%& modifier. If no
28818 message is supplied, the following is used:
28819 .code
28820 550-Your message has been rejected but is being
28821 550-kept for evaluation.
28822 550-If it was a legitimate message, it may still be
28823 550 delivered to the target recipient(s).
28824 .endd
28825 This facility should be used with extreme caution.
28826
28827 .vitem &*control&~=&~freeze*&
28828 .cindex "frozen messages" "forcing in ACL"
28829 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28830 other words, only when a message is being received. If the message is accepted,
28831 it is placed on Exim's queue and frozen. The control applies only to the
28832 current message, not to any subsequent ones that may be received in the same
28833 SMTP connection.
28834
28835 This modifier can optionally be followed by &`/no_tell`&. If the global option
28836 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28837 is told about the freezing), provided all the &*control=freeze*& modifiers that
28838 are obeyed for the current message have the &`/no_tell`& option.
28839
28840 .vitem &*control&~=&~no_delay_flush*&
28841 .cindex "SMTP" "output flushing, disabling for delay"
28842 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28843 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28844 use. This control, as long as it is encountered before the &%delay%& modifier,
28845 disables such output flushing.
28846
28847 .vitem &*control&~=&~no_callout_flush*&
28848 .cindex "SMTP" "output flushing, disabling for callout"
28849 Exim normally flushes SMTP output before performing a callout in an ACL, to
28850 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28851 use. This control, as long as it is encountered before the &%verify%& condition
28852 that causes the callout, disables such output flushing.
28853
28854 .vitem &*control&~=&~no_mbox_unspool*&
28855 This control is available when Exim is compiled with the content scanning
28856 extension. Content scanning may require a copy of the current message, or parts
28857 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28858 or spam scanner. Normally, such copies are deleted when they are no longer
28859 needed. If this control is set, the copies are not deleted. The control applies
28860 only to the current message, not to any subsequent ones that may be received in
28861 the same SMTP connection. It is provided for debugging purposes and is unlikely
28862 to be useful in production.
28863
28864 .vitem &*control&~=&~no_multiline_responses*&
28865 .cindex "multiline responses, suppressing"
28866 This control is permitted for any ACL except the one for non-SMTP messages.
28867 It seems that there are broken clients in use that cannot handle multiline
28868 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28869
28870 If this control is set, multiline SMTP responses from ACL rejections are
28871 suppressed. One way of doing this would have been to put out these responses as
28872 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28873 (&"use multiline responses for more"& it says &-- ha!), and some of the
28874 responses might get close to that. So this facility, which is after all only a
28875 sop to broken clients, is implemented by doing two very easy things:
28876
28877 .ilist
28878 Extra information that is normally output as part of a rejection caused by
28879 sender verification failure is omitted. Only the final line (typically &"sender
28880 verification failed"&) is sent.
28881 .next
28882 If a &%message%& modifier supplies a multiline response, only the first
28883 line is output.
28884 .endlist
28885
28886 The setting of the switch can, of course, be made conditional on the
28887 calling host. Its effect lasts until the end of the SMTP connection.
28888
28889 .vitem &*control&~=&~no_pipelining*&
28890 .cindex "PIPELINING" "suppressing advertising"
28891 This control turns off the advertising of the PIPELINING extension to SMTP in
28892 the current session. To be useful, it must be obeyed before Exim sends its
28893 response to an EHLO command. Therefore, it should normally appear in an ACL
28894 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28895 &%pipelining_advertise_hosts%&.
28896
28897 .vitem &*control&~=&~queue_only*&
28898 .oindex "&%queue_only%&"
28899 .cindex "queueing incoming messages"
28900 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28901 other words, only when a message is being received. If the message is accepted,
28902 it is placed on Exim's queue and left there for delivery by a subsequent queue
28903 runner. No immediate delivery process is started. In other words, it has the
28904 effect as the &%queue_only%& global option. However, the control applies only
28905 to the current message, not to any subsequent ones that may be received in the
28906 same SMTP connection.
28907
28908 .vitem &*control&~=&~submission/*&<&'options'&>
28909 .cindex "message" "submission"
28910 .cindex "submission mode"
28911 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28912 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28913 the current message is a submission from a local MUA. In this case, Exim
28914 operates in &"submission mode"&, and applies certain fixups to the message if
28915 necessary. For example, it adds a &'Date:'& header line if one is not present.
28916 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28917 late (the message has already been created).
28918
28919 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28920 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28921 submission mode; the available options for this control are described there.
28922 The control applies only to the current message, not to any subsequent ones
28923 that may be received in the same SMTP connection.
28924
28925 .vitem &*control&~=&~suppress_local_fixups*&
28926 .cindex "submission fixups, suppressing"
28927 This control applies to locally submitted (non TCP/IP) messages, and is the
28928 complement of &`control = submission`&. It disables the fixups that are
28929 normally applied to locally-submitted messages. Specifically:
28930
28931 .ilist
28932 Any &'Sender:'& header line is left alone (in this respect, it is a
28933 dynamic version of &%local_sender_retain%&).
28934 .next
28935 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28936 .next
28937 There is no check that &'From:'& corresponds to the actual sender.
28938 .endlist ilist
28939
28940 This control may be useful when a remotely-originated message is accepted,
28941 passed to some scanning program, and then re-submitted for delivery. It can be
28942 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28943 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28944 data is read.
28945
28946 &*Note:*& This control applies only to the current message, not to any others
28947 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28948
28949 .new
28950 .vitem &*control&~=&~utf8_downconvert*&
28951 This control enables conversion of UTF-8 in message addresses
28952 to a-label form.
28953 For details see &<<SECTi18nMTA>>&.
28954 .wen
28955 .endlist vlist
28956
28957
28958 .section "Summary of message fixup control" "SECTsummesfix"
28959 All four possibilities for message fixups can be specified:
28960
28961 .ilist
28962 Locally submitted, fixups applied: the default.
28963 .next
28964 Locally submitted, no fixups applied: use
28965 &`control = suppress_local_fixups`&.
28966 .next
28967 Remotely submitted, no fixups applied: the default.
28968 .next
28969 Remotely submitted, fixups applied: use &`control = submission`&.
28970 .endlist
28971
28972
28973
28974 .section "Adding header lines in ACLs" "SECTaddheadacl"
28975 .cindex "header lines" "adding in an ACL"
28976 .cindex "header lines" "position of added lines"
28977 .cindex "&%add_header%& ACL modifier"
28978 The &%add_header%& modifier can be used to add one or more extra header lines
28979 to an incoming message, as in this example:
28980 .code
28981 warn dnslists = sbl.spamhaus.org : \
28982                 dialup.mail-abuse.org
28983      add_header = X-blacklisted-at: $dnslist_domain
28984 .endd
28985 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28986 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28987 receiving a message). The message must ultimately be accepted for
28988 &%add_header%& to have any significant effect. You can use &%add_header%& with
28989 any ACL verb, including &%deny%& (though this is potentially useful only in a
28990 RCPT ACL).
28991
28992 Headers will not be added to the message if the modifier is used in
28993 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28994
28995 Leading and trailing newlines are removed from
28996 the data for the &%add_header%& modifier; if it then
28997 contains one or more newlines that
28998 are not followed by a space or a tab, it is assumed to contain multiple header
28999 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29000 front of any line that is not a valid header line.
29001
29002 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29003 They are added to the message before processing the DATA and MIME ACLs.
29004 However, if an identical header line is requested more than once, only one copy
29005 is actually added to the message. Further header lines may be accumulated
29006 during the DATA and MIME ACLs, after which they are added to the message, again
29007 with duplicates suppressed. Thus, it is possible to add two identical header
29008 lines to an SMTP message, but only if one is added before DATA and one after.
29009 In the case of non-SMTP messages, new headers are accumulated during the
29010 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29011 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29012 are included in the entry that is written to the reject log.
29013
29014 .cindex "header lines" "added; visibility of"
29015 Header lines are not visible in string expansions
29016 of message headers
29017 until they are added to the
29018 message. It follows that header lines defined in the MAIL, RCPT, and predata
29019 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29020 header lines that are added by the DATA or MIME ACLs are not visible in those
29021 ACLs. Because of this restriction, you cannot use header lines as a way of
29022 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29023 this, you can use ACL variables, as described in section
29024 &<<SECTaclvariables>>&.
29025
29026 The list of headers yet to be added is given by the &%$headers_added%& variable.
29027
29028 The &%add_header%& modifier acts immediately as it is encountered during the
29029 processing of an ACL. Notice the difference between these two cases:
29030 .display
29031 &`accept add_header = ADDED: some text`&
29032 &`       `&<&'some condition'&>
29033
29034 &`accept `&<&'some condition'&>
29035 &`       add_header = ADDED: some text`&
29036 .endd
29037 In the first case, the header line is always added, whether or not the
29038 condition is true. In the second case, the header line is added only if the
29039 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29040 ACL statement. All those that are encountered before a condition fails are
29041 honoured.
29042
29043 .cindex "&%warn%& ACL verb"
29044 For compatibility with previous versions of Exim, a &%message%& modifier for a
29045 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29046 effect only if all the conditions are true, even if it appears before some of
29047 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29048 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29049 are present on a &%warn%& verb, both are processed according to their
29050 specifications.
29051
29052 By default, new header lines are added to a message at the end of the existing
29053 header lines. However, you can specify that any particular header line should
29054 be added right at the start (before all the &'Received:'& lines), immediately
29055 after the first block of &'Received:'& lines, or immediately before any line
29056 that is not a &'Received:'& or &'Resent-something:'& header.
29057
29058 This is done by specifying &":at_start:"&, &":after_received:"&, or
29059 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29060 header line, respectively. (Header text cannot start with a colon, as there has
29061 to be a header name first.) For example:
29062 .code
29063 warn add_header = \
29064        :after_received:X-My-Header: something or other...
29065 .endd
29066 If more than one header line is supplied in a single &%add_header%& modifier,
29067 each one is treated independently and can therefore be placed differently. If
29068 you add more than one line at the start, or after the Received: block, they end
29069 up in reverse order.
29070
29071 &*Warning*&: This facility currently applies only to header lines that are
29072 added in an ACL. It does NOT work for header lines that are added in a
29073 system filter or in a router or transport.
29074
29075
29076
29077 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29078 .cindex "header lines" "removing in an ACL"
29079 .cindex "header lines" "position of removed lines"
29080 .cindex "&%remove_header%& ACL modifier"
29081 The &%remove_header%& modifier can be used to remove one or more header lines
29082 from an incoming message, as in this example:
29083 .code
29084 warn   message        = Remove internal headers
29085        remove_header  = x-route-mail1 : x-route-mail2
29086 .endd
29087 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29088 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29089 receiving a message). The message must ultimately be accepted for
29090 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29091 with any ACL verb, including &%deny%&, though this is really not useful for
29092 any verb that doesn't result in a delivered message.
29093
29094 Headers will not be removed to the message if the modifier is used in
29095 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
29096
29097 More than one header can be removed at the same time by using a colon separated
29098 list of header names. The header matching is case insensitive. Wildcards are
29099 not permitted, nor is list expansion performed, so you cannot use hostlists to
29100 create a list of headers, however both connection and message variable expansion
29101 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29102 .code
29103 warn   hosts           = +internal_hosts
29104        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29105 warn   message         = Remove internal headers
29106        remove_header   = $acl_c_ihdrs
29107 .endd
29108 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29109 They are removed from the message before processing the DATA and MIME ACLs.
29110 There is no harm in attempting to remove the same header twice nor is removing
29111 a non-existent header. Further header lines to be removed may be accumulated
29112 during the DATA and MIME ACLs, after which they are removed from the message,
29113 if present. In the case of non-SMTP messages, headers to be removed are
29114 accumulated during the non-SMTP ACLs, and are removed from the message after
29115 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29116 ACL, there really is no effect because there is no logging of what headers
29117 would have been removed.
29118
29119 .cindex "header lines" "removed; visibility of"
29120 Header lines are not visible in string expansions until the DATA phase when it
29121 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29122 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29123 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29124 this restriction, you cannot use header lines as a way of controlling data
29125 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29126 you should instead use ACL variables, as described in section
29127 &<<SECTaclvariables>>&.
29128
29129 The &%remove_header%& modifier acts immediately as it is encountered during the
29130 processing of an ACL. Notice the difference between these two cases:
29131 .display
29132 &`accept remove_header = X-Internal`&
29133 &`       `&<&'some condition'&>
29134
29135 &`accept `&<&'some condition'&>
29136 &`       remove_header = X-Internal`&
29137 .endd
29138 In the first case, the header line is always removed, whether or not the
29139 condition is true. In the second case, the header line is removed only if the
29140 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29141 same ACL statement. All those that are encountered before a condition fails
29142 are honoured.
29143
29144 &*Warning*&: This facility currently applies only to header lines that are
29145 present during ACL processing. It does NOT remove header lines that are added
29146 in a system filter or in a router or transport.
29147
29148
29149
29150
29151 .section "ACL conditions" "SECTaclconditions"
29152 .cindex "&ACL;" "conditions; list of"
29153 Some of the conditions listed in this section are available only when Exim is
29154 compiled with the content-scanning extension. They are included here briefly
29155 for completeness. More detailed descriptions can be found in the discussion on
29156 content scanning in chapter &<<CHAPexiscan>>&.
29157
29158 Not all conditions are relevant in all circumstances. For example, testing
29159 senders and recipients does not make sense in an ACL that is being run as the
29160 result of the arrival of an ETRN command, and checks on message headers can be
29161 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29162 can use the same condition (with different parameters) more than once in the
29163 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29164 The conditions are as follows:
29165
29166
29167 .vlist
29168 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29169 .cindex "&ACL;" "nested"
29170 .cindex "&ACL;" "indirect"
29171 .cindex "&ACL;" "arguments"
29172 .cindex "&%acl%& ACL condition"
29173 The possible values of the argument are the same as for the
29174 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29175 &"accept"& the condition is true; if it returns &"deny"& the condition is
29176 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29177 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29178 condition false. This means that further processing of the &%warn%& verb
29179 ceases, but processing of the ACL continues.
29180
29181 If the argument is a named ACL, up to nine space-separated optional values
29182 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29183 and $acl_narg is set to the count of values.
29184 Previous values of these variables are restored after the call returns.
29185 The name and values are expanded separately.
29186 Note that spaces in complex expansions which are used as arguments
29187 will act as argument separators.
29188
29189 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29190 the connection is dropped. If it returns &"discard"&, the verb must be
29191 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29192 conditions are tested.
29193
29194 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29195 loops. This condition allows you to use different ACLs in different
29196 circumstances. For example, different ACLs can be used to handle RCPT commands
29197 for different local users or different local domains.
29198
29199 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29200 .cindex "&%authenticated%& ACL condition"
29201 .cindex "authentication" "ACL checking"
29202 .cindex "&ACL;" "testing for authentication"
29203 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29204 the name of the authenticator is tested against the list. To test for
29205 authentication by any authenticator, you can set
29206 .code
29207 authenticated = *
29208 .endd
29209
29210 .vitem &*condition&~=&~*&<&'string'&>
29211 .cindex "&%condition%& ACL condition"
29212 .cindex "customizing" "ACL condition"
29213 .cindex "&ACL;" "customized test"
29214 .cindex "&ACL;" "testing, customized"
29215 This feature allows you to make up custom conditions. If the result of
29216 expanding the string is an empty string, the number zero, or one of the strings
29217 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29218 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29219 any other value, some error is assumed to have occurred, and the ACL returns
29220 &"defer"&. However, if the expansion is forced to fail, the condition is
29221 ignored. The effect is to treat it as true, whether it is positive or
29222 negative.
29223
29224 .vitem &*decode&~=&~*&<&'location'&>
29225 .cindex "&%decode%& ACL condition"
29226 This condition is available only when Exim is compiled with the
29227 content-scanning extension, and it is allowed only in the ACL defined by
29228 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29229 If all goes well, the condition is true. It is false only if there are
29230 problems such as a syntax error or a memory shortage. For more details, see
29231 chapter &<<CHAPexiscan>>&.
29232
29233 .vitem &*demime&~=&~*&<&'extension&~list'&>
29234 .cindex "&%demime%& ACL condition"
29235 This condition is available only when Exim is compiled with the
29236 content-scanning extension. Its use is described in section
29237 &<<SECTdemimecond>>&.
29238
29239 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29240 .cindex "&%dnslists%& ACL condition"
29241 .cindex "DNS list" "in ACL"
29242 .cindex "black list (DNS)"
29243 .cindex "&ACL;" "testing a DNS list"
29244 This condition checks for entries in DNS black lists. These are also known as
29245 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29246 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29247 different variants of this condition to describe briefly here. See sections
29248 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29249
29250 .vitem &*domains&~=&~*&<&'domain&~list'&>
29251 .cindex "&%domains%& ACL condition"
29252 .cindex "domain" "ACL checking"
29253 .cindex "&ACL;" "testing a recipient domain"
29254 .vindex "&$domain_data$&"
29255 This condition is relevant only after a RCPT command. It checks that the domain
29256 of the recipient address is in the domain list. If percent-hack processing is
29257 enabled, it is done before this test is done. If the check succeeds with a
29258 lookup, the result of the lookup is placed in &$domain_data$& until the next
29259 &%domains%& test.
29260
29261 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29262 use &%domains%& in a DATA ACL.
29263
29264
29265 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29266 .cindex "&%encrypted%& ACL condition"
29267 .cindex "encryption" "checking in an ACL"
29268 .cindex "&ACL;" "testing for encryption"
29269 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29270 name of the cipher suite in use is tested against the list. To test for
29271 encryption without testing for any specific cipher suite(s), set
29272 .code
29273 encrypted = *
29274 .endd
29275
29276
29277 .vitem &*hosts&~=&~*&<&'host&~list'&>
29278 .cindex "&%hosts%& ACL condition"
29279 .cindex "host" "ACL checking"
29280 .cindex "&ACL;" "testing the client host"
29281 This condition tests that the calling host matches the host list. If you have
29282 name lookups or wildcarded host names and IP addresses in the same host list,
29283 you should normally put the IP addresses first. For example, you could have:
29284 .code
29285 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29286 .endd
29287 The lookup in this example uses the host name for its key. This is implied by
29288 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29289 and it wouldn't matter which way round you had these two items.)
29290
29291 The reason for the problem with host names lies in the left-to-right way that
29292 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29293 but when it reaches an item that requires a host name, it fails if it cannot
29294 find a host name to compare with the pattern. If the above list is given in the
29295 opposite order, the &%accept%& statement fails for a host whose name cannot be
29296 found, even if its IP address is 10.9.8.7.
29297
29298 If you really do want to do the name check first, and still recognize the IP
29299 address even if the name lookup fails, you can rewrite the ACL like this:
29300 .code
29301 accept hosts = dbm;/etc/friendly/hosts
29302 accept hosts = 10.9.8.7
29303 .endd
29304 The default action on failing to find the host name is to assume that the host
29305 is not in the list, so the first &%accept%& statement fails. The second
29306 statement can then check the IP address.
29307
29308 .vindex "&$host_data$&"
29309 If a &%hosts%& condition is satisfied by means of a lookup, the result
29310 of the lookup is made available in the &$host_data$& variable. This
29311 allows you, for example, to set up a statement like this:
29312 .code
29313 deny  hosts = net-lsearch;/some/file
29314 message = $host_data
29315 .endd
29316 which gives a custom error message for each denied host.
29317
29318 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29319 .cindex "&%local_parts%& ACL condition"
29320 .cindex "local part" "ACL checking"
29321 .cindex "&ACL;" "testing a local part"
29322 .vindex "&$local_part_data$&"
29323 This condition is relevant only after a RCPT command. It checks that the local
29324 part of the recipient address is in the list. If percent-hack processing is
29325 enabled, it is done before this test. If the check succeeds with a lookup, the
29326 result of the lookup is placed in &$local_part_data$&, which remains set until
29327 the next &%local_parts%& test.
29328
29329 .vitem &*malware&~=&~*&<&'option'&>
29330 .cindex "&%malware%& ACL condition"
29331 .cindex "&ACL;" "virus scanning"
29332 .cindex "&ACL;" "scanning for viruses"
29333 This condition is available only when Exim is compiled with the
29334 content-scanning extension. It causes the incoming message to be scanned for
29335 viruses. For details, see chapter &<<CHAPexiscan>>&.
29336
29337 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29338 .cindex "&%mime_regex%& ACL condition"
29339 .cindex "&ACL;" "testing by regex matching"
29340 This condition is available only when Exim is compiled with the
29341 content-scanning extension, and it is allowed only in the ACL defined by
29342 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29343 with any of the regular expressions. For details, see chapter
29344 &<<CHAPexiscan>>&.
29345
29346 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29347 .cindex "rate limiting"
29348 This condition can be used to limit the rate at which a user or host submits
29349 messages. Details are given in section &<<SECTratelimiting>>&.
29350
29351 .vitem &*recipients&~=&~*&<&'address&~list'&>
29352 .cindex "&%recipients%& ACL condition"
29353 .cindex "recipient" "ACL checking"
29354 .cindex "&ACL;" "testing a recipient"
29355 This condition is relevant only after a RCPT command. It checks the entire
29356 recipient address against a list of recipients.
29357
29358 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29359 .cindex "&%regex%& ACL condition"
29360 .cindex "&ACL;" "testing by regex matching"
29361 This condition is available only when Exim is compiled with the
29362 content-scanning extension, and is available only in the DATA, MIME, and
29363 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29364 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29365
29366 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29367 .cindex "&%sender_domains%& ACL condition"
29368 .cindex "sender" "ACL checking"
29369 .cindex "&ACL;" "testing a sender domain"
29370 .vindex "&$domain$&"
29371 .vindex "&$sender_address_domain$&"
29372 This condition tests the domain of the sender of the message against the given
29373 domain list. &*Note*&: The domain of the sender address is in
29374 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29375 of this condition. This is an exception to the general rule for testing domain
29376 lists. It is done this way so that, if this condition is used in an ACL for a
29377 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29378 influence the sender checking.
29379
29380 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29381 relaying, because sender addresses are easily, and commonly, forged.
29382
29383 .vitem &*senders&~=&~*&<&'address&~list'&>
29384 .cindex "&%senders%& ACL condition"
29385 .cindex "sender" "ACL checking"
29386 .cindex "&ACL;" "testing a sender"
29387 This condition tests the sender of the message against the given list. To test
29388 for a bounce message, which has an empty sender, set
29389 .code
29390 senders = :
29391 .endd
29392 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29393 relaying, because sender addresses are easily, and commonly, forged.
29394
29395 .vitem &*spam&~=&~*&<&'username'&>
29396 .cindex "&%spam%& ACL condition"
29397 .cindex "&ACL;" "scanning for spam"
29398 This condition is available only when Exim is compiled with the
29399 content-scanning extension. It causes the incoming message to be scanned by
29400 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29401
29402 .vitem &*verify&~=&~certificate*&
29403 .cindex "&%verify%& ACL condition"
29404 .cindex "TLS" "client certificate verification"
29405 .cindex "certificate" "verification of client"
29406 .cindex "&ACL;" "certificate verification"
29407 .cindex "&ACL;" "testing a TLS certificate"
29408 This condition is true in an SMTP session if the session is encrypted, and a
29409 certificate was received from the client, and the certificate was verified. The
29410 server requests a certificate only if the client matches &%tls_verify_hosts%&
29411 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29412
29413 .vitem &*verify&~=&~csa*&
29414 .cindex "CSA verification"
29415 This condition checks whether the sending host (the client) is authorized to
29416 send email. Details of how this works are given in section
29417 &<<SECTverifyCSA>>&.
29418
29419 .vitem &*verify&~=&~header_names_ascii*&
29420 .cindex "&%verify%& ACL condition"
29421 .cindex "&ACL;" "verifying header names only ASCII"
29422 .cindex "header lines" "verifying header names only ASCII"
29423 .cindex "verifying" "header names only ASCII"
29424 This condition is relevant only in an ACL that is run after a message has been
29425 received, that is, in an ACL specified by &%acl_smtp_data%& or
29426 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29427 there are no non-ASCII characters, also excluding control characters.  The
29428 allowable characters are decimal ASCII values 33 through 126.
29429
29430 Exim itself will handle headers with non-ASCII characters, but it can cause
29431 problems for downstream applications, so this option will allow their
29432 detection and rejection in the DATA ACL's.
29433
29434 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29435 .cindex "&%verify%& ACL condition"
29436 .cindex "&ACL;" "verifying sender in the header"
29437 .cindex "header lines" "verifying the sender in"
29438 .cindex "sender" "verifying in header"
29439 .cindex "verifying" "sender in header"
29440 This condition is relevant only in an ACL that is run after a message has been
29441 received, that is, in an ACL specified by &%acl_smtp_data%& or
29442 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29443 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29444 is loosely thought of as a &"sender"& address (hence the name of the test).
29445 However, an address that appears in one of these headers need not be an address
29446 that accepts bounce messages; only sender addresses in envelopes are required
29447 to accept bounces. Therefore, if you use the callout option on this check, you
29448 might want to arrange for a non-empty address in the MAIL command.
29449
29450 Details of address verification and the options are given later, starting at
29451 section &<<SECTaddressverification>>& (callouts are described in section
29452 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29453 condition to restrict it to bounce messages only:
29454 .code
29455 deny    senders = :
29456         message = A valid sender header is required for bounces
29457        !verify  = header_sender
29458 .endd
29459
29460 .vitem &*verify&~=&~header_syntax*&
29461 .cindex "&%verify%& ACL condition"
29462 .cindex "&ACL;" "verifying header syntax"
29463 .cindex "header lines" "verifying syntax"
29464 .cindex "verifying" "header syntax"
29465 This condition is relevant only in an ACL that is run after a message has been
29466 received, that is, in an ACL specified by &%acl_smtp_data%& or
29467 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29468 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29469 and &'Bcc:'&), returning true if there are no problems.
29470 Unqualified addresses (local parts without domains) are
29471 permitted only in locally generated messages and from hosts that match
29472 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29473 appropriate.
29474
29475 Note that this condition is a syntax check only. However, a common spamming
29476 ploy used to be to send syntactically invalid headers such as
29477 .code
29478 To: @
29479 .endd
29480 and this condition can be used to reject such messages, though they are not as
29481 common as they used to be.
29482
29483 .vitem &*verify&~=&~helo*&
29484 .cindex "&%verify%& ACL condition"
29485 .cindex "&ACL;" "verifying HELO/EHLO"
29486 .cindex "HELO" "verifying"
29487 .cindex "EHLO" "verifying"
29488 .cindex "verifying" "EHLO"
29489 .cindex "verifying" "HELO"
29490 This condition is true if a HELO or EHLO command has been received from the
29491 client host, and its contents have been verified. If there has been no previous
29492 attempt to verify the HELO/EHLO contents, it is carried out when this
29493 condition is encountered. See the description of the &%helo_verify_hosts%& and
29494 &%helo_try_verify_hosts%& options for details of how to request verification
29495 independently of this condition.
29496
29497 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29498 option), this condition is always true.
29499
29500
29501 .vitem &*verify&~=&~not_blind*&
29502 .cindex "verifying" "not blind"
29503 .cindex "bcc recipients, verifying none"
29504 This condition checks that there are no blind (bcc) recipients in the message.
29505 Every envelope recipient must appear either in a &'To:'& header line or in a
29506 &'Cc:'& header line for this condition to be true. Local parts are checked
29507 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29508 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29509 used only in a DATA or non-SMTP ACL.
29510
29511 There are, of course, many legitimate messages that make use of blind (bcc)
29512 recipients. This check should not be used on its own for blocking messages.
29513
29514
29515 .vitem &*verify&~=&~recipient/*&<&'options'&>
29516 .cindex "&%verify%& ACL condition"
29517 .cindex "&ACL;" "verifying recipient"
29518 .cindex "recipient" "verifying"
29519 .cindex "verifying" "recipient"
29520 .vindex "&$address_data$&"
29521 This condition is relevant only after a RCPT command. It verifies the current
29522 recipient. Details of address verification are given later, starting at section
29523 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29524 of &$address_data$& is the last value that was set while routing the address.
29525 This applies even if the verification fails. When an address that is being
29526 verified is redirected to a single address, verification continues with the new
29527 address, and in that case, the subsequent value of &$address_data$& is the
29528 value for the child address.
29529
29530 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29531 .cindex "&%verify%& ACL condition"
29532 .cindex "&ACL;" "verifying host reverse lookup"
29533 .cindex "host" "verifying reverse lookup"
29534 This condition ensures that a verified host name has been looked up from the IP
29535 address of the client host. (This may have happened already if the host name
29536 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29537 Verification ensures that the host name obtained from a reverse DNS lookup, or
29538 one of its aliases, does, when it is itself looked up in the DNS, yield the
29539 original IP address.
29540
29541 There is one possible option, &`defer_ok`&.  If this is present and a
29542 DNS operation returns a temporary error, the verify condition succeeds.
29543
29544 If this condition is used for a locally generated message (that is, when there
29545 is no client host involved), it always succeeds.
29546
29547 .vitem &*verify&~=&~sender/*&<&'options'&>
29548 .cindex "&%verify%& ACL condition"
29549 .cindex "&ACL;" "verifying sender"
29550 .cindex "sender" "verifying"
29551 .cindex "verifying" "sender"
29552 This condition is relevant only after a MAIL or RCPT command, or after a
29553 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29554 the message's sender is empty (that is, this is a bounce message), the
29555 condition is true. Otherwise, the sender address is verified.
29556
29557 .vindex "&$address_data$&"
29558 .vindex "&$sender_address_data$&"
29559 If there is data in the &$address_data$& variable at the end of routing, its
29560 value is placed in &$sender_address_data$& at the end of verification. This
29561 value can be used in subsequent conditions and modifiers in the same ACL
29562 statement. It does not persist after the end of the current statement. If you
29563 want to preserve the value for longer, you can save it in an ACL variable.
29564
29565 Details of verification are given later, starting at section
29566 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29567 to avoid doing it more than once per message.
29568
29569 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29570 .cindex "&%verify%& ACL condition"
29571 This is a variation of the previous option, in which a modified address is
29572 verified as a sender.
29573 .endlist
29574
29575
29576
29577 .section "Using DNS lists" "SECTmorednslists"
29578 .cindex "DNS list" "in ACL"
29579 .cindex "black list (DNS)"
29580 .cindex "&ACL;" "testing a DNS list"
29581 In its simplest form, the &%dnslists%& condition tests whether the calling host
29582 is on at least one of a number of DNS lists by looking up the inverted IP
29583 address in one or more DNS domains. (Note that DNS list domains are not mail
29584 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29585 special options instead.) For example, if the calling host's IP
29586 address is 192.168.62.43, and the ACL statement is
29587 .code
29588 deny dnslists = blackholes.mail-abuse.org : \
29589                 dialups.mail-abuse.org
29590 .endd
29591 the following records are looked up:
29592 .code
29593 43.62.168.192.blackholes.mail-abuse.org
29594 43.62.168.192.dialups.mail-abuse.org
29595 .endd
29596 As soon as Exim finds an existing DNS record, processing of the list stops.
29597 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29598 to test that a host is on more than one list (an &"and"& conjunction), you can
29599 use two separate conditions:
29600 .code
29601 deny dnslists = blackholes.mail-abuse.org
29602      dnslists = dialups.mail-abuse.org
29603 .endd
29604 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29605 behaves as if the host does not match the list item, that is, as if the DNS
29606 record does not exist. If there are further items in the DNS list, they are
29607 processed.
29608
29609 This is usually the required action when &%dnslists%& is used with &%deny%&
29610 (which is the most common usage), because it prevents a DNS failure from
29611 blocking mail. However, you can change this behaviour by putting one of the
29612 following special items in the list:
29613 .display
29614 &`+include_unknown `&   behave as if the item is on the list
29615 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29616 &`+defer_unknown   `&   give a temporary error
29617 .endd
29618 .cindex "&`+include_unknown`&"
29619 .cindex "&`+exclude_unknown`&"
29620 .cindex "&`+defer_unknown`&"
29621 Each of these applies to any subsequent items on the list. For example:
29622 .code
29623 deny dnslists = +defer_unknown : foo.bar.example
29624 .endd
29625 Testing the list of domains stops as soon as a match is found. If you want to
29626 warn for one list and block for another, you can use two different statements:
29627 .code
29628 deny  dnslists = blackholes.mail-abuse.org
29629 warn  message  = X-Warn: sending host is on dialups list
29630       dnslists = dialups.mail-abuse.org
29631 .endd
29632 .cindex cacheing "of dns lookup"
29633 .cindex DNS TTL
29634 DNS list lookups are cached by Exim for the duration of the SMTP session
29635 .new
29636 (but limited by the DNS return TTL value),
29637 .wen
29638 so a lookup based on the IP address is done at most once for any incoming
29639 connection (assuming long-enough TTL).
29640 Exim does not share information between multiple incoming
29641 connections (but your local name server cache should be active).
29642
29643
29644
29645 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29646 .cindex "DNS list" "keyed by explicit IP address"
29647 By default, the IP address that is used in a DNS list lookup is the IP address
29648 of the calling host. However, you can specify another IP address by listing it
29649 after the domain name, introduced by a slash. For example:
29650 .code
29651 deny dnslists = black.list.tld/192.168.1.2
29652 .endd
29653 This feature is not very helpful with explicit IP addresses; it is intended for
29654 use with IP addresses that are looked up, for example, the IP addresses of the
29655 MX hosts or nameservers of an email sender address. For an example, see section
29656 &<<SECTmulkeyfor>>& below.
29657
29658
29659
29660
29661 .section "DNS lists keyed on domain names" "SECID202"
29662 .cindex "DNS list" "keyed by domain name"
29663 There are some lists that are keyed on domain names rather than inverted IP
29664 addresses (see for example the &'domain based zones'& link at
29665 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29666 with these lists. You can change the name that is looked up in a DNS list by
29667 listing it after the domain name, introduced by a slash. For example,
29668 .code
29669 deny  message  = Sender's domain is listed at $dnslist_domain
29670       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29671 .endd
29672 This particular example is useful only in ACLs that are obeyed after the
29673 RCPT or DATA commands, when a sender address is available. If (for
29674 example) the message's sender is &'user@tld.example'& the name that is looked
29675 up by this example is
29676 .code
29677 tld.example.dsn.rfc-ignorant.org
29678 .endd
29679 A single &%dnslists%& condition can contain entries for both names and IP
29680 addresses. For example:
29681 .code
29682 deny dnslists = sbl.spamhaus.org : \
29683                 dsn.rfc-ignorant.org/$sender_address_domain
29684 .endd
29685 The first item checks the sending host's IP address; the second checks a domain
29686 name. The whole condition is true if either of the DNS lookups succeeds.
29687
29688
29689
29690
29691 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29692 .cindex "DNS list" "multiple keys for"
29693 The syntax described above for looking up explicitly-defined values (either
29694 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29695 name for the DNS list, what follows the slash can in fact be a list of items.
29696 As with all lists in Exim, the default separator is a colon. However, because
29697 this is a sublist within the list of DNS blacklist domains, it is necessary
29698 either to double the separators like this:
29699 .code
29700 dnslists = black.list.tld/name.1::name.2
29701 .endd
29702 or to change the separator character, like this:
29703 .code
29704 dnslists = black.list.tld/<;name.1;name.2
29705 .endd
29706 If an item in the list is an IP address, it is inverted before the DNS
29707 blacklist domain is appended. If it is not an IP address, no inversion
29708 occurs. Consider this condition:
29709 .code
29710 dnslists = black.list.tld/<;192.168.1.2;a.domain
29711 .endd
29712 The DNS lookups that occur are:
29713 .code
29714 2.1.168.192.black.list.tld
29715 a.domain.black.list.tld
29716 .endd
29717 Once a DNS record has been found (that matches a specific IP return
29718 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29719 are done. If there is a temporary DNS error, the rest of the sublist of domains
29720 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29721 only if no other DNS lookup in this sublist succeeds. In other words, a
29722 successful lookup for any of the items in the sublist overrides a temporary
29723 error for a previous item.
29724
29725 The ability to supply a list of items after the slash is in some sense just a
29726 syntactic convenience. These two examples have the same effect:
29727 .code
29728 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29729 dnslists = black.list.tld/a.domain::b.domain
29730 .endd
29731 However, when the data for the list is obtained from a lookup, the second form
29732 is usually much more convenient. Consider this example:
29733 .code
29734 deny message  = The mail servers for the domain \
29735                 $sender_address_domain \
29736                 are listed at $dnslist_domain ($dnslist_value); \
29737                 see $dnslist_text.
29738      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29739                                    ${lookup dnsdb {>|mxh=\
29740                                    $sender_address_domain} }} }
29741 .endd
29742 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29743 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29744 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29745 of expanding the condition might be something like this:
29746 .code
29747 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29748 .endd
29749 Thus, this example checks whether or not the IP addresses of the sender
29750 domain's mail servers are on the Spamhaus black list.
29751
29752 The key that was used for a successful DNS list lookup is put into the variable
29753 &$dnslist_matched$& (see section &<<SECID204>>&).
29754
29755
29756
29757
29758 .section "Data returned by DNS lists" "SECID203"
29759 .cindex "DNS list" "data returned from"
29760 DNS lists are constructed using address records in the DNS. The original RBL
29761 just used the address 127.0.0.1 on the right hand side of each record, but the
29762 RBL+ list and some other lists use a number of values with different meanings.
29763 The values used on the RBL+ list are:
29764 .display
29765 127.1.0.1  RBL
29766 127.1.0.2  DUL
29767 127.1.0.3  DUL and RBL
29768 127.1.0.4  RSS
29769 127.1.0.5  RSS and RBL
29770 127.1.0.6  RSS and DUL
29771 127.1.0.7  RSS and DUL and RBL
29772 .endd
29773 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29774 different values. Some DNS lists may return more than one address record;
29775 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29776
29777
29778 .section "Variables set from DNS lists" "SECID204"
29779 .cindex "expansion" "variables, set from DNS list"
29780 .cindex "DNS list" "variables set from"
29781 .vindex "&$dnslist_domain$&"
29782 .vindex "&$dnslist_matched$&"
29783 .vindex "&$dnslist_text$&"
29784 .vindex "&$dnslist_value$&"
29785 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29786 the name of the overall domain that matched (for example,
29787 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29788 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29789 the DNS record. When the key is an IP address, it is not reversed in
29790 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29791 cases, for example:
29792 .code
29793 deny dnslists = spamhaus.example
29794 .endd
29795 the key is also available in another variable (in this case,
29796 &$sender_host_address$&). In more complicated cases, however, this is not true.
29797 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29798 might generate a dnslists lookup like this:
29799 .code
29800 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29801 .endd
29802 If this condition succeeds, the value in &$dnslist_matched$& might be
29803 &`192.168.6.7`& (for example).
29804
29805 If more than one address record is returned by the DNS lookup, all the IP
29806 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29807 The variable &$dnslist_text$& contains the contents of any associated TXT
29808 record. For lists such as RBL+ the TXT record for a merged entry is often not
29809 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29810 information.
29811
29812 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29813 &-- although these appear before the condition in the ACL, they are not
29814 expanded until after it has failed. For example:
29815 .code
29816 deny    hosts = !+local_networks
29817         message = $sender_host_address is listed \
29818                   at $dnslist_domain
29819         dnslists = rbl-plus.mail-abuse.example
29820 .endd
29821
29822
29823
29824 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29825 .cindex "DNS list" "matching specific returned data"
29826 You can add an equals sign and an IP address after a &%dnslists%& domain name
29827 in order to restrict its action to DNS records with a matching right hand side.
29828 For example,
29829 .code
29830 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29831 .endd
29832 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29833 any address record is considered to be a match. For the moment, we assume
29834 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29835 describes how multiple records are handled.
29836
29837 More than one IP address may be given for checking, using a comma as a
29838 separator. These are alternatives &-- if any one of them matches, the
29839 &%dnslists%& condition is true. For example:
29840 .code
29841 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29842 .endd
29843 If you want to specify a constraining address list and also specify names or IP
29844 addresses to be looked up, the constraining address list must be specified
29845 first. For example:
29846 .code
29847 deny dnslists = dsn.rfc-ignorant.org\
29848                 =127.0.0.2/$sender_address_domain
29849 .endd
29850
29851 If the character &`&&`& is used instead of &`=`&, the comparison for each
29852 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29853 In other words, the listed addresses are used as bit masks. The comparison is
29854 true if all the bits in the mask are present in the address that is being
29855 tested. For example:
29856 .code
29857 dnslists = a.b.c&0.0.0.3
29858 .endd
29859 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29860 want to test whether one bit or another bit is present (as opposed to both
29861 being present), you must use multiple values. For example:
29862 .code
29863 dnslists = a.b.c&0.0.0.1,0.0.0.2
29864 .endd
29865 matches if the final component of the address is an odd number or two times
29866 an odd number.
29867
29868
29869
29870 .section "Negated DNS matching conditions" "SECID205"
29871 You can supply a negative list of IP addresses as part of a &%dnslists%&
29872 condition. Whereas
29873 .code
29874 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29875 .endd
29876 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29877 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29878 .code
29879 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29880 .endd
29881 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29882 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29883 words, the result of the test is inverted if an exclamation mark appears before
29884 the &`=`& (or the &`&&`&) sign.
29885
29886 &*Note*&: This kind of negation is not the same as negation in a domain,
29887 host, or address list (which is why the syntax is different).
29888
29889 If you are using just one list, the negation syntax does not gain you much. The
29890 previous example is precisely equivalent to
29891 .code
29892 deny  dnslists = a.b.c
29893      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29894 .endd
29895 However, if you are using multiple lists, the negation syntax is clearer.
29896 Consider this example:
29897 .code
29898 deny  dnslists = sbl.spamhaus.org : \
29899                  list.dsbl.org : \
29900                  dnsbl.njabl.org!=127.0.0.3 : \
29901                  relays.ordb.org
29902 .endd
29903 Using only positive lists, this would have to be:
29904 .code
29905 deny  dnslists = sbl.spamhaus.org : \
29906                  list.dsbl.org
29907 deny  dnslists = dnsbl.njabl.org
29908      !dnslists = dnsbl.njabl.org=127.0.0.3
29909 deny  dnslists = relays.ordb.org
29910 .endd
29911 which is less clear, and harder to maintain.
29912
29913
29914
29915
29916 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29917 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29918 thereby providing more than one IP address. When an item in a &%dnslists%& list
29919 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29920 the match to specific results from the DNS lookup, there are two ways in which
29921 the checking can be handled. For example, consider the condition:
29922 .code
29923 dnslists = a.b.c=127.0.0.1
29924 .endd
29925 What happens if the DNS lookup for the incoming IP address yields both
29926 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29927 condition true because at least one given value was found, or is it false
29928 because at least one of the found values was not listed? And how does this
29929 affect negated conditions? Both possibilities are provided for with the help of
29930 additional separators &`==`& and &`=&&`&.
29931
29932 .ilist
29933 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29934 IP addresses matches one of the listed addresses. For the example above, the
29935 condition is true because 127.0.0.1 matches.
29936 .next
29937 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29938 looked up IP addresses matches one of the listed addresses. If the condition is
29939 changed to:
29940 .code
29941 dnslists = a.b.c==127.0.0.1
29942 .endd
29943 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29944 false because 127.0.0.2 is not listed. You would need to have:
29945 .code
29946 dnslists = a.b.c==127.0.0.1,127.0.0.2
29947 .endd
29948 for the condition to be true.
29949 .endlist
29950
29951 When &`!`& is used to negate IP address matching, it inverts the result, giving
29952 the precise opposite of the behaviour above. Thus:
29953 .ilist
29954 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29955 addresses matches one of the listed addresses. Consider:
29956 .code
29957 dnslists = a.b.c!&0.0.0.1
29958 .endd
29959 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29960 false because 127.0.0.1 matches.
29961 .next
29962 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29963 looked up IP address that does not match. Consider:
29964 .code
29965 dnslists = a.b.c!=&0.0.0.1
29966 .endd
29967 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29968 true, because 127.0.0.2 does not match. You would need to have:
29969 .code
29970 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29971 .endd
29972 for the condition to be false.
29973 .endlist
29974 When the DNS lookup yields only a single IP address, there is no difference
29975 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29976
29977
29978
29979
29980 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29981 .cindex "DNS list" "information from merged"
29982 When the facility for restricting the matching IP values in a DNS list is used,
29983 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29984 the true reason for rejection. This happens when lists are merged and the IP
29985 address in the A record is used to distinguish them; unfortunately there is
29986 only one TXT record. One way round this is not to use merged lists, but that
29987 can be inefficient because it requires multiple DNS lookups where one would do
29988 in the vast majority of cases when the host of interest is not on any of the
29989 lists.
29990
29991 A less inefficient way of solving this problem is available. If
29992 two domain names, comma-separated, are given, the second is used first to
29993 do an initial check, making use of any IP value restrictions that are set.
29994 If there is a match, the first domain is used, without any IP value
29995 restrictions, to get the TXT record. As a byproduct of this, there is also
29996 a check that the IP being tested is indeed on the first list. The first
29997 domain is the one that is put in &$dnslist_domain$&. For example:
29998 .code
29999 reject message  = \
30000          rejected because $sender_host_address is blacklisted \
30001          at $dnslist_domain\n$dnslist_text
30002        dnslists = \
30003          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30004          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30005 .endd
30006 For the first blacklist item, this starts by doing a lookup in
30007 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30008 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30009 value, and as long as something is found, it looks for the corresponding TXT
30010 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30011 The second blacklist item is processed similarly.
30012
30013 If you are interested in more than one merged list, the same list must be
30014 given several times, but because the results of the DNS lookups are cached,
30015 the DNS calls themselves are not repeated. For example:
30016 .code
30017 reject dnslists = \
30018          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30019          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30020          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30021          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30022 .endd
30023 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30024 values matches (or if no record is found), this is the only lookup that is
30025 done. Only if there is a match is one of the more specific lists consulted.
30026
30027
30028
30029 .section "DNS lists and IPv6" "SECTmorednslistslast"
30030 .cindex "IPv6" "DNS black lists"
30031 .cindex "DNS list" "IPv6 usage"
30032 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30033 nibble by nibble. For example, if the calling host's IP address is
30034 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30035 .code
30036 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30037   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30038 .endd
30039 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30040 lists contain wildcard records, intended for IPv4, that interact badly with
30041 IPv6. For example, the DNS entry
30042 .code
30043 *.3.some.list.example.    A    127.0.0.1
30044 .endd
30045 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30046 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30047
30048 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30049 &%condition%& condition, as in this example:
30050 .code
30051 deny   condition = ${if isip4{$sender_host_address}}
30052        dnslists  = some.list.example
30053 .endd
30054
30055 If an explicit key is being used for a DNS lookup and it may be an IPv6
30056 address you should specify alternate list separators for both the outer
30057 (DNS list name) list and inner (lookup keys) list:
30058 .code
30059        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30060 .endd
30061
30062 .section "Rate limiting incoming messages" "SECTratelimiting"
30063 .cindex "rate limiting" "client sending"
30064 .cindex "limiting client sending rates"
30065 .oindex "&%smtp_ratelimit_*%&"
30066 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30067 which clients can send email. This is more powerful than the
30068 &%smtp_ratelimit_*%& options, because those options control the rate of
30069 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30070 works across all connections (concurrent and sequential) from the same client
30071 host. The syntax of the &%ratelimit%& condition is:
30072 .display
30073 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30074 .endd
30075 If the average client sending rate is less than &'m'& messages per time
30076 period &'p'& then the condition is false; otherwise it is true.
30077
30078 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30079 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30080 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30081 of &'p'&.
30082
30083 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30084 time interval, for example, &`8h`& for eight hours. A larger time constant
30085 means that it takes Exim longer to forget a client's past behaviour. The
30086 parameter &'m'& is the maximum number of messages that a client is permitted to
30087 send in each time interval. It also specifies the number of messages permitted
30088 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30089 constant, you can allow a client to send more messages in a burst without
30090 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30091 both small, messages must be sent at an even rate.
30092
30093 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30094 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30095 when deploying the &%ratelimit%& ACL condition. The script prints usage
30096 instructions when it is run with no arguments.
30097
30098 The key is used to look up the data for calculating the client's average
30099 sending rate. This data is stored in Exim's spool directory, alongside the
30100 retry and other hints databases. The default key is &$sender_host_address$&,
30101 which means Exim computes the sending rate of each client host IP address.
30102 By changing the key you can change how Exim identifies clients for the purpose
30103 of ratelimiting. For example, to limit the sending rate of each authenticated
30104 user, independent of the computer they are sending from, set the key to
30105 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30106 example, &$authenticated_id$& is only meaningful if the client has
30107 authenticated (which you can check with the &%authenticated%& ACL condition).
30108
30109 The lookup key does not have to identify clients: If you want to limit the
30110 rate at which a recipient receives messages, you can use the key
30111 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30112 ACL.
30113
30114 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30115 specifies what Exim measures the rate of, for example messages or recipients
30116 or bytes. You can adjust the measurement using the &%unique=%& and/or
30117 &%count=%& options. You can also control when Exim updates the recorded rate
30118 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30119 separated by a slash, like the other parameters. They may appear in any order.
30120
30121 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30122 any options that alter the meaning of the stored data. The limit &'m'& is not
30123 stored, so you can alter the configured maximum rate and Exim will still
30124 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30125 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30126 behaviour. The lookup key is not affected by changes to the update mode and
30127 the &%count=%& option.
30128
30129
30130 .section "Ratelimit options for what is being measured" "ratoptmea"
30131 .cindex "rate limiting" "per_* options"
30132 The &%per_conn%& option limits the client's connection rate. It is not
30133 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30134 &%acl_not_smtp_start%& ACLs.
30135
30136 The &%per_mail%& option limits the client's rate of sending messages. This is
30137 the default if none of the &%per_*%& options is specified. It can be used in
30138 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30139 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30140
30141 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30142 the same ACLs as the &%per_mail%& option, though it is best to use this option
30143 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30144 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30145 in its MAIL command, which may be inaccurate or completely missing. You can
30146 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30147 in kilobytes, megabytes, or gigabytes, respectively.
30148
30149 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30150 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30151 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30152 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30153 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30154 in either case the rate limiting engine will see a message with many
30155 recipients as a large high-speed burst.
30156
30157 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30158 number of different recipients that the client has sent messages to in the
30159 last time period. That is, if the client repeatedly sends messages to the same
30160 recipient, its measured rate is not increased. This option can only be used in
30161 &%acl_smtp_rcpt%&.
30162
30163 The &%per_cmd%& option causes Exim to recompute the rate every time the
30164 condition is processed. This can be used to limit the rate of any SMTP
30165 command. If it is used in multiple ACLs it can limit the aggregate rate of
30166 multiple different commands.
30167
30168 The &%count=%& option can be used to alter how much Exim adds to the client's
30169 measured rate. For example, the &%per_byte%& option is equivalent to
30170 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30171 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30172 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30173
30174 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30175
30176
30177 .section "Ratelimit update modes" "ratoptupd"
30178 .cindex "rate limiting" "reading data without updating"
30179 You can specify one of three options with the &%ratelimit%& condition to
30180 control when its database is updated. This section describes the &%readonly%&
30181 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30182
30183 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30184 previously-computed rate to check against the limit.
30185
30186 For example, you can test the client's sending rate and deny it access (when
30187 it is too fast) in the connect ACL. If the client passes this check then it
30188 can go on to send a message, in which case its recorded rate will be updated
30189 in the MAIL ACL. Subsequent connections from the same client will check this
30190 new rate.
30191 .code
30192 acl_check_connect:
30193  deny ratelimit = 100 / 5m / readonly
30194     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30195                   (max $sender_rate_limit)
30196 # ...
30197 acl_check_mail:
30198  warn ratelimit = 100 / 5m / strict
30199     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30200                   (max $sender_rate_limit)
30201 .endd
30202
30203 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30204 processing a message then it may increase the client's measured rate more than
30205 it should. For example, this will happen if you check the &%per_rcpt%& option
30206 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30207 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30208 multiple update problems by using the &%readonly%& option on later ratelimit
30209 checks.
30210
30211 The &%per_*%& options described above do not make sense in some ACLs. If you
30212 use a &%per_*%& option in an ACL where it is not normally permitted then the
30213 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30214 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30215 next section) so you must specify the &%readonly%& option explicitly.
30216
30217
30218 .section "Ratelimit options for handling fast clients" "ratoptfast"
30219 .cindex "rate limiting" "strict and leaky modes"
30220 If a client's average rate is greater than the maximum, the rate limiting
30221 engine can react in two possible ways, depending on the presence of the
30222 &%strict%& or &%leaky%& update modes. This is independent of the other
30223 counter-measures (such as rejecting the message) that may be specified by the
30224 rest of the ACL.
30225
30226 The &%leaky%& (default) option means that the client's recorded rate is not
30227 updated if it is above the limit. The effect of this is that Exim measures the
30228 client's average rate of successfully sent email, which cannot be greater than
30229 the maximum allowed. If the client is over the limit it may suffer some
30230 counter-measures (as specified in the ACL), but it will still be able to send
30231 email at the configured maximum rate, whatever the rate of its attempts. This
30232 is generally the better choice if you have clients that retry automatically.
30233 For example, it does not prevent a sender with an over-aggressive retry rate
30234 from getting any email through.
30235
30236 The &%strict%& option means that the client's recorded rate is always
30237 updated. The effect of this is that Exim measures the client's average rate
30238 of attempts to send email, which can be much higher than the maximum it is
30239 actually allowed. If the client is over the limit it may be subjected to
30240 counter-measures by the ACL. It must slow down and allow sufficient time to
30241 pass that its computed rate falls below the maximum before it can send email
30242 again. The time (the number of smoothing periods) it must wait and not
30243 attempt to send mail can be calculated with this formula:
30244 .code
30245         ln(peakrate/maxrate)
30246 .endd
30247
30248
30249 .section "Limiting the rate of different events" "ratoptuniq"
30250 .cindex "rate limiting" "counting unique events"
30251 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30252 rate of different events. For example, the &%per_addr%& option uses this
30253 mechanism to count the number of different recipients that the client has
30254 sent messages to in the last time period; it is equivalent to
30255 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30256 measure the rate that a client uses different sender addresses with the
30257 options &`per_mail/unique=$sender_address`&.
30258
30259 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30260 has seen for that key. The whole set is thrown away when it is older than the
30261 rate smoothing period &'p'&, so each different event is counted at most once
30262 per period. In the &%leaky%& update mode, an event that causes the client to
30263 go over the limit is not added to the set, in the same way that the client's
30264 recorded rate is not updated in the same situation.
30265
30266 When you combine the &%unique=%& and &%readonly%& options, the specific
30267 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30268 rate.
30269
30270 The &%unique=%& mechanism needs more space in the ratelimit database than the
30271 other &%ratelimit%& options in order to store the event set. The number of
30272 unique values is potentially as large as the rate limit, so the extra space
30273 required increases with larger limits.
30274
30275 The uniqueification is not perfect: there is a small probability that Exim
30276 will think a new event has happened before. If the sender's rate is less than
30277 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30278 the measured rate can go above the limit, in which case Exim may under-count
30279 events by a significant margin. Fortunately, if the rate is high enough (2.7
30280 times the limit) that the false positive rate goes above 9%, then Exim will
30281 throw away the over-full event set before the measured rate falls below the
30282 limit. Therefore the only harm should be that exceptionally high sending rates
30283 are logged incorrectly; any countermeasures you configure will be as effective
30284 as intended.
30285
30286
30287 .section "Using rate limiting" "useratlim"
30288 Exim's other ACL facilities are used to define what counter-measures are taken
30289 when the rate limit is exceeded. This might be anything from logging a warning
30290 (for example, while measuring existing sending rates in order to define
30291 policy), through time delays to slow down fast senders, up to rejecting the
30292 message. For example:
30293 .code
30294 # Log all senders' rates
30295 warn ratelimit = 0 / 1h / strict
30296      log_message = Sender rate $sender_rate / $sender_rate_period
30297
30298 # Slow down fast senders; note the need to truncate $sender_rate
30299 # at the decimal point.
30300 warn ratelimit = 100 / 1h / per_rcpt / strict
30301      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30302                    $sender_rate_limit }s
30303
30304 # Keep authenticated users under control
30305 deny authenticated = *
30306      ratelimit = 100 / 1d / strict / $authenticated_id
30307
30308 # System-wide rate limit
30309 defer message = Sorry, too busy. Try again later.
30310      ratelimit = 10 / 1s / $primary_hostname
30311
30312 # Restrict incoming rate from each host, with a default
30313 # set using a macro and special cases looked up in a table.
30314 defer message = Sender rate exceeds $sender_rate_limit \
30315                messages per $sender_rate_period
30316      ratelimit = ${lookup {$sender_host_address} \
30317                    cdb {DB/ratelimits.cdb} \
30318                    {$value} {RATELIMIT} }
30319 .endd
30320 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30321 especially with the &%per_rcpt%& option, you may suffer from a performance
30322 bottleneck caused by locking on the ratelimit hints database. Apart from
30323 making your ACLs less complicated, you can reduce the problem by using a
30324 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30325 this means that Exim will lose its hints data after a reboot (including retry
30326 hints, the callout cache, and ratelimit data).
30327
30328
30329
30330 .section "Address verification" "SECTaddressverification"
30331 .cindex "verifying address" "options for"
30332 .cindex "policy control" "address verification"
30333 Several of the &%verify%& conditions described in section
30334 &<<SECTaclconditions>>& cause addresses to be verified. Section
30335 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30336 The verification conditions can be followed by options that modify the
30337 verification process. The options are separated from the keyword and from each
30338 other by slashes, and some of them contain parameters. For example:
30339 .code
30340 verify = sender/callout
30341 verify = recipient/defer_ok/callout=10s,defer_ok
30342 .endd
30343 The first stage of address verification, which always happens, is to run the
30344 address through the routers, in &"verify mode"&. Routers can detect the
30345 difference between verification and routing for delivery, and their actions can
30346 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30347 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30348 The available options are as follows:
30349
30350 .ilist
30351 If the &%callout%& option is specified, successful routing to one or more
30352 remote hosts is followed by a &"callout"& to those hosts as an additional
30353 check. Callouts and their sub-options are discussed in the next section.
30354 .next
30355 If there is a defer error while doing verification routing, the ACL
30356 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30357 options, the condition is forced to be true instead. Note that this is a main
30358 verification option as well as a suboption for callouts.
30359 .next
30360 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30361 discusses the reporting of sender address verification failures.
30362 .next
30363 The &%success_on_redirect%& option causes verification always to succeed
30364 immediately after a successful redirection. By default, if a redirection
30365 generates just one address, that address is also verified. See further
30366 discussion in section &<<SECTredirwhilveri>>&.
30367 .endlist
30368
30369 .cindex "verifying address" "differentiating failures"
30370 .vindex "&$recipient_verify_failure$&"
30371 .vindex "&$sender_verify_failure$&"
30372 .vindex "&$acl_verify_message$&"
30373 After an address verification failure, &$acl_verify_message$& contains the
30374 error message that is associated with the failure. It can be preserved by
30375 coding like this:
30376 .code
30377 warn  !verify = sender
30378        set acl_m0 = $acl_verify_message
30379 .endd
30380 If you are writing your own custom rejection message or log message when
30381 denying access, you can use this variable to include information about the
30382 verification failure.
30383
30384 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30385 appropriate) contains one of the following words:
30386
30387 .ilist
30388 &%qualify%&: The address was unqualified (no domain), and the message
30389 was neither local nor came from an exempted host.
30390 .next
30391 &%route%&: Routing failed.
30392 .next
30393 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30394 occurred at or before the MAIL command (that is, on initial
30395 connection, HELO, or MAIL).
30396 .next
30397 &%recipient%&: The RCPT command in a callout was rejected.
30398 .next
30399 &%postmaster%&: The postmaster check in a callout was rejected.
30400 .endlist
30401
30402 The main use of these variables is expected to be to distinguish between
30403 rejections of MAIL and rejections of RCPT in callouts.
30404
30405
30406
30407
30408 .section "Callout verification" "SECTcallver"
30409 .cindex "verifying address" "by callout"
30410 .cindex "callout" "verification"
30411 .cindex "SMTP" "callout verification"
30412 For non-local addresses, routing verifies the domain, but is unable to do any
30413 checking of the local part. There are situations where some means of verifying
30414 the local part is desirable. One way this can be done is to make an SMTP
30415 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30416 a subsequent host for a recipient address, to see if the host accepts the
30417 address. We use the term &'callout'& to cover both cases. Note that for a
30418 sender address, the callback is not to the client host that is trying to
30419 deliver the message, but to one of the hosts that accepts incoming mail for the
30420 sender's domain.
30421
30422 Exim does not do callouts by default. If you want them to happen, you must
30423 request them by setting appropriate options on the &%verify%& condition, as
30424 described below. This facility should be used with care, because it can add a
30425 lot of resource usage to the cost of verifying an address. However, Exim does
30426 cache the results of callouts, which helps to reduce the cost. Details of
30427 caching are in section &<<SECTcallvercache>>&.
30428
30429 Recipient callouts are usually used only between hosts that are controlled by
30430 the same administration. For example, a corporate gateway host could use
30431 callouts to check for valid recipients on an internal mailserver. A successful
30432 callout does not guarantee that a real delivery to the address would succeed;
30433 on the other hand, a failing callout does guarantee that a delivery would fail.
30434
30435 If the &%callout%& option is present on a condition that verifies an address, a
30436 second stage of verification occurs if the address is successfully routed to
30437 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30438 &(manualroute)& router, where the router specifies the hosts. However, if a
30439 router that does not set up hosts routes to an &(smtp)& transport with a
30440 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30441 &%hosts_override%& set, its hosts are always used, whether or not the router
30442 supplies a host list.
30443 Callouts are only supported on &(smtp)& transports.
30444
30445 The port that is used is taken from the transport, if it is specified and is a
30446 remote transport. (For routers that do verification only, no transport need be
30447 specified.) Otherwise, the default SMTP port is used. If a remote transport
30448 specifies an outgoing interface, this is used; otherwise the interface is not
30449 specified. Likewise, the text that is used for the HELO command is taken from
30450 the transport's &%helo_data%& option; if there is no transport, the value of
30451 &$smtp_active_hostname$& is used.
30452
30453 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30454 test whether a bounce message could be delivered to the sender address. The
30455 following SMTP commands are sent:
30456 .display
30457 &`HELO `&<&'local host name'&>
30458 &`MAIL FROM:<>`&
30459 &`RCPT TO:`&<&'the address to be tested'&>
30460 &`QUIT`&
30461 .endd
30462 LHLO is used instead of HELO if the transport's &%protocol%& option is
30463 set to &"lmtp"&.
30464
30465 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30466 settings.
30467
30468 A recipient callout check is similar. By default, it also uses an empty address
30469 for the sender. This default is chosen because most hosts do not make use of
30470 the sender address when verifying a recipient. Using the same address means
30471 that a single cache entry can be used for each recipient. Some sites, however,
30472 do make use of the sender address when verifying. These are catered for by the
30473 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30474
30475 If the response to the RCPT command is a 2&'xx'& code, the verification
30476 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30477 Exim tries the next host, if any. If there is a problem with all the remote
30478 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30479 &%callout%& option is given, in which case the condition is forced to succeed.
30480
30481 .cindex "SMTP" "output flushing, disabling for callout"
30482 A callout may take a little time. For this reason, Exim normally flushes SMTP
30483 output before performing a callout in an ACL, to avoid unexpected timeouts in
30484 clients when the SMTP PIPELINING extension is in use. The flushing can be
30485 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30486
30487
30488
30489
30490 .section "Additional parameters for callouts" "CALLaddparcall"
30491 .cindex "callout" "additional parameters for"
30492 The &%callout%& option can be followed by an equals sign and a number of
30493 optional parameters, separated by commas. For example:
30494 .code
30495 verify = recipient/callout=10s,defer_ok
30496 .endd
30497 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30498 separate verify options, is retained for backwards compatibility, but is now
30499 deprecated. The additional parameters for &%callout%& are as follows:
30500
30501
30502 .vlist
30503 .vitem <&'a&~time&~interval'&>
30504 .cindex "callout" "timeout, specifying"
30505 This specifies the timeout that applies for the callout attempt to each host.
30506 For example:
30507 .code
30508 verify = sender/callout=5s
30509 .endd
30510 The default is 30 seconds. The timeout is used for each response from the
30511 remote host. It is also used for the initial connection, unless overridden by
30512 the &%connect%& parameter.
30513
30514
30515 .vitem &*connect&~=&~*&<&'time&~interval'&>
30516 .cindex "callout" "connection timeout, specifying"
30517 This parameter makes it possible to set a different (usually smaller) timeout
30518 for making the SMTP connection. For example:
30519 .code
30520 verify = sender/callout=5s,connect=1s
30521 .endd
30522 If not specified, this timeout defaults to the general timeout value.
30523
30524 .vitem &*defer_ok*&
30525 .cindex "callout" "defer, action on"
30526 When this parameter is present, failure to contact any host, or any other kind
30527 of temporary error, is treated as success by the ACL. However, the cache is not
30528 updated in this circumstance.
30529
30530 .vitem &*fullpostmaster*&
30531 .cindex "callout" "full postmaster check"
30532 This operates like the &%postmaster%& option (see below), but if the check for
30533 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30534 accordance with the specification in RFC 2821. The RFC states that the
30535 unqualified address &'postmaster'& should be accepted.
30536
30537
30538 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30539 .cindex "callout" "sender when verifying header"
30540 When verifying addresses in header lines using the &%header_sender%&
30541 verification option, Exim behaves by default as if the addresses are envelope
30542 sender addresses from a message. Callout verification therefore tests to see
30543 whether a bounce message could be delivered, by using an empty address in the
30544 MAIL command. However, it is arguable that these addresses might never be used
30545 as envelope senders, and could therefore justifiably reject bounce messages
30546 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30547 address to use in the MAIL command. For example:
30548 .code
30549 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30550 .endd
30551 This parameter is available only for the &%header_sender%& verification option.
30552
30553
30554 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30555 .cindex "callout" "overall timeout, specifying"
30556 This parameter sets an overall timeout for performing a callout verification.
30557 For example:
30558 .code
30559 verify = sender/callout=5s,maxwait=30s
30560 .endd
30561 This timeout defaults to four times the callout timeout for individual SMTP
30562 commands. The overall timeout applies when there is more than one host that can
30563 be tried. The timeout is checked before trying the next host. This prevents
30564 very long delays if there are a large number of hosts and all are timing out
30565 (for example, when network connections are timing out).
30566
30567
30568 .vitem &*no_cache*&
30569 .cindex "callout" "cache, suppressing"
30570 .cindex "caching callout, suppressing"
30571 When this parameter is given, the callout cache is neither read nor updated.
30572
30573 .vitem &*postmaster*&
30574 .cindex "callout" "postmaster; checking"
30575 When this parameter is set, a successful callout check is followed by a similar
30576 check for the local part &'postmaster'& at the same domain. If this address is
30577 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30578 the postmaster check is recorded in a cache record; if it is a failure, this is
30579 used to fail subsequent callouts for the domain without a connection being
30580 made, until the cache record expires.
30581
30582 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30583 The postmaster check uses an empty sender in the MAIL command by default.
30584 You can use this parameter to do a postmaster check using a different address.
30585 For example:
30586 .code
30587 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30588 .endd
30589 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30590 one overrides. The &%postmaster%& parameter is equivalent to this example:
30591 .code
30592 require  verify = sender/callout=postmaster_mailfrom=
30593 .endd
30594 &*Warning*&: The caching arrangements for postmaster checking do not take
30595 account of the sender address. It is assumed that either the empty address or
30596 a fixed non-empty address will be used. All that Exim remembers is that the
30597 postmaster check for the domain succeeded or failed.
30598
30599
30600 .vitem &*random*&
30601 .cindex "callout" "&""random""& check"
30602 When this parameter is set, before doing the normal callout check, Exim does a
30603 check for a &"random"& local part at the same domain. The local part is not
30604 really random &-- it is defined by the expansion of the option
30605 &%callout_random_local_part%&, which defaults to
30606 .code
30607 $primary_hostname-$tod_epoch-testing
30608 .endd
30609 The idea here is to try to determine whether the remote host accepts all local
30610 parts without checking. If it does, there is no point in doing callouts for
30611 specific local parts. If the &"random"& check succeeds, the result is saved in
30612 a cache record, and used to force the current and subsequent callout checks to
30613 succeed without a connection being made, until the cache record expires.
30614
30615 .vitem &*use_postmaster*&
30616 .cindex "callout" "sender for recipient check"
30617 This parameter applies to recipient callouts only. For example:
30618 .code
30619 deny  !verify = recipient/callout=use_postmaster
30620 .endd
30621 .vindex "&$qualify_domain$&"
30622 It causes a non-empty postmaster address to be used in the MAIL command when
30623 performing the callout for the recipient, and also for a &"random"& check if
30624 that is configured. The local part of the address is &`postmaster`& and the
30625 domain is the contents of &$qualify_domain$&.
30626
30627 .vitem &*use_sender*&
30628 This option applies to recipient callouts only. For example:
30629 .code
30630 require  verify = recipient/callout=use_sender
30631 .endd
30632 It causes the message's actual sender address to be used in the MAIL
30633 command when performing the callout, instead of an empty address. There is no
30634 need to use this option unless you know that the called hosts make use of the
30635 sender when checking recipients. If used indiscriminately, it reduces the
30636 usefulness of callout caching.
30637 .endlist
30638
30639 If you use any of the parameters that set a non-empty sender for the MAIL
30640 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30641 &%use_sender%&), you should think about possible loops. Recipient checking is
30642 usually done between two hosts that are under the same management, and the host
30643 that receives the callouts is not normally configured to do callouts itself.
30644 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30645 these circumstances.
30646
30647 However, if you use a non-empty sender address for a callout to an arbitrary
30648 host, there is the likelihood that the remote host will itself initiate a
30649 callout check back to your host. As it is checking what appears to be a message
30650 sender, it is likely to use an empty address in MAIL, thus avoiding a
30651 callout loop. However, to be on the safe side it would be best to set up your
30652 own ACLs so that they do not do sender verification checks when the recipient
30653 is the address you use for header sender or postmaster callout checking.
30654
30655 Another issue to think about when using non-empty senders for callouts is
30656 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30657 by the sender/recipient combination; thus, for any given recipient, many more
30658 actual callouts are performed than when an empty sender or postmaster is used.
30659
30660
30661
30662
30663 .section "Callout caching" "SECTcallvercache"
30664 .cindex "hints database" "callout cache"
30665 .cindex "callout" "cache, description of"
30666 .cindex "caching" "callout"
30667 Exim caches the results of callouts in order to reduce the amount of resources
30668 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30669 option. A hints database called &"callout"& is used for the cache. Two
30670 different record types are used: one records the result of a callout check for
30671 a specific address, and the other records information that applies to the
30672 entire domain (for example, that it accepts the local part &'postmaster'&).
30673
30674 When an original callout fails, a detailed SMTP error message is given about
30675 the failure. However, for subsequent failures use the cache data, this message
30676 is not available.
30677
30678 The expiry times for negative and positive address cache records are
30679 independent, and can be set by the global options &%callout_negative_expire%&
30680 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30681
30682 If a host gives a negative response to an SMTP connection, or rejects any
30683 commands up to and including
30684 .code
30685 MAIL FROM:<>
30686 .endd
30687 (but not including the MAIL command with a non-empty address),
30688 any callout attempt is bound to fail. Exim remembers such failures in a
30689 domain cache record, which it uses to fail callouts for the domain without
30690 making new connections, until the domain record times out. There are two
30691 separate expiry times for domain cache records:
30692 &%callout_domain_negative_expire%& (default 3h) and
30693 &%callout_domain_positive_expire%& (default 7d).
30694
30695 Domain records expire when the negative expiry time is reached if callouts
30696 cannot be made for the domain, or if the postmaster check failed.
30697 Otherwise, they expire when the positive expiry time is reached. This
30698 ensures that, for example, a host that stops accepting &"random"& local parts
30699 will eventually be noticed.
30700
30701 The callout caching mechanism is based on the domain of the address that is
30702 being tested. If the domain routes to several hosts, it is assumed that their
30703 behaviour will be the same.
30704
30705
30706
30707 .section "Sender address verification reporting" "SECTsenaddver"
30708 .cindex "verifying" "suppressing error details"
30709 See section &<<SECTaddressverification>>& for a general discussion of
30710 verification. When sender verification fails in an ACL, the details of the
30711 failure are given as additional output lines before the 550 response to the
30712 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30713 you might see:
30714 .code
30715 MAIL FROM:<xyz@abc.example>
30716 250 OK
30717 RCPT TO:<pqr@def.example>
30718 550-Verification failed for <xyz@abc.example>
30719 550-Called:   192.168.34.43
30720 550-Sent:     RCPT TO:<xyz@abc.example>
30721 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30722 550 Sender verification failed
30723 .endd
30724 If more than one RCPT command fails in the same way, the details are given
30725 only for the first of them. However, some administrators do not want to send
30726 out this much information. You can suppress the details by adding
30727 &`/no_details`& to the ACL statement that requests sender verification. For
30728 example:
30729 .code
30730 verify = sender/no_details
30731 .endd
30732
30733 .section "Redirection while verifying" "SECTredirwhilveri"
30734 .cindex "verifying" "redirection while"
30735 .cindex "address redirection" "while verifying"
30736 A dilemma arises when a local address is redirected by aliasing or forwarding
30737 during verification: should the generated addresses themselves be verified,
30738 or should the successful expansion of the original address be enough to verify
30739 it? By default, Exim takes the following pragmatic approach:
30740
30741 .ilist
30742 When an incoming address is redirected to just one child address, verification
30743 continues with the child address, and if that fails to verify, the original
30744 verification also fails.
30745 .next
30746 When an incoming address is redirected to more than one child address,
30747 verification does not continue. A success result is returned.
30748 .endlist
30749
30750 This seems the most reasonable behaviour for the common use of aliasing as a
30751 way of redirecting different local parts to the same mailbox. It means, for
30752 example, that a pair of alias entries of the form
30753 .code
30754 A.Wol:   aw123
30755 aw123:   :fail: Gone away, no forwarding address
30756 .endd
30757 work as expected, with both local parts causing verification failure. When a
30758 redirection generates more than one address, the behaviour is more like a
30759 mailing list, where the existence of the alias itself is sufficient for
30760 verification to succeed.
30761
30762 It is possible, however, to change the default behaviour so that all successful
30763 redirections count as successful verifications, however many new addresses are
30764 generated. This is specified by the &%success_on_redirect%& verification
30765 option. For example:
30766 .code
30767 require verify = recipient/success_on_redirect/callout=10s
30768 .endd
30769 In this example, verification succeeds if a router generates a new address, and
30770 the callout does not occur, because no address was routed to a remote host.
30771
30772 When verification is being tested via the &%-bv%& option, the treatment of
30773 redirections is as just described, unless the &%-v%& or any debugging option is
30774 also specified. In that case, full verification is done for every generated
30775 address and a report is output for each of them.
30776
30777
30778
30779 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30780 .cindex "CSA" "verifying"
30781 Client SMTP Authorization is a system that allows a site to advertise
30782 which machines are and are not permitted to send email. This is done by placing
30783 special SRV records in the DNS; these are looked up using the client's HELO
30784 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30785 Authorization checks in Exim are performed by the ACL condition:
30786 .code
30787 verify = csa
30788 .endd
30789 This fails if the client is not authorized. If there is a DNS problem, or if no
30790 valid CSA SRV record is found, or if the client is authorized, the condition
30791 succeeds. These three cases can be distinguished using the expansion variable
30792 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30793 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30794 be likely to cause problems for legitimate email.
30795
30796 The error messages produced by the CSA code include slightly more
30797 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30798 looking up the CSA SRV record, or problems looking up the CSA target
30799 address record. There are four reasons for &$csa_status$& being &"fail"&:
30800
30801 .ilist
30802 The client's host name is explicitly not authorized.
30803 .next
30804 The client's IP address does not match any of the CSA target IP addresses.
30805 .next
30806 The client's host name is authorized but it has no valid target IP addresses
30807 (for example, the target's addresses are IPv6 and the client is using IPv4).
30808 .next
30809 The client's host name has no CSA SRV record but a parent domain has asserted
30810 that all subdomains must be explicitly authorized.
30811 .endlist
30812
30813 The &%csa%& verification condition can take an argument which is the domain to
30814 use for the DNS query. The default is:
30815 .code
30816 verify = csa/$sender_helo_name
30817 .endd
30818 This implementation includes an extension to CSA. If the query domain
30819 is an address literal such as [192.0.2.95], or if it is a bare IP
30820 address, Exim searches for CSA SRV records in the reverse DNS as if
30821 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30822 meaningful to say:
30823 .code
30824 verify = csa/$sender_host_address
30825 .endd
30826 In fact, this is the check that Exim performs if the client does not say HELO.
30827 This extension can be turned off by setting the main configuration option
30828 &%dns_csa_use_reverse%& to be false.
30829
30830 If a CSA SRV record is not found for the domain itself, a search
30831 is performed through its parent domains for a record which might be
30832 making assertions about subdomains. The maximum depth of this search is limited
30833 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30834 default. Exim does not look for CSA SRV records in a top level domain, so the
30835 default settings handle HELO domains as long as seven
30836 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30837 of legitimate HELO domains.
30838
30839 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30840 direct SRV lookups, this is not sufficient because of the extra parent domain
30841 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30842 addresses into lookups in the reverse DNS space. The result of a successful
30843 lookup such as:
30844 .code
30845 ${lookup dnsdb {csa=$sender_helo_name}}
30846 .endd
30847 has two space-separated fields: an authorization code and a target host name.
30848 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30849 authorization required but absent, or &"?"& for unknown.
30850
30851
30852
30853
30854 .section "Bounce address tag validation" "SECTverifyPRVS"
30855 .cindex "BATV, verifying"
30856 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30857 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30858 Genuine incoming bounce messages should therefore always be addressed to
30859 recipients that have a valid tag. This scheme is a way of detecting unwanted
30860 bounce messages caused by sender address forgeries (often called &"collateral
30861 spam"&), because the recipients of such messages do not include valid tags.
30862
30863 There are two expansion items to help with the implementation of the BATV
30864 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30865 the original envelope sender address by using a simple key to add a hash of the
30866 address and some time-based randomizing information. The &%prvs%& expansion
30867 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30868 The syntax of these expansion items is described in section
30869 &<<SECTexpansionitems>>&.
30870
30871 As an example, suppose the secret per-address keys are stored in an MySQL
30872 database. A query to look up the key for an address could be defined as a macro
30873 like this:
30874 .code
30875 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30876                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30877                 }{$value}}
30878 .endd
30879 Suppose also that the senders who make use of BATV are defined by an address
30880 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30881 use this:
30882 .code
30883 # Bounces: drop unsigned addresses for BATV senders
30884 deny message = This address does not send an unsigned reverse path
30885      senders = :
30886      recipients = +batv_senders
30887
30888 # Bounces: In case of prvs-signed address, check signature.
30889 deny message = Invalid reverse path signature.
30890      senders = :
30891      condition  = ${prvscheck {$local_part@$domain}\
30892                   {PRVSCHECK_SQL}{1}}
30893      !condition = $prvscheck_result
30894 .endd
30895 The first statement rejects recipients for bounce messages that are addressed
30896 to plain BATV sender addresses, because it is known that BATV senders do not
30897 send out messages with plain sender addresses. The second statement rejects
30898 recipients that are prvs-signed, but with invalid signatures (either because
30899 the key is wrong, or the signature has timed out).
30900
30901 A non-prvs-signed address is not rejected by the second statement, because the
30902 &%prvscheck%& expansion yields an empty string if its first argument is not a
30903 prvs-signed address, thus causing the &%condition%& condition to be false. If
30904 the first argument is a syntactically valid prvs-signed address, the yield is
30905 the third string (in this case &"1"&), whether or not the cryptographic and
30906 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30907 of the checks (empty for failure, &"1"& for success).
30908
30909 There is one more issue you must consider when implementing prvs-signing:
30910 you have to ensure that the routers accept prvs-signed addresses and
30911 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30912 router to remove the signature with a configuration along these lines:
30913 .code
30914 batv_redirect:
30915   driver = redirect
30916   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30917 .endd
30918 This works because, if the third argument of &%prvscheck%& is empty, the result
30919 of the expansion of a prvs-signed address is the decoded value of the original
30920 address. This router should probably be the first of your routers that handles
30921 local addresses.
30922
30923 To create BATV-signed addresses in the first place, a transport of this form
30924 can be used:
30925 .code
30926 external_smtp_batv:
30927   driver = smtp
30928   return_path = ${prvs {$return_path} \
30929                        {${lookup mysql{SELECT \
30930                        secret FROM batv_prvs WHERE \
30931                        sender='${quote_mysql:$sender_address}'} \
30932                        {$value}fail}}}
30933 .endd
30934 If no key can be found for the existing return path, no signing takes place.
30935
30936
30937
30938 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30939 .cindex "&ACL;" "relay control"
30940 .cindex "relaying" "control by ACL"
30941 .cindex "policy control" "relay control"
30942 An MTA is said to &'relay'& a message if it receives it from some host and
30943 delivers it directly to another host as a result of a remote address contained
30944 within it. Redirecting a local address via an alias or forward file and then
30945 passing the message on to another host is not relaying,
30946 .cindex "&""percent hack""&"
30947 but a redirection as a result of the &"percent hack"& is.
30948
30949 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30950 A host which is acting as a gateway or an MX backup is concerned with incoming
30951 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30952 a host which is acting as a smart host for a number of clients is concerned
30953 with outgoing relaying from those clients to the Internet at large. Often the
30954 same host is fulfilling both functions,
30955 . ///
30956 . as illustrated in the diagram below,
30957 . ///
30958 but in principle these two kinds of relaying are entirely independent. What is
30959 not wanted is the transmission of mail from arbitrary remote hosts through your
30960 system to arbitrary domains.
30961
30962
30963 You can implement relay control by means of suitable statements in the ACL that
30964 runs for each RCPT command. For convenience, it is often easiest to use
30965 Exim's named list facility to define the domains and hosts involved. For
30966 example, suppose you want to do the following:
30967
30968 .ilist
30969 Deliver a number of domains to mailboxes on the local host (or process them
30970 locally in some other way). Let's say these are &'my.dom1.example'& and
30971 &'my.dom2.example'&.
30972 .next
30973 Relay mail for a number of other domains for which you are the secondary MX.
30974 These might be &'friend1.example'& and &'friend2.example'&.
30975 .next
30976 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30977 Suppose your LAN is 192.168.45.0/24.
30978 .endlist
30979
30980
30981 In the main part of the configuration, you put the following definitions:
30982 .code
30983 domainlist local_domains    = my.dom1.example : my.dom2.example
30984 domainlist relay_to_domains = friend1.example : friend2.example
30985 hostlist   relay_from_hosts = 192.168.45.0/24
30986 .endd
30987 Now you can use these definitions in the ACL that is run for every RCPT
30988 command:
30989 .code
30990 acl_check_rcpt:
30991   accept domains = +local_domains : +relay_to_domains
30992   accept hosts   = +relay_from_hosts
30993 .endd
30994 The first statement accepts any RCPT command that contains an address in
30995 the local or relay domains. For any other domain, control passes to the second
30996 statement, which accepts the command only if it comes from one of the relay
30997 hosts. In practice, you will probably want to make your ACL more sophisticated
30998 than this, for example, by including sender and recipient verification. The
30999 default configuration includes a more comprehensive example, which is described
31000 in chapter &<<CHAPdefconfil>>&.
31001
31002
31003
31004 .section "Checking a relay configuration" "SECTcheralcon"
31005 .cindex "relaying" "checking control of"
31006 You can check the relay characteristics of your configuration in the same way
31007 that you can test any ACL behaviour for an incoming SMTP connection, by using
31008 the &%-bh%& option to run a fake SMTP session with which you interact.
31009 .ecindex IIDacl
31010
31011
31012
31013 . ////////////////////////////////////////////////////////////////////////////
31014 . ////////////////////////////////////////////////////////////////////////////
31015
31016 .chapter "Content scanning at ACL time" "CHAPexiscan"
31017 .scindex IIDcosca "content scanning" "at ACL time"
31018 The extension of Exim to include content scanning at ACL time, formerly known
31019 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31020 was integrated into the main source for Exim release 4.50, and Tom continues to
31021 maintain it. Most of the wording of this chapter is taken from Tom's
31022 specification.
31023
31024 It is also possible to scan the content of messages at other times. The
31025 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31026 scanning after all the ACLs have run. A transport filter can be used to scan
31027 messages at delivery time (see the &%transport_filter%& option, described in
31028 chapter &<<CHAPtransportgeneric>>&).
31029
31030 If you want to include the ACL-time content-scanning features when you compile
31031 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31032 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31033
31034 .ilist
31035 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31036 for all MIME parts for SMTP and non-SMTP messages, respectively.
31037 .next
31038 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31039 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31040 run at the end of message reception (the &%acl_smtp_data%& ACL).
31041 .next
31042 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31043 of messages, or parts of messages, for debugging purposes.
31044 .next
31045 Additional expansion variables that are set in the new ACL and by the new
31046 conditions.
31047 .next
31048 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31049 .endlist
31050
31051 There is another content-scanning configuration option for &_Local/Makefile_&,
31052 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
31053 condition is compiled, in addition to all the other content-scanning features.
31054
31055 Content-scanning is continually evolving, and new features are still being
31056 added. While such features are still unstable and liable to incompatible
31057 changes, they are made available in Exim by setting options whose names begin
31058 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31059 this manual. You can find out about them by reading the file called
31060 &_doc/experimental.txt_&.
31061
31062 All the content-scanning facilities work on a MBOX copy of the message that is
31063 temporarily created in a file called:
31064 .display
31065 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31066 .endd
31067 The &_.eml_& extension is a friendly hint to virus scanners that they can
31068 expect an MBOX-like structure inside that file. The file is created when the
31069 first content scanning facility is called. Subsequent calls to content
31070 scanning conditions open the same file again. The directory is recursively
31071 removed when the &%acl_smtp_data%& ACL has finished running, unless
31072 .code
31073 control = no_mbox_unspool
31074 .endd
31075 has been encountered. When the MIME ACL decodes files, they are put into the
31076 same directory by default.
31077
31078
31079
31080 .section "Scanning for viruses" "SECTscanvirus"
31081 .cindex "virus scanning"
31082 .cindex "content scanning" "for viruses"
31083 .cindex "content scanning" "the &%malware%& condition"
31084 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31085 It supports a &"generic"& interface to scanners called via the shell, and
31086 specialized interfaces for &"daemon"& type virus scanners, which are resident
31087 in memory and thus are much faster.
31088
31089 A timeout of 2 minutes is applied to a scanner call (by default);
31090 if it expires then a defer action is taken.
31091
31092 .oindex "&%av_scanner%&"
31093 You can set the &%av_scanner%& option in the main part of the configuration
31094 to specify which scanner to use, together with any additional options that
31095 are needed. The basic syntax is as follows:
31096 .display
31097 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31098 .endd
31099 If you do not set &%av_scanner%&, it defaults to
31100 .code
31101 av_scanner = sophie:/var/run/sophie
31102 .endd
31103 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31104 before use.
31105 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31106 The following scanner types are supported in this release:
31107
31108 .vlist
31109 .vitem &%avast%&
31110 .cindex "virus scanners" "avast"
31111 This is the scanner daemon of Avast. It has been tested with Avast Core
31112 Security (currently at version 1.1.7).
31113 You can get a trial version at &url(http://www.avast.com) or for Linux
31114 at &url(http://www.avast.com/linux-server-antivirus).
31115 This scanner type takes one option,
31116 which can be either a full path to a UNIX socket,
31117 or host and port specifiers separated by white space.
31118 The host may be a name or an IP address; the port is either a
31119 single number or a pair of numbers with a dash between.
31120 Any further options are given, on separate lines,
31121 to the daemon as options before the main scan command.
31122 For example:
31123 .code
31124 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31125 av_scanner = avast:192.168.2.22 5036
31126 .endd
31127 If you omit the argument, the default path
31128 &_/var/run/avast/scan.sock_&
31129 is used.
31130 If you use a remote host,
31131 you need to make Exim's spool directory available to it,
31132 as the scanner is passed a file path, not file contents.
31133 For information about available commands and their options you may use
31134 .code
31135 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31136     FLAGS
31137     SENSITIVITY
31138     PACK
31139 .endd
31140
31141
31142 .vitem &%aveserver%&
31143 .cindex "virus scanners" "Kaspersky"
31144 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31145 at &url(http://www.kaspersky.com). This scanner type takes one option,
31146 which is the path to the daemon's UNIX socket. The default is shown in this
31147 example:
31148 .code
31149 av_scanner = aveserver:/var/run/aveserver
31150 .endd
31151
31152
31153 .vitem &%clamd%&
31154 .cindex "virus scanners" "clamd"
31155 This daemon-type scanner is GPL and free. You can get it at
31156 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31157 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31158 in the MIME ACL. This is no longer believed to be necessary.
31159
31160 The options are a list of server specifiers, which may be
31161 a UNIX socket specification,
31162 a TCP socket specification,
31163 or a (global) option.
31164
31165 A socket specification consists of a space-separated list.
31166 For a Unix socket the first element is a full path for the socket,
31167 for a TCP socket the first element is the IP address
31168 and the second a port number,
31169 Any further elements are per-server (non-global) options.
31170 These per-server options are supported:
31171 .code
31172 retry=<timespec>        Retry on connect fail
31173 .endd
31174
31175 The &`retry`& option specifies a time after which a single retry for
31176 a failed connect is made.  The default is to not retry.
31177
31178 If a Unix socket file is specified, only one server is supported.
31179
31180 Examples:
31181 .code
31182 av_scanner = clamd:/opt/clamd/socket
31183 av_scanner = clamd:192.0.2.3 1234
31184 av_scanner = clamd:192.0.2.3 1234:local
31185 av_scanner = clamd:192.0.2.3 1234 retry=10s
31186 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31187 .endd
31188 If the value of av_scanner points to a UNIX socket file or contains the
31189 &`local`&
31190 option, then the ClamAV interface will pass a filename containing the data
31191 to be scanned, which will should normally result in less I/O happening and be
31192 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31193 Exim does not assume that there is a common filesystem with the remote host.
31194 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31195 you be running a version of ClamAV prior to 0.95.
31196
31197 The final example shows that multiple TCP targets can be specified.  Exim will
31198 randomly use one for each incoming email (i.e. it load balances them).  Note
31199 that only TCP targets may be used if specifying a list of scanners; a UNIX
31200 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31201 unavailable, Exim will try the remaining one(s) until it finds one that works.
31202 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31203 not keep track of scanner state between multiple messages, and the scanner
31204 selection is random, so the message will get logged in the mainlog for each
31205 email that the down scanner gets chosen first (message wrapped to be readable):
31206 .code
31207 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31208    clamd: connection to localhost, port 3310 failed
31209    (Connection refused)
31210 .endd
31211
31212 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31213 contributing the code for this scanner.
31214
31215 .vitem &%cmdline%&
31216 .cindex "virus scanners" "command line interface"
31217 This is the keyword for the generic command line scanner interface. It can be
31218 used to attach virus scanners that are invoked from the shell. This scanner
31219 type takes 3 mandatory options:
31220
31221 .olist
31222 The full path and name of the scanner binary, with all command line options,
31223 and a placeholder (&`%s`&) for the directory to scan.
31224
31225 .next
31226 A regular expression to match against the STDOUT and STDERR output of the
31227 virus scanner. If the expression matches, a virus was found. You must make
31228 absolutely sure that this expression matches on &"virus found"&. This is called
31229 the &"trigger"& expression.
31230
31231 .next
31232 Another regular expression, containing exactly one pair of parentheses, to
31233 match the name of the virus found in the scanners output. This is called the
31234 &"name"& expression.
31235 .endlist olist
31236
31237 For example, Sophos Sweep reports a virus on a line like this:
31238 .code
31239 Virus 'W32/Magistr-B' found in file ./those.bat
31240 .endd
31241 For the trigger expression, we can match the phrase &"found in file"&. For the
31242 name expression, we want to extract the W32/Magistr-B string, so we can match
31243 for the single quotes left and right of it. Altogether, this makes the
31244 configuration setting:
31245 .code
31246 av_scanner = cmdline:\
31247              /path/to/sweep -ss -all -rec -archive %s:\
31248              found in file:'(.+)'
31249 .endd
31250 .vitem &%drweb%&
31251 .cindex "virus scanners" "DrWeb"
31252 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31253 takes one option,
31254 either a full path to a UNIX socket,
31255 or host and port specifiers separated by white space.
31256 The host may be a name or an IP address; the port is either a
31257 single number or a pair of numbers with a dash between.
31258 For example:
31259 .code
31260 av_scanner = drweb:/var/run/drwebd.sock
31261 av_scanner = drweb:192.168.2.20 31337
31262 .endd
31263 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31264 is used. Thanks to Alex Miller for contributing the code for this scanner.
31265
31266 .vitem &%f-protd%&
31267 .cindex "virus scanners" "f-protd"
31268 The f-protd scanner is accessed via HTTP over TCP.
31269 One argument is taken, being a space-separated hostname and port number
31270 (or port-range).
31271 For example:
31272 .code
31273 av_scanner = f-protd:localhost 10200-10204
31274 .endd
31275 If you omit the argument, the default values show above are used.
31276
31277 .vitem &%fsecure%&
31278 .cindex "virus scanners" "F-Secure"
31279 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31280 argument which is the path to a UNIX socket. For example:
31281 .code
31282 av_scanner = fsecure:/path/to/.fsav
31283 .endd
31284 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31285 Thelmen for contributing the code for this scanner.
31286
31287 .vitem &%kavdaemon%&
31288 .cindex "virus scanners" "Kaspersky"
31289 This is the scanner daemon of Kaspersky Version 4. This version of the
31290 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31291 scanner type takes one option, which is the path to the daemon's UNIX socket.
31292 For example:
31293 .code
31294 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31295 .endd
31296 The default path is &_/var/run/AvpCtl_&.
31297
31298 .vitem &%mksd%&
31299 .cindex "virus scanners" "mksd"
31300 This is a daemon type scanner that is aimed mainly at Polish users, though some
31301 parts of documentation are now available in English. You can get it at
31302 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31303 the maximum number of processes used simultaneously to scan the attachments,
31304 provided that the demime facility is employed and also provided that mksd has
31305 been run with at least the same number of child processes. For example:
31306 .code
31307 av_scanner = mksd:2
31308 .endd
31309 You can safely omit this option (the default value is 1).
31310
31311 .vitem &%sock%&
31312 .cindex "virus scanners" "simple socket-connected"
31313 This is a general-purpose way of talking to simple scanner daemons
31314 running on the local machine.
31315 There are four options:
31316 an address (which may be an IP address and port, or the path of a Unix socket),
31317 a commandline to send (may include a single %s which will be replaced with
31318 the path to the mail file to be scanned),
31319 an RE to trigger on from the returned data,
31320 an RE to extract malware_name from the returned data.
31321 For example:
31322 .code
31323 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31324 .endd
31325 Default for the socket specifier is &_/tmp/malware.sock_&.
31326 Default for the commandline is &_%s\n_&.
31327 Both regular-expressions are required.
31328
31329 .vitem &%sophie%&
31330 .cindex "virus scanners" "Sophos and Sophie"
31331 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31332 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31333 for this scanner type is the path to the UNIX socket that Sophie uses for
31334 client communication. For example:
31335 .code
31336 av_scanner = sophie:/tmp/sophie
31337 .endd
31338 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31339 the option.
31340 .endlist
31341
31342 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31343 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31344 ACL.
31345
31346 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31347 makes it possible to use different scanners. See further below for an example.
31348 The &%malware%& condition caches its results, so when you use it multiple times
31349 for the same message, the actual scanning process is only carried out once.
31350 However, using expandable items in &%av_scanner%& disables this caching, in
31351 which case each use of the &%malware%& condition causes a new scan of the
31352 message.
31353
31354 The &%malware%& condition takes a right-hand argument that is expanded before
31355 use and taken as a list, slash-separated by default.
31356 The first element can then be one of
31357
31358 .ilist
31359 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31360 The condition succeeds if a virus was found, and fail otherwise. This is the
31361 recommended usage.
31362 .next
31363 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31364 the condition fails immediately.
31365 .next
31366 A regular expression, in which case the message is scanned for viruses. The
31367 condition succeeds if a virus is found and its name matches the regular
31368 expression. This allows you to take special actions on certain types of virus.
31369 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31370 unless the separator is changed (in the usual way).
31371 .endlist
31372
31373 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31374 messages even if there is a problem with the virus scanner.
31375 Otherwise, such a problem causes the ACL to defer.
31376
31377 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31378 specify a non-default timeout.  The default is two minutes.
31379 For example:
31380 .code
31381 malware = * / defer_ok / tmo=10s
31382 .endd
31383 A timeout causes the ACL to defer.
31384
31385 .vindex "&$callout_address$&"
31386 When a connection is made to the scanner the expansion variable &$callout_address$&
31387 is set to record the actual address used.
31388
31389 .vindex "&$malware_name$&"
31390 When a virus is found, the condition sets up an expansion variable called
31391 &$malware_name$& that contains the name of the virus. You can use it in a
31392 &%message%& modifier that specifies the error returned to the sender, and/or in
31393 logging data.
31394
31395 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
31396 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
31397 &%malware%& condition.
31398
31399 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31400 imposed by your anti-virus scanner.
31401
31402 Here is a very simple scanning example:
31403 .code
31404 deny message = This message contains malware ($malware_name)
31405      demime = *
31406      malware = *
31407 .endd
31408 The next example accepts messages when there is a problem with the scanner:
31409 .code
31410 deny message = This message contains malware ($malware_name)
31411      demime = *
31412      malware = */defer_ok
31413 .endd
31414 The next example shows how to use an ACL variable to scan with both sophie and
31415 aveserver. It assumes you have set:
31416 .code
31417 av_scanner = $acl_m0
31418 .endd
31419 in the main Exim configuration.
31420 .code
31421 deny message = This message contains malware ($malware_name)
31422      set acl_m0 = sophie
31423      malware = *
31424
31425 deny message = This message contains malware ($malware_name)
31426      set acl_m0 = aveserver
31427      malware = *
31428 .endd
31429
31430
31431 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31432 .cindex "content scanning" "for spam"
31433 .cindex "spam scanning"
31434 .cindex "SpamAssassin"
31435 .cindex "Rspamd"
31436 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31437 score and a report for the message.
31438 Support is also provided for Rspamd.
31439
31440 For more information about installation and configuration of SpamAssassin or
31441 Rspamd refer to their respective websites at
31442 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31443
31444 SpamAssassin can be installed with CPAN by running:
31445 .code
31446 perl -MCPAN -e 'install Mail::SpamAssassin'
31447 .endd
31448 SpamAssassin has its own set of configuration files. Please review its
31449 documentation to see how you can tweak it. The default installation should work
31450 nicely, however.
31451
31452 .oindex "&%spamd_address%&"
31453 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31454 intend to use an instance running on the local host you do not need to set
31455 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31456 you must set the &%spamd_address%& option in the global part of the Exim
31457 configuration as follows (example):
31458 .code
31459 spamd_address = 192.168.99.45 387
31460 .endd
31461
31462 To use Rspamd (which by default listens on all local addresses
31463 on TCP port 11333)
31464 you should add &%variant=rspamd%& after the address/port pair, for example:
31465 .code
31466 spamd_address = 127.0.0.1 11333 variant=rspamd
31467 .endd
31468
31469 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31470 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31471 file name instead of an address/port pair:
31472 .code
31473 spamd_address = /var/run/spamd_socket
31474 .endd
31475 You can have multiple &%spamd%& servers to improve scalability. These can
31476 reside on other hardware reachable over the network. To specify multiple
31477 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31478 option, separated with colons (the separator can be changed in the usual way):
31479 .code
31480 spamd_address = 192.168.2.10 783 : \
31481                 192.168.2.11 783 : \
31482                 192.168.2.12 783
31483 .endd
31484 Up to 32 &%spamd%& servers are supported.
31485 When a server fails to respond to the connection attempt, all other
31486 servers are tried until one succeeds. If no server responds, the &%spam%&
31487 condition defers.
31488
31489 Unix and TCP socket specifications may be mixed in any order.
31490 Each element of the list is a list itself, space-separated by default
31491 and changeable in the usual way.
31492
31493 For TCP socket specifications a host name or IP (v4 or v6, but
31494 subject to list-separator quoting rules) address can be used,
31495 and the port can be one or a dash-separated pair.
31496 In the latter case, the range is tried in strict order.
31497
31498 Elements after the first for Unix sockets, or second for TCP socket,
31499 are options.
31500 The supported options are:
31501 .code
31502 pri=<priority>      Selection priority
31503 weight=<value>      Selection bias
31504 time=<start>-<end>  Use only between these times of day
31505 retry=<timespec>    Retry on connect fail
31506 tmo=<timespec>      Connection time limit
31507 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31508 .endd
31509
31510 The &`pri`& option specifies a priority for the server within the list,
31511 higher values being tried first.
31512 The default priority is 1.
31513
31514 The &`weight`& option specifies a selection bias.
31515 Within a priority set
31516 servers are queried in a random fashion, weighted by this value.
31517 The default value for selection bias is 1.
31518
31519 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31520 in the local time zone; each element being one or more digits.
31521 Either the seconds or both minutes and seconds, plus the leading &`.`&
31522 characters, may be omitted and will be taken as zero.
31523
31524 Timeout specifications for the &`retry`& and &`tmo`& options
31525 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31526
31527 The &`tmo`& option specifies an overall timeout for communication.
31528 The default value is two minutes.
31529
31530 The &`retry`& option specifies a time after which a single retry for
31531 a failed connect is made.
31532 The default is to not retry.
31533
31534 The &%spamd_address%& variable is expanded before use if it starts with
31535 a dollar sign. In this case, the expansion may return a string that is
31536 used as the list so that multiple spamd servers can be the result of an
31537 expansion.
31538
31539 .vindex "&$callout_address$&"
31540 When a connection is made to the server the expansion variable &$callout_address$&
31541 is set to record the actual address used.
31542
31543 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31544 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31545 .code
31546 deny message = This message was classified as SPAM
31547      spam = joe
31548 .endd
31549 The right-hand side of the &%spam%& condition specifies a name. This is
31550 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31551 to scan using a specific profile, but rather use the SpamAssassin system-wide
31552 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31553 Rspamd does not use this setting. However, you must put something on the
31554 right-hand side.
31555
31556 The name allows you to use per-domain or per-user antispam profiles in
31557 principle, but this is not straightforward in practice, because a message may
31558 have multiple recipients, not necessarily all in the same domain. Because the
31559 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31560 read the contents of the message, the variables &$local_part$& and &$domain$&
31561 are not set.
31562 Careful enforcement of single-recipient messages
31563 (e.g. by responding with defer in the recipient ACL for all recipients
31564 after the first),
31565 or the use of PRDR,
31566 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31567 are needed to use this feature.
31568
31569 The right-hand side of the &%spam%& condition is expanded before being used, so
31570 you can put lookups or conditions there. When the right-hand side evaluates to
31571 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31572
31573
31574 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31575 large ones may cause significant performance degradation. As most spam messages
31576 are quite small, it is recommended that you do not scan the big ones. For
31577 example:
31578 .code
31579 deny message = This message was classified as SPAM
31580      condition = ${if < {$message_size}{10K}}
31581      spam = nobody
31582 .endd
31583
31584 The &%spam%& condition returns true if the threshold specified in the user's
31585 SpamAssassin profile has been matched or exceeded. If you want to use the
31586 &%spam%& condition for its side effects (see the variables below), you can make
31587 it always return &"true"& by appending &`:true`& to the username.
31588
31589 .cindex "spam scanning" "returned variables"
31590 When the &%spam%& condition is run, it sets up a number of expansion
31591 variables.
31592 Except for &$spam_report$&,
31593 these variables are saved with the received message so are
31594 available for use at delivery time.
31595
31596 .vlist
31597 .vitem &$spam_score$&
31598 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31599 for inclusion in log or reject messages.
31600
31601 .vitem &$spam_score_int$&
31602 The spam score of the message, multiplied by ten, as an integer value. For
31603 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31604 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31605 The integer value is useful for numeric comparisons in conditions.
31606
31607 .vitem &$spam_bar$&
31608 A string consisting of a number of &"+"& or &"-"& characters, representing the
31609 integer part of the spam score value. A spam score of 4.4 would have a
31610 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31611 headers, since MUAs can match on such strings. The maximum length of the
31612 spam bar is 50 characters.
31613
31614 .vitem &$spam_report$&
31615 A multiline text table, containing the full SpamAssassin report for the
31616 message. Useful for inclusion in headers or reject messages.
31617 This variable is only usable in a DATA-time ACL.
31618
31619 .vitem &$spam_action$&
31620 For SpamAssassin either 'reject' or 'no action' depending on the
31621 spam score versus threshold.
31622 For Rspamd, the recommended action.
31623
31624 .endlist
31625
31626 The &%spam%& condition caches its results unless expansion in
31627 spamd_address was used. If you call it again with the same user name, it
31628 does not scan again, but rather returns the same values as before.
31629
31630 The &%spam%& condition returns DEFER if there is any error while running
31631 the message through SpamAssassin or if the expansion of spamd_address
31632 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31633 statement block), append &`/defer_ok`& to the right-hand side of the
31634 spam condition, like this:
31635 .code
31636 deny message = This message was classified as SPAM
31637      spam    = joe/defer_ok
31638 .endd
31639 This causes messages to be accepted even if there is a problem with &%spamd%&.
31640
31641 Here is a longer, commented example of the use of the &%spam%&
31642 condition:
31643 .code
31644 # put headers in all messages (no matter if spam or not)
31645 warn  spam = nobody:true
31646       add_header = X-Spam-Score: $spam_score ($spam_bar)
31647       add_header = X-Spam-Report: $spam_report
31648
31649 # add second subject line with *SPAM* marker when message
31650 # is over threshold
31651 warn  spam = nobody
31652       add_header = Subject: *SPAM* $h_Subject:
31653
31654 # reject spam at high scores (> 12)
31655 deny  message = This message scored $spam_score spam points.
31656       spam = nobody:true
31657       condition = ${if >{$spam_score_int}{120}{1}{0}}
31658 .endd
31659
31660
31661
31662 .section "Scanning MIME parts" "SECTscanmimepart"
31663 .cindex "content scanning" "MIME parts"
31664 .cindex "MIME content scanning"
31665 .oindex "&%acl_smtp_mime%&"
31666 .oindex "&%acl_not_smtp_mime%&"
31667 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31668 each MIME part of an SMTP message, including multipart types, in the sequence
31669 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31670 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31671 options may both refer to the same ACL if you want the same processing in both
31672 cases.
31673
31674 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31675 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31676 the case of a non-SMTP message. However, a MIME ACL is called only if the
31677 message contains a &'Content-Type:'& header line. When a call to a MIME
31678 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31679 result code is sent to the client. In the case of an SMTP message, the
31680 &%acl_smtp_data%& ACL is not called when this happens.
31681
31682 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31683 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31684 condition to match against the raw MIME part. You can also use the
31685 &%mime_regex%& condition to match against the decoded MIME part (see section
31686 &<<SECTscanregex>>&).
31687
31688 At the start of a MIME ACL, a number of variables are set from the header
31689 information for the relevant MIME part. These are described below. The contents
31690 of the MIME part are not by default decoded into a disk file except for MIME
31691 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31692 part into a disk file, you can use the &%decode%& condition. The general
31693 syntax is:
31694 .display
31695 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31696 .endd
31697 The right hand side is expanded before use. After expansion,
31698 the value can be:
31699
31700 .olist
31701 &"0"& or &"false"&, in which case no decoding is done.
31702 .next
31703 The string &"default"&. In that case, the file is put in the temporary
31704 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31705 a sequential file name consisting of the message id and a sequence number. The
31706 full path and name is available in &$mime_decoded_filename$& after decoding.
31707 .next
31708 A full path name starting with a slash. If the full name is an existing
31709 directory, it is used as a replacement for the default directory. The filename
31710 is then sequentially assigned. If the path does not exist, it is used as
31711 the full path and file name.
31712 .next
31713 If the string does not start with a slash, it is used as the
31714 filename, and the default path is then used.
31715 .endlist
31716 The &%decode%& condition normally succeeds. It is only false for syntax
31717 errors or unusual circumstances such as memory shortages. You can easily decode
31718 a file with its original, proposed filename using
31719 .code
31720 decode = $mime_filename
31721 .endd
31722 However, you should keep in mind that &$mime_filename$& might contain
31723 anything. If you place files outside of the default path, they are not
31724 automatically unlinked.
31725
31726 For RFC822 attachments (these are messages attached to messages, with a
31727 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31728 as for the primary message, only that the &$mime_is_rfc822$& expansion
31729 variable is set (see below). Attached messages are always decoded to disk
31730 before being checked, and the files are unlinked once the check is done.
31731
31732 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31733 used to match regular expressions against raw and decoded MIME parts,
31734 respectively. They are described in section &<<SECTscanregex>>&.
31735
31736 .cindex "MIME content scanning" "returned variables"
31737 The following list describes all expansion variables that are
31738 available in the MIME ACL:
31739
31740 .vlist
31741 .vitem &$mime_boundary$&
31742 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31743 have a boundary string, which is stored in this variable. If the current part
31744 has no boundary parameter in the &'Content-Type:'& header, this variable
31745 contains the empty string.
31746
31747 .vitem &$mime_charset$&
31748 This variable contains the character set identifier, if one was found in the
31749 &'Content-Type:'& header. Examples for charset identifiers are:
31750 .code
31751 us-ascii
31752 gb2312 (Chinese)
31753 iso-8859-1
31754 .endd
31755 Please note that this value is not normalized, so you should do matches
31756 case-insensitively.
31757
31758 .vitem &$mime_content_description$&
31759 This variable contains the normalized content of the &'Content-Description:'&
31760 header. It can contain a human-readable description of the parts content. Some
31761 implementations repeat the filename for attachments here, but they are usually
31762 only used for display purposes.
31763
31764 .vitem &$mime_content_disposition$&
31765 This variable contains the normalized content of the &'Content-Disposition:'&
31766 header. You can expect strings like &"attachment"& or &"inline"& here.
31767
31768 .vitem &$mime_content_id$&
31769 This variable contains the normalized content of the &'Content-ID:'& header.
31770 This is a unique ID that can be used to reference a part from another part.
31771
31772 .vitem &$mime_content_size$&
31773 This variable is set only after the &%decode%& modifier (see above) has been
31774 successfully run. It contains the size of the decoded part in kilobytes. The
31775 size is always rounded up to full kilobytes, so only a completely empty part
31776 has a &$mime_content_size$& of zero.
31777
31778 .vitem &$mime_content_transfer_encoding$&
31779 This variable contains the normalized content of the
31780 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31781 type. Typical values are &"base64"& and &"quoted-printable"&.
31782
31783 .vitem &$mime_content_type$&
31784 If the MIME part has a &'Content-Type:'& header, this variable contains its
31785 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31786 are some examples of popular MIME types, as they may appear in this variable:
31787 .code
31788 text/plain
31789 text/html
31790 application/octet-stream
31791 image/jpeg
31792 audio/midi
31793 .endd
31794 If the MIME part has no &'Content-Type:'& header, this variable contains the
31795 empty string.
31796
31797 .vitem &$mime_decoded_filename$&
31798 This variable is set only after the &%decode%& modifier (see above) has been
31799 successfully run. It contains the full path and file name of the file
31800 containing the decoded data.
31801 .endlist
31802
31803 .cindex "RFC 2047"
31804 .vlist
31805 .vitem &$mime_filename$&
31806 This is perhaps the most important of the MIME variables. It contains a
31807 proposed filename for an attachment, if one was found in either the
31808 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31809 RFC2047
31810 or RFC2231
31811 decoded, but no additional sanity checks are done.
31812  If no filename was
31813 found, this variable contains the empty string.
31814
31815 .vitem &$mime_is_coverletter$&
31816 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31817 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31818 content in the cover letter, while not restricting attachments at all.
31819
31820 The variable contains 1 (true) for a MIME part believed to be part of the
31821 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31822 follows:
31823
31824 .olist
31825 The outermost MIME part of a message is always a cover letter.
31826
31827 .next
31828 If a multipart/alternative or multipart/related MIME part is a cover letter,
31829 so are all MIME subparts within that multipart.
31830
31831 .next
31832 If any other multipart is a cover letter, the first subpart is a cover letter,
31833 and the rest are attachments.
31834
31835 .next
31836 All parts contained within an attachment multipart are attachments.
31837 .endlist olist
31838
31839 As an example, the following will ban &"HTML mail"& (including that sent with
31840 alternative plain text), while allowing HTML files to be attached. HTML
31841 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31842 .code
31843 deny message = HTML mail is not accepted here
31844 !condition = $mime_is_rfc822
31845 condition = $mime_is_coverletter
31846 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31847 .endd
31848 .vitem &$mime_is_multipart$&
31849 This variable has the value 1 (true) when the current part has the main type
31850 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31851 Since multipart entities only serve as containers for other parts, you may not
31852 want to carry out specific actions on them.
31853
31854 .vitem &$mime_is_rfc822$&
31855 This variable has the value 1 (true) if the current part is not a part of the
31856 checked message itself, but part of an attached message. Attached message
31857 decoding is fully recursive.
31858
31859 .vitem &$mime_part_count$&
31860 This variable is a counter that is raised for each processed MIME part. It
31861 starts at zero for the very first part (which is usually a multipart). The
31862 counter is per-message, so it is reset when processing RFC822 attachments (see
31863 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31864 complete, so you can use it in the DATA ACL to determine the number of MIME
31865 parts of a message. For non-MIME messages, this variable contains the value -1.
31866 .endlist
31867
31868
31869
31870 .section "Scanning with regular expressions" "SECTscanregex"
31871 .cindex "content scanning" "with regular expressions"
31872 .cindex "regular expressions" "content scanning with"
31873 You can specify your own custom regular expression matches on the full body of
31874 the message, or on individual MIME parts.
31875
31876 The &%regex%& condition takes one or more regular expressions as arguments and
31877 matches them against the full message (when called in the DATA ACL) or a raw
31878 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31879 linewise, with a maximum line length of 32K characters. That means you cannot
31880 have multiline matches with the &%regex%& condition.
31881
31882 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31883 to 32K of decoded content (the whole content at once, not linewise). If the
31884 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31885 is decoded automatically when &%mime_regex%& is executed (using default path
31886 and filename values). If the decoded data is larger than  32K, only the first
31887 32K characters are checked.
31888
31889 The regular expressions are passed as a colon-separated list. To include a
31890 literal colon, you must double it. Since the whole right-hand side string is
31891 expanded before being used, you must also escape dollar signs and backslashes
31892 with more backslashes, or use the &`\N`& facility to disable expansion.
31893 Here is a simple example that contains two regular expressions:
31894 .code
31895 deny message = contains blacklisted regex ($regex_match_string)
31896      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31897 .endd
31898 The conditions returns true if any one of the regular expressions matches. The
31899 &$regex_match_string$& expansion variable is then set up and contains the
31900 matching regular expression.
31901 The expansion variables &$regex1$& &$regex2$& etc
31902 are set to any substrings captured by the regular expression.
31903
31904 &*Warning*&: With large messages, these conditions can be fairly
31905 CPU-intensive.
31906
31907
31908
31909
31910 .section "The demime condition" "SECTdemimecond"
31911 .cindex "content scanning" "MIME checking"
31912 .cindex "MIME content scanning"
31913 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31914 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31915 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31916 ACL functionality, but provides no additional facilities. Please note that this
31917 condition is deprecated and kept only for backward compatibility. You must set
31918 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31919 use the &%demime%& condition.
31920
31921 The &%demime%& condition unpacks MIME containers in the message. It detects
31922 errors in MIME containers and can match file extensions found in the message
31923 against a list. Using this facility produces files containing the unpacked MIME
31924 parts of the message in the temporary scan directory. If you do antivirus
31925 scanning, it is recommended that you use the &%demime%& condition before the
31926 antivirus (&%malware%&) condition.
31927
31928 On the right-hand side of the &%demime%& condition you can pass a
31929 colon-separated list of file extensions that it should match against. For
31930 example:
31931 .code
31932 deny message = Found blacklisted file attachment
31933      demime  = vbs:com:bat:pif:prf:lnk
31934 .endd
31935 If one of the file extensions is found, the condition is true, otherwise it is
31936 false. If there is a temporary error while demimeing (for example, &"disk
31937 full"&), the condition defers, and the message is temporarily rejected (unless
31938 the condition is on a &%warn%& verb).
31939
31940 The right-hand side is expanded before being treated as a list, so you can have
31941 conditions and lookups there. If it expands to an empty string, &"false"&, or
31942 zero (&"0"&), no demimeing is done and the condition is false.
31943
31944 The &%demime%& condition set the following variables:
31945
31946 .vlist
31947 .vitem &$demime_errorlevel$&
31948 .vindex "&$demime_errorlevel$&"
31949 When an error is detected in a MIME container, this variable contains the
31950 severity of the error, as an integer number. The higher the value, the more
31951 severe the error (the current maximum value is 3). If this variable is unset or
31952 zero, no error occurred.
31953
31954 .vitem &$demime_reason$&
31955 .vindex "&$demime_reason$&"
31956 When &$demime_errorlevel$& is greater than zero, this variable contains a
31957 human-readable text string describing the MIME error that occurred.
31958 .endlist
31959
31960 .vlist
31961 .vitem &$found_extension$&
31962 .vindex "&$found_extension$&"
31963 When the &%demime%& condition is true, this variable contains the file
31964 extension it found.
31965 .endlist
31966
31967 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31968 the &%demime%& condition, and are not changed on subsequent calls.
31969
31970 If you do not want to check for file extensions, but rather use the &%demime%&
31971 condition for unpacking or error checking purposes, pass &"*"& as the
31972 right-hand side value. Here is a more elaborate example of how to use this
31973 facility:
31974 .code
31975 # Reject messages with serious MIME container errors
31976 deny  message = Found MIME error ($demime_reason).
31977       demime = *
31978       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31979
31980 # Reject known virus spreading file extensions.
31981 # Accepting these is pretty much braindead.
31982 deny  message = contains $found_extension file (blacklisted).
31983       demime  = com:vbs:bat:pif:scr
31984
31985 # Freeze .exe and .doc files. Postmaster can
31986 # examine them and eventually thaw them.
31987 deny  log_message = Another $found_extension file.
31988       demime = exe:doc
31989       control = freeze
31990 .endd
31991 .ecindex IIDcosca
31992
31993
31994
31995
31996 . ////////////////////////////////////////////////////////////////////////////
31997 . ////////////////////////////////////////////////////////////////////////////
31998
31999 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32000          "Local scan function"
32001 .scindex IIDlosca "&[local_scan()]& function" "description of"
32002 .cindex "customizing" "input scan using C function"
32003 .cindex "policy control" "by local scan function"
32004 In these days of email worms, viruses, and ever-increasing spam, some sites
32005 want to apply a lot of checking to messages before accepting them.
32006
32007 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32008 passing messages to external virus and spam scanning software. You can also do
32009 a certain amount in Exim itself through string expansions and the &%condition%&
32010 condition in the ACL that runs after the SMTP DATA command or the ACL for
32011 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32012
32013 To allow for further customization to a site's own requirements, there is the
32014 possibility of linking Exim with a private message scanning function, written
32015 in C. If you want to run code that is written in something other than C, you
32016 can of course use a little C stub to call it.
32017
32018 The local scan function is run once for every incoming message, at the point
32019 when Exim is just about to accept the message.
32020 It can therefore be used to control non-SMTP messages from local processes as
32021 well as messages arriving via SMTP.
32022
32023 Exim applies a timeout to calls of the local scan function, and there is an
32024 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32025 Zero means &"no timeout"&.
32026 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32027 before calling the local scan function, so that the most common types of crash
32028 are caught. If the timeout is exceeded or one of those signals is caught, the
32029 incoming message is rejected with a temporary error if it is an SMTP message.
32030 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32031 code. The incident is logged on the main and reject logs.
32032
32033
32034
32035 .section "Building Exim to use a local scan function" "SECID207"
32036 .cindex "&[local_scan()]& function" "building Exim to use"
32037 To make use of the local scan function feature, you must tell Exim where your
32038 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32039 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32040 directory, so you might set
32041 .code
32042 LOCAL_SCAN_SOURCE=Local/local_scan.c
32043 .endd
32044 for example. The function must be called &[local_scan()]&. It is called by
32045 Exim after it has received a message, when the success return code is about to
32046 be sent. This is after all the ACLs have been run. The return code from your
32047 function controls whether the message is actually accepted or not. There is a
32048 commented template function (that just accepts the message) in the file
32049 _src/local_scan.c_.
32050
32051 If you want to make use of Exim's run time configuration file to set options
32052 for your &[local_scan()]& function, you must also set
32053 .code
32054 LOCAL_SCAN_HAS_OPTIONS=yes
32055 .endd
32056 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32057
32058
32059
32060
32061 .section "API for local_scan()" "SECTapiforloc"
32062 .cindex "&[local_scan()]& function" "API description"
32063 You must include this line near the start of your code:
32064 .code
32065 #include "local_scan.h"
32066 .endd
32067 This header file defines a number of variables and other values, and the
32068 prototype for the function itself. Exim is coded to use unsigned char values
32069 almost exclusively, and one of the things this header defines is a shorthand
32070 for &`unsigned char`& called &`uschar`&.
32071 It also contains the following macro definitions, to simplify casting character
32072 strings and pointers to character strings:
32073 .code
32074 #define CS   (char *)
32075 #define CCS  (const char *)
32076 #define CSS  (char **)
32077 #define US   (unsigned char *)
32078 #define CUS  (const unsigned char *)
32079 #define USS  (unsigned char **)
32080 .endd
32081 The function prototype for &[local_scan()]& is:
32082 .code
32083 extern int local_scan(int fd, uschar **return_text);
32084 .endd
32085 The arguments are as follows:
32086
32087 .ilist
32088 &%fd%& is a file descriptor for the file that contains the body of the message
32089 (the -D file). The file is open for reading and writing, but updating it is not
32090 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32091
32092 The descriptor is positioned at character 19 of the file, which is the first
32093 character of the body itself, because the first 19 characters are the message
32094 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32095 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32096 case this changes in some future version.
32097 .next
32098 &%return_text%& is an address which you can use to return a pointer to a text
32099 string at the end of the function. The value it points to on entry is NULL.
32100 .endlist
32101
32102 The function must return an &%int%& value which is one of the following macros:
32103
32104 .vlist
32105 .vitem &`LOCAL_SCAN_ACCEPT`&
32106 .vindex "&$local_scan_data$&"
32107 The message is accepted. If you pass back a string of text, it is saved with
32108 the message, and made available in the variable &$local_scan_data$&. No
32109 newlines are permitted (if there are any, they are turned into spaces) and the
32110 maximum length of text is 1000 characters.
32111
32112 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32113 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32114 queued without immediate delivery, and is frozen.
32115
32116 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32117 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32118 queued without immediate delivery.
32119
32120 .vitem &`LOCAL_SCAN_REJECT`&
32121 The message is rejected; the returned text is used as an error message which is
32122 passed back to the sender and which is also logged. Newlines are permitted &--
32123 they cause a multiline response for SMTP rejections, but are converted to
32124 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32125 used.
32126
32127 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32128 The message is temporarily rejected; the returned text is used as an error
32129 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32130 problem"& is used.
32131
32132 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32133 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32134 message is not written to the reject log. It has the effect of unsetting the
32135 &%rejected_header%& log selector for just this rejection. If
32136 &%rejected_header%& is already unset (see the discussion of the
32137 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32138 same as LOCAL_SCAN_REJECT.
32139
32140 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32141 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32142 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32143 .endlist
32144
32145 If the message is not being received by interactive SMTP, rejections are
32146 reported by writing to &%stderr%& or by sending an email, as configured by the
32147 &%-oe%& command line options.
32148
32149
32150
32151 .section "Configuration options for local_scan()" "SECTconoptloc"
32152 .cindex "&[local_scan()]& function" "configuration options"
32153 It is possible to have option settings in the main configuration file
32154 that set values in static variables in the &[local_scan()]& module. If you
32155 want to do this, you must have the line
32156 .code
32157 LOCAL_SCAN_HAS_OPTIONS=yes
32158 .endd
32159 in your &_Local/Makefile_& when you build Exim. (This line is in
32160 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32161 file, you must define static variables to hold the option values, and a table
32162 to define them.
32163
32164 The table must be a vector called &%local_scan_options%&, of type
32165 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32166 and a pointer to the variable that holds the value. The entries must appear in
32167 alphabetical order. Following &%local_scan_options%& you must also define a
32168 variable called &%local_scan_options_count%& that contains the number of
32169 entries in the table. Here is a short example, showing two kinds of option:
32170 .code
32171 static int my_integer_option = 42;
32172 static uschar *my_string_option = US"a default string";
32173
32174 optionlist local_scan_options[] = {
32175   { "my_integer", opt_int,       &my_integer_option },
32176   { "my_string",  opt_stringptr, &my_string_option }
32177 };
32178
32179 int local_scan_options_count =
32180   sizeof(local_scan_options)/sizeof(optionlist);
32181 .endd
32182 The values of the variables can now be changed from Exim's runtime
32183 configuration file by including a local scan section as in this example:
32184 .code
32185 begin local_scan
32186 my_integer = 99
32187 my_string = some string of text...
32188 .endd
32189 The available types of option data are as follows:
32190
32191 .vlist
32192 .vitem &*opt_bool*&
32193 This specifies a boolean (true/false) option. The address should point to a
32194 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32195 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32196 whether such a variable has been set at all, you can initialize it to
32197 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32198 values.)
32199
32200 .vitem &*opt_fixed*&
32201 This specifies a fixed point number, such as is used for load averages.
32202 The address should point to a variable of type &`int`&. The value is stored
32203 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32204
32205 .vitem &*opt_int*&
32206 This specifies an integer; the address should point to a variable of type
32207 &`int`&. The value may be specified in any of the integer formats accepted by
32208 Exim.
32209
32210 .vitem &*opt_mkint*&
32211 This is the same as &%opt_int%&, except that when such a value is output in a
32212 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32213 printed with the suffix K or M.
32214
32215 .vitem &*opt_octint*&
32216 This also specifies an integer, but the value is always interpreted as an
32217 octal integer, whether or not it starts with the digit zero, and it is
32218 always output in octal.
32219
32220 .vitem &*opt_stringptr*&
32221 This specifies a string value; the address must be a pointer to a
32222 variable that points to a string (for example, of type &`uschar *`&).
32223
32224 .vitem &*opt_time*&
32225 This specifies a time interval value. The address must point to a variable of
32226 type &`int`&. The value that is placed there is a number of seconds.
32227 .endlist
32228
32229 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32230 out the values of all the &[local_scan()]& options.
32231
32232
32233
32234 .section "Available Exim variables" "SECID208"
32235 .cindex "&[local_scan()]& function" "available Exim variables"
32236 The header &_local_scan.h_& gives you access to a number of C variables. These
32237 are the only ones that are guaranteed to be maintained from release to release.
32238 Note, however, that you can obtain the value of any Exim expansion variable,
32239 including &$recipients$&, by calling &'expand_string()'&. The exported
32240 C variables are as follows:
32241
32242 .vlist
32243 .vitem &*int&~body_linecount*&
32244 This variable contains the number of lines in the message's body.
32245
32246 .vitem &*int&~body_zerocount*&
32247 This variable contains the number of binary zero bytes in the message's body.
32248
32249 .vitem &*unsigned&~int&~debug_selector*&
32250 This variable is set to zero when no debugging is taking place. Otherwise, it
32251 is a bitmap of debugging selectors. Two bits are identified for use in
32252 &[local_scan()]&; they are defined as macros:
32253
32254 .ilist
32255 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32256 testing option that is not privileged &-- any caller may set it. All the
32257 other selector bits can be set only by admin users.
32258
32259 .next
32260 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32261 by the &`+local_scan`& debug selector. It is not included in the default set
32262 of debugging bits.
32263 .endlist ilist
32264
32265 Thus, to write to the debugging output only when &`+local_scan`& has been
32266 selected, you should use code like this:
32267 .code
32268 if ((debug_selector & D_local_scan) != 0)
32269   debug_printf("xxx", ...);
32270 .endd
32271 .vitem &*uschar&~*expand_string_message*&
32272 After a failing call to &'expand_string()'& (returned value NULL), the
32273 variable &%expand_string_message%& contains the error message, zero-terminated.
32274
32275 .vitem &*header_line&~*header_list*&
32276 A pointer to a chain of header lines. The &%header_line%& structure is
32277 discussed below.
32278
32279 .vitem &*header_line&~*header_last*&
32280 A pointer to the last of the header lines.
32281
32282 .vitem &*uschar&~*headers_charset*&
32283 The value of the &%headers_charset%& configuration option.
32284
32285 .vitem &*BOOL&~host_checking*&
32286 This variable is TRUE during a host checking session that is initiated by the
32287 &%-bh%& command line option.
32288
32289 .vitem &*uschar&~*interface_address*&
32290 The IP address of the interface that received the message, as a string. This
32291 is NULL for locally submitted messages.
32292
32293 .vitem &*int&~interface_port*&
32294 The port on which this message was received. When testing with the &%-bh%&
32295 command line option, the value of this variable is -1 unless a port has been
32296 specified via the &%-oMi%& option.
32297
32298 .vitem &*uschar&~*message_id*&
32299 This variable contains Exim's message id for the incoming message (the value of
32300 &$message_exim_id$&) as a zero-terminated string.
32301
32302 .vitem &*uschar&~*received_protocol*&
32303 The name of the protocol by which the message was received.
32304
32305 .vitem &*int&~recipients_count*&
32306 The number of accepted recipients.
32307
32308 .vitem &*recipient_item&~*recipients_list*&
32309 .cindex "recipient" "adding in local scan"
32310 .cindex "recipient" "removing in local scan"
32311 The list of accepted recipients, held in a vector of length
32312 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32313 can add additional recipients by calling &'receive_add_recipient()'& (see
32314 below). You can delete recipients by removing them from the vector and
32315 adjusting the value in &%recipients_count%&. In particular, by setting
32316 &%recipients_count%& to zero you remove all recipients. If you then return the
32317 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32318 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32319 and then call &'receive_add_recipient()'& as often as needed.
32320
32321 .vitem &*uschar&~*sender_address*&
32322 The envelope sender address. For bounce messages this is the empty string.
32323
32324 .vitem &*uschar&~*sender_host_address*&
32325 The IP address of the sending host, as a string. This is NULL for
32326 locally-submitted messages.
32327
32328 .vitem &*uschar&~*sender_host_authenticated*&
32329 The name of the authentication mechanism that was used, or NULL if the message
32330 was not received over an authenticated SMTP connection.
32331
32332 .vitem &*uschar&~*sender_host_name*&
32333 The name of the sending host, if known.
32334
32335 .vitem &*int&~sender_host_port*&
32336 The port on the sending host.
32337
32338 .vitem &*BOOL&~smtp_input*&
32339 This variable is TRUE for all SMTP input, including BSMTP.
32340
32341 .vitem &*BOOL&~smtp_batched_input*&
32342 This variable is TRUE for BSMTP input.
32343
32344 .vitem &*int&~store_pool*&
32345 The contents of this variable control which pool of memory is used for new
32346 requests. See section &<<SECTmemhanloc>>& for details.
32347 .endlist
32348
32349
32350 .section "Structure of header lines" "SECID209"
32351 The &%header_line%& structure contains the members listed below.
32352 You can add additional header lines by calling the &'header_add()'& function
32353 (see below). You can cause header lines to be ignored (deleted) by setting
32354 their type to *.
32355
32356
32357 .vlist
32358 .vitem &*struct&~header_line&~*next*&
32359 A pointer to the next header line, or NULL for the last line.
32360
32361 .vitem &*int&~type*&
32362 A code identifying certain headers that Exim recognizes. The codes are printing
32363 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32364 Notice in particular that any header line whose type is * is not transmitted
32365 with the message. This flagging is used for header lines that have been
32366 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32367 lines.) Effectively, * means &"deleted"&.
32368
32369 .vitem &*int&~slen*&
32370 The number of characters in the header line, including the terminating and any
32371 internal newlines.
32372
32373 .vitem &*uschar&~*text*&
32374 A pointer to the text of the header. It always ends with a newline, followed by
32375 a zero byte. Internal newlines are preserved.
32376 .endlist
32377
32378
32379
32380 .section "Structure of recipient items" "SECID210"
32381 The &%recipient_item%& structure contains these members:
32382
32383 .vlist
32384 .vitem &*uschar&~*address*&
32385 This is a pointer to the recipient address as it was received.
32386
32387 .vitem &*int&~pno*&
32388 This is used in later Exim processing when top level addresses are created by
32389 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32390 and must always contain -1 at this stage.
32391
32392 .vitem &*uschar&~*errors_to*&
32393 If this value is not NULL, bounce messages caused by failing to deliver to the
32394 recipient are sent to the address it contains. In other words, it overrides the
32395 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32396 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32397 an unqualified address, Exim qualifies it using the domain from
32398 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32399 is NULL for all recipients.
32400 .endlist
32401
32402
32403
32404 .section "Available Exim functions" "SECID211"
32405 .cindex "&[local_scan()]& function" "available Exim functions"
32406 The header &_local_scan.h_& gives you access to a number of Exim functions.
32407 These are the only ones that are guaranteed to be maintained from release to
32408 release:
32409
32410 .vlist
32411 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32412        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32413
32414 This function creates a child process that runs the command specified by
32415 &%argv%&. The environment for the process is specified by &%envp%&, which can
32416 be NULL if no environment variables are to be passed. A new umask is supplied
32417 for the process in &%newumask%&.
32418
32419 Pipes to the standard input and output of the new process are set up
32420 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32421 standard error is cloned to the standard output. If there are any file
32422 descriptors &"in the way"& in the new process, they are closed. If the final
32423 argument is TRUE, the new process is made into a process group leader.
32424
32425 The function returns the pid of the new process, or -1 if things go wrong.
32426
32427 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32428 This function waits for a child process to terminate, or for a timeout (in
32429 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32430 return value is as follows:
32431
32432 .ilist
32433 >= 0
32434
32435 The process terminated by a normal exit and the value is the process
32436 ending status.
32437
32438 .next
32439 < 0 and > &--256
32440
32441 The process was terminated by a signal and the value is the negation of the
32442 signal number.
32443
32444 .next
32445 &--256
32446
32447 The process timed out.
32448 .next
32449 &--257
32450
32451 The was some other error in wait(); &%errno%& is still set.
32452 .endlist
32453
32454 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32455 This function provide you with a means of submitting a new message to
32456 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32457 want, but this packages it all up for you.) The function creates a pipe,
32458 forks a subprocess that is running
32459 .code
32460 exim -t -oem -oi -f <>
32461 .endd
32462 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32463 that is connected to the standard input. The yield of the function is the PID
32464 of the subprocess. You can then write a message to the file descriptor, with
32465 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32466
32467 When you have finished, call &'child_close()'& to wait for the process to
32468 finish and to collect its ending status. A timeout value of zero is usually
32469 fine in this circumstance. Unless you have made a mistake with the recipient
32470 addresses, you should get a return code of zero.
32471
32472
32473 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32474        *sender_authentication)*&
32475 This function is a more sophisticated version of &'child_open()'&. The command
32476 that it runs is:
32477 .display
32478 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32479 .endd
32480 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32481
32482
32483 .vitem &*void&~debug_printf(char&~*,&~...)*&
32484 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32485 output is written to the standard error stream. If no debugging is selected,
32486 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32487 conditional on the &`local_scan`& debug selector by coding like this:
32488 .code
32489 if ((debug_selector & D_local_scan) != 0)
32490   debug_printf("xxx", ...);
32491 .endd
32492
32493 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32494 This is an interface to Exim's string expansion code. The return value is the
32495 expanded string, or NULL if there was an expansion failure.
32496 The C variable &%expand_string_message%& contains an error message after an
32497 expansion failure. If expansion does not change the string, the return value is
32498 the pointer to the input string. Otherwise, the return value points to a new
32499 block of memory that was obtained by a call to &'store_get()'&. See section
32500 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32501
32502 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32503 This function allows you to an add additional header line at the end of the
32504 existing ones. The first argument is the type, and should normally be a space
32505 character. The second argument is a format string and any number of
32506 substitution arguments as for &[sprintf()]&. You may include internal newlines
32507 if you want, and you must ensure that the string ends with a newline.
32508
32509 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32510         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32511 This function adds a new header line at a specified point in the header
32512 chain. The header itself is specified as for &'header_add()'&.
32513
32514 If &%name%& is NULL, the new header is added at the end of the chain if
32515 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32516 NULL, the header lines are searched for the first non-deleted header that
32517 matches the name. If one is found, the new header is added before it if
32518 &%after%& is false. If &%after%& is true, the new header is added after the
32519 found header and any adjacent subsequent ones with the same name (even if
32520 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32521 option controls where the header is added. If it is true, addition is at the
32522 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32523 headers, or at the top if there are no &'Received:'& headers, you could use
32524 .code
32525 header_add_at_position(TRUE, US"Received", TRUE,
32526   ' ', "X-xxx: ...");
32527 .endd
32528 Normally, there is always at least one non-deleted &'Received:'& header, but
32529 there may not be if &%received_header_text%& expands to an empty string.
32530
32531
32532 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32533 This function removes header lines. If &%occurrence%& is zero or negative, all
32534 occurrences of the header are removed. If occurrence is greater than zero, that
32535 particular instance of the header is removed. If no header(s) can be found that
32536 match the specification, the function does nothing.
32537
32538
32539 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32540         int&~length,&~BOOL&~notdel)*&"
32541 This function tests whether the given header has the given name. It is not just
32542 a string comparison, because white space is permitted between the name and the
32543 colon. If the &%notdel%& argument is true, a false return is forced for all
32544 &"deleted"& headers; otherwise they are not treated specially. For example:
32545 .code
32546 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32547 .endd
32548 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32549 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32550 This function base64-encodes a string, which is passed by address and length.
32551 The text may contain bytes of any value, including zero. The result is passed
32552 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32553 zero-terminated.
32554
32555 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32556 This function decodes a base64-encoded string. Its arguments are a
32557 zero-terminated base64-encoded string and the address of a variable that is set
32558 to point to the result, which is in dynamic memory. The length of the decoded
32559 string is the yield of the function. If the input is invalid base64 data, the
32560 yield is -1. A zero byte is added to the end of the output string to make it
32561 easy to interpret as a C string (assuming it contains no zeros of its own). The
32562 added zero byte is not included in the returned count.
32563
32564 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32565 This function checks for a match in a domain list. Domains are always
32566 matched caselessly. The return value is one of the following:
32567 .display
32568 &`OK     `& match succeeded
32569 &`FAIL   `& match failed
32570 &`DEFER  `& match deferred
32571 .endd
32572 DEFER is usually caused by some kind of lookup defer, such as the
32573 inability to contact a database.
32574
32575 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32576         BOOL&~caseless)*&"
32577 This function checks for a match in a local part list. The third argument
32578 controls case-sensitivity. The return values are as for
32579 &'lss_match_domain()'&.
32580
32581 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32582         BOOL&~caseless)*&"
32583 This function checks for a match in an address list. The third argument
32584 controls the case-sensitivity of the local part match. The domain is always
32585 matched caselessly. The return values are as for &'lss_match_domain()'&.
32586
32587 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32588         uschar&~*list)*&"
32589 This function checks for a match in a host list. The most common usage is
32590 expected to be
32591 .code
32592 lss_match_host(sender_host_name, sender_host_address, ...)
32593 .endd
32594 .vindex "&$sender_host_address$&"
32595 An empty address field matches an empty item in the host list. If the host name
32596 is NULL, the name corresponding to &$sender_host_address$& is automatically
32597 looked up if a host name is required to match an item in the list. The return
32598 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32599 returns ERROR in the case when it had to look up a host name, but the lookup
32600 failed.
32601
32602 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32603         *format,&~...)*&"
32604 This function writes to Exim's log files. The first argument should be zero (it
32605 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32606 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32607 them. It specifies to which log or logs the message is written. The remaining
32608 arguments are a format and relevant insertion arguments. The string should not
32609 contain any newlines, not even at the end.
32610
32611
32612 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32613 This function adds an additional recipient to the message. The first argument
32614 is the recipient address. If it is unqualified (has no domain), it is qualified
32615 with the &%qualify_recipient%& domain. The second argument must always be -1.
32616
32617 This function does not allow you to specify a private &%errors_to%& address (as
32618 described with the structure of &%recipient_item%& above), because it pre-dates
32619 the addition of that field to the structure. However, it is easy to add such a
32620 value afterwards. For example:
32621 .code
32622  receive_add_recipient(US"monitor@mydom.example", -1);
32623  recipients_list[recipients_count-1].errors_to =
32624    US"postmaster@mydom.example";
32625 .endd
32626
32627 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32628 This is a convenience function to remove a named recipient from the list of
32629 recipients. It returns true if a recipient was removed, and false if no
32630 matching recipient could be found. The argument must be a complete email
32631 address.
32632 .endlist
32633
32634
32635 .cindex "RFC 2047"
32636 .vlist
32637 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32638   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32639 This function decodes strings that are encoded according to RFC 2047. Typically
32640 these are the contents of header lines. First, each &"encoded word"& is decoded
32641 from the Q or B encoding into a byte-string. Then, if provided with the name of
32642 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32643 made  to translate the result to the named character set. If this fails, the
32644 binary string is returned with an error message.
32645
32646 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32647 maximum MIME word length is enforced. The third argument is the target
32648 encoding, or NULL if no translation is wanted.
32649
32650 .cindex "binary zero" "in RFC 2047 decoding"
32651 .cindex "RFC 2047" "binary zero in"
32652 If a binary zero is encountered in the decoded string, it is replaced by the
32653 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32654 not be 0 because header lines are handled as zero-terminated strings.
32655
32656 The function returns the result of processing the string, zero-terminated; if
32657 &%lenptr%& is not NULL, the length of the result is set in the variable to
32658 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32659
32660 If an error is encountered, the function returns NULL and uses the &%error%&
32661 argument to return an error message. The variable pointed to by &%error%& is
32662 set to NULL if there is no error; it may be set non-NULL even when the function
32663 returns a non-NULL value if decoding was successful, but there was a problem
32664 with translation.
32665
32666
32667 .vitem &*int&~smtp_fflush(void)*&
32668 This function is used in conjunction with &'smtp_printf()'&, as described
32669 below.
32670
32671 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32672 The arguments of this function are like &[printf()]&; it writes to the SMTP
32673 output stream. You should use this function only when there is an SMTP output
32674 stream, that is, when the incoming message is being received via interactive
32675 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32676 is FALSE. If you want to test for an incoming message from another host (as
32677 opposed to a local process that used the &%-bs%& command line option), you can
32678 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32679 is involved.
32680
32681 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32682 output function, so it can be used for all forms of SMTP connection.
32683
32684 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32685 must start with an appropriate response code: 550 if you are going to return
32686 LOCAL_SCAN_REJECT, 451 if you are going to return
32687 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32688 initial lines of a multi-line response, the code must be followed by a hyphen
32689 to indicate that the line is not the final response line. You must also ensure
32690 that the lines you write terminate with CRLF. For example:
32691 .code
32692 smtp_printf("550-this is some extra info\r\n");
32693 return LOCAL_SCAN_REJECT;
32694 .endd
32695 Note that you can also create multi-line responses by including newlines in
32696 the data returned via the &%return_text%& argument. The added value of using
32697 &'smtp_printf()'& is that, for instance, you could introduce delays between
32698 multiple output lines.
32699
32700 The &'smtp_printf()'& function does not return any error indication, because it
32701 does not automatically flush pending output, and therefore does not test
32702 the state of the stream. (In the main code of Exim, flushing and error
32703 detection is done when Exim is ready for the next SMTP input command.) If
32704 you want to flush the output and check for an error (for example, the
32705 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32706 arguments. It flushes the output stream, and returns a non-zero value if there
32707 is an error.
32708
32709 .vitem &*void&~*store_get(int)*&
32710 This function accesses Exim's internal store (memory) manager. It gets a new
32711 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32712 runs out of memory. See the next section for a discussion of memory handling.
32713
32714 .vitem &*void&~*store_get_perm(int)*&
32715 This function is like &'store_get()'&, but it always gets memory from the
32716 permanent pool. See the next section for a discussion of memory handling.
32717
32718 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32719 See below.
32720
32721 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32722 See below.
32723
32724 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32725 These three functions create strings using Exim's dynamic memory facilities.
32726 The first makes a copy of an entire string. The second copies up to a maximum
32727 number of characters, indicated by the second argument. The third uses a format
32728 and insertion arguments to create a new string. In each case, the result is a
32729 pointer to a new string in the current memory pool. See the next section for
32730 more discussion.
32731 .endlist
32732
32733
32734
32735 .section "More about Exim's memory handling" "SECTmemhanloc"
32736 .cindex "&[local_scan()]& function" "memory handling"
32737 No function is provided for freeing memory, because that is never needed.
32738 The dynamic memory that Exim uses when receiving a message is automatically
32739 recycled if another message is received by the same process (this applies only
32740 to incoming SMTP connections &-- other input methods can supply only one
32741 message at a time). After receiving the last message, a reception process
32742 terminates.
32743
32744 Because it is recycled, the normal dynamic memory cannot be used for holding
32745 data that must be preserved over a number of incoming messages on the same SMTP
32746 connection. However, Exim in fact uses two pools of dynamic memory; the second
32747 one is not recycled, and can be used for this purpose.
32748
32749 If you want to allocate memory that remains available for subsequent messages
32750 in the same SMTP connection, you should set
32751 .code
32752 store_pool = POOL_PERM
32753 .endd
32754 before calling the function that does the allocation. There is no need to
32755 restore the value if you do not need to; however, if you do want to revert to
32756 the normal pool, you can either restore the previous value of &%store_pool%& or
32757 set it explicitly to POOL_MAIN.
32758
32759 The pool setting applies to all functions that get dynamic memory, including
32760 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32761 There is also a convenience function called &'store_get_perm()'& that gets a
32762 block of memory from the permanent pool while preserving the value of
32763 &%store_pool%&.
32764 .ecindex IIDlosca
32765
32766
32767
32768
32769 . ////////////////////////////////////////////////////////////////////////////
32770 . ////////////////////////////////////////////////////////////////////////////
32771
32772 .chapter "System-wide message filtering" "CHAPsystemfilter"
32773 .scindex IIDsysfil1 "filter" "system filter"
32774 .scindex IIDsysfil2 "filtering all mail"
32775 .scindex IIDsysfil3 "system filter"
32776 The previous chapters (on ACLs and the local scan function) describe checks
32777 that can be applied to messages before they are accepted by a host. There is
32778 also a mechanism for checking messages once they have been received, but before
32779 they are delivered. This is called the &'system filter'&.
32780
32781 The system filter operates in a similar manner to users' filter files, but it
32782 is run just once per message (however many recipients the message has).
32783 It should not normally be used as a substitute for routing, because &%deliver%&
32784 commands in a system router provide new envelope recipient addresses.
32785 The system filter must be an Exim filter. It cannot be a Sieve filter.
32786
32787 The system filter is run at the start of a delivery attempt, before any routing
32788 is done. If a message fails to be completely delivered at the first attempt,
32789 the system filter is run again at the start of every retry.
32790 If you want your filter to do something only once per message, you can make use
32791 of the &%first_delivery%& condition in an &%if%& command in the filter to
32792 prevent it happening on retries.
32793
32794 .vindex "&$domain$&"
32795 .vindex "&$local_part$&"
32796 &*Warning*&: Because the system filter runs just once, variables that are
32797 specific to individual recipient addresses, such as &$local_part$& and
32798 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32799 you want to run a centrally-specified filter for each recipient address
32800 independently, you can do so by setting up a suitable &(redirect)& router, as
32801 described in section &<<SECTperaddfil>>& below.
32802
32803
32804 .section "Specifying a system filter" "SECID212"
32805 .cindex "uid (user id)" "system filter"
32806 .cindex "gid (group id)" "system filter"
32807 The name of the file that contains the system filter must be specified by
32808 setting &%system_filter%&. If you want the filter to run under a uid and gid
32809 other than root, you must also set &%system_filter_user%& and
32810 &%system_filter_group%& as appropriate. For example:
32811 .code
32812 system_filter = /etc/mail/exim.filter
32813 system_filter_user = exim
32814 .endd
32815 If a system filter generates any deliveries directly to files or pipes (via the
32816 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32817 specified by setting &%system_filter_file_transport%& and
32818 &%system_filter_pipe_transport%&, respectively. Similarly,
32819 &%system_filter_reply_transport%& must be set to handle any messages generated
32820 by the &%reply%& command.
32821
32822
32823 .section "Testing a system filter" "SECID213"
32824 You can run simple tests of a system filter in the same way as for a user
32825 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32826 are permitted only in system filters are recognized.
32827
32828 If you want to test the combined effect of a system filter and a user filter,
32829 you can use both &%-bF%& and &%-bf%& on the same command line.
32830
32831
32832
32833 .section "Contents of a system filter" "SECID214"
32834 The language used to specify system filters is the same as for users' filter
32835 files. It is described in the separate end-user document &'Exim's interface to
32836 mail filtering'&. However, there are some additional features that are
32837 available only in system filters; these are described in subsequent sections.
32838 If they are encountered in a user's filter file or when testing with &%-bf%&,
32839 they cause errors.
32840
32841 .cindex "frozen messages" "manual thaw; testing in filter"
32842 There are two special conditions which, though available in users' filter
32843 files, are designed for use in system filters. The condition &%first_delivery%&
32844 is true only for the first attempt at delivering a message, and
32845 &%manually_thawed%& is true only if the message has been frozen, and
32846 subsequently thawed by an admin user. An explicit forced delivery counts as a
32847 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32848
32849 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32850 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32851 succeed, it will not be tried again.
32852 If you want Exim to retry an unseen delivery until it succeeds, you should
32853 arrange to set it up every time the filter runs.
32854
32855 When a system filter finishes running, the values of the variables &$n0$& &--
32856 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32857 users' filter files. Thus a system filter can, for example, set up &"scores"&
32858 to which users' filter files can refer.
32859
32860
32861
32862 .section "Additional variable for system filters" "SECID215"
32863 .vindex "&$recipients$&"
32864 The expansion variable &$recipients$&, containing a list of all the recipients
32865 of the message (separated by commas and white space), is available in system
32866 filters. It is not available in users' filters for privacy reasons.
32867
32868
32869
32870 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32871 .cindex "freezing messages"
32872 .cindex "message" "freezing"
32873 .cindex "message" "forced failure"
32874 .cindex "&%fail%&" "in system filter"
32875 .cindex "&%freeze%& in system filter"
32876 .cindex "&%defer%& in system filter"
32877 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32878 always available in system filters, but are not normally enabled in users'
32879 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32880 for the &(redirect)& router.) These commands can optionally be followed by the
32881 word &%text%& and a string containing an error message, for example:
32882 .code
32883 fail text "this message looks like spam to me"
32884 .endd
32885 The keyword &%text%& is optional if the next character is a double quote.
32886
32887 The &%defer%& command defers delivery of the original recipients of the
32888 message. The &%fail%& command causes all the original recipients to be failed,
32889 and a bounce message to be created. The &%freeze%& command suspends all
32890 delivery attempts for the original recipients. In all cases, any new deliveries
32891 that are specified by the filter are attempted as normal after the filter has
32892 run.
32893
32894 The &%freeze%& command is ignored if the message has been manually unfrozen and
32895 not manually frozen since. This means that automatic freezing by a system
32896 filter can be used as a way of checking out suspicious messages. If a message
32897 is found to be all right, manually unfreezing it allows it to be delivered.
32898
32899 .cindex "log" "&%fail%& command log line"
32900 .cindex "&%fail%&" "log line; reducing"
32901 The text given with a fail command is used as part of the bounce message as
32902 well as being written to the log. If the message is quite long, this can fill
32903 up a lot of log space when such failures are common. To reduce the size of the
32904 log message, Exim interprets the text in a special way if it starts with the
32905 two characters &`<<`& and contains &`>>`& later. The text between these two
32906 strings is written to the log, and the rest of the text is used in the bounce
32907 message. For example:
32908 .code
32909 fail "<<filter test 1>>Your message is rejected \
32910      because it contains attachments that we are \
32911      not prepared to receive."
32912 .endd
32913
32914 .cindex "loop" "caused by &%fail%&"
32915 Take great care with the &%fail%& command when basing the decision to fail on
32916 the contents of the message, because the bounce message will of course include
32917 the contents of the original message and will therefore trigger the &%fail%&
32918 command again (causing a mail loop) unless steps are taken to prevent this.
32919 Testing the &%error_message%& condition is one way to prevent this. You could
32920 use, for example
32921 .code
32922 if $message_body contains "this is spam" and not error_message
32923 then fail text "spam is not wanted here" endif
32924 .endd
32925 though of course that might let through unwanted bounce messages. The
32926 alternative is clever checking of the body and/or headers to detect bounces
32927 generated by the filter.
32928
32929 The interpretation of a system filter file ceases after a
32930 &%defer%&,
32931 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32932 set up earlier in the filter file are honoured, so you can use a sequence such
32933 as
32934 .code
32935 mail ...
32936 freeze
32937 .endd
32938 to send a specified message when the system filter is freezing (or deferring or
32939 failing) a message. The normal deliveries for the message do not, of course,
32940 take place.
32941
32942
32943
32944 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32945 .cindex "header lines" "adding; in system filter"
32946 .cindex "header lines" "removing; in system filter"
32947 .cindex "filter" "header lines; adding/removing"
32948 Two filter commands that are available only in system filters are:
32949 .code
32950 headers add <string>
32951 headers remove <string>
32952 .endd
32953 The argument for the &%headers add%& is a string that is expanded and then
32954 added to the end of the message's headers. It is the responsibility of the
32955 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32956 space is ignored, and if the string is otherwise empty, or if the expansion is
32957 forced to fail, the command has no effect.
32958
32959 You can use &"\n"& within the string, followed by white space, to specify
32960 continued header lines. More than one header may be added in one command by
32961 including &"\n"& within the string without any following white space. For
32962 example:
32963 .code
32964 headers add "X-header-1: ....\n  \
32965              continuation of X-header-1 ...\n\
32966              X-header-2: ...."
32967 .endd
32968 Note that the header line continuation white space after the first newline must
32969 be placed before the backslash that continues the input string, because white
32970 space after input continuations is ignored.
32971
32972 The argument for &%headers remove%& is a colon-separated list of header names.
32973 This command applies only to those headers that are stored with the message;
32974 those that are added at delivery time (such as &'Envelope-To:'& and
32975 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32976 header with the same name, they are all removed.
32977
32978 The &%headers%& command in a system filter makes an immediate change to the set
32979 of header lines that was received with the message (with possible additions
32980 from ACL processing). Subsequent commands in the system filter operate on the
32981 modified set, which also forms the basis for subsequent message delivery.
32982 Unless further modified during routing or transporting, this set of headers is
32983 used for all recipients of the message.
32984
32985 During routing and transporting, the variables that refer to the contents of
32986 header lines refer only to those lines that are in this set. Thus, header lines
32987 that are added by a system filter are visible to users' filter files and to all
32988 routers and transports. This contrasts with the manipulation of header lines by
32989 routers and transports, which is not immediate, but which instead is saved up
32990 until the message is actually being written (see section
32991 &<<SECTheadersaddrem>>&).
32992
32993 If the message is not delivered at the first attempt, header lines that were
32994 added by the system filter are stored with the message, and so are still
32995 present at the next delivery attempt. Header lines that were removed are still
32996 present, but marked &"deleted"& so that they are not transported with the
32997 message. For this reason, it is usual to make the &%headers%& command
32998 conditional on &%first_delivery%& so that the set of header lines is not
32999 modified more than once.
33000
33001 Because header modification in a system filter acts immediately, you have to
33002 use an indirect approach if you want to modify the contents of a header line.
33003 For example:
33004 .code
33005 headers add "Old-Subject: $h_subject:"
33006 headers remove "Subject"
33007 headers add "Subject: new subject (was: $h_old-subject:)"
33008 headers remove "Old-Subject"
33009 .endd
33010
33011
33012
33013 .section "Setting an errors address in a system filter" "SECID217"
33014 .cindex "envelope sender"
33015 In a system filter, if a &%deliver%& command is followed by
33016 .code
33017 errors_to <some address>
33018 .endd
33019 in order to change the envelope sender (and hence the error reporting) for that
33020 delivery, any address may be specified. (In a user filter, only the current
33021 user's address can be set.) For example, if some mail is being monitored, you
33022 might use
33023 .code
33024 unseen deliver monitor@spying.example errors_to root@local.example
33025 .endd
33026 to take a copy which would not be sent back to the normal error reporting
33027 address if its delivery failed.
33028
33029
33030
33031 .section "Per-address filtering" "SECTperaddfil"
33032 .vindex "&$domain$&"
33033 .vindex "&$local_part$&"
33034 In contrast to the system filter, which is run just once per message for each
33035 delivery attempt, it is also possible to set up a system-wide filtering
33036 operation that runs once for each recipient address. In this case, variables
33037 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33038 filter file could be made dependent on them. This is an example of a router
33039 which implements such a filter:
33040 .code
33041 central_filter:
33042   check_local_user
33043   driver = redirect
33044   domains = +local_domains
33045   file = /central/filters/$local_part
33046   no_verify
33047   allow_filter
33048   allow_freeze
33049 .endd
33050 The filter is run in a separate process under its own uid. Therefore, either
33051 &%check_local_user%& must be set (as above), in which case the filter is run as
33052 the local user, or the &%user%& option must be used to specify which user to
33053 use. If both are set, &%user%& overrides.
33054
33055 Care should be taken to ensure that none of the commands in the filter file
33056 specify a significant delivery if the message is to go on to be delivered to
33057 its intended recipient. The router will not then claim to have dealt with the
33058 address, so it will be passed on to subsequent routers to be delivered in the
33059 normal way.
33060 .ecindex IIDsysfil1
33061 .ecindex IIDsysfil2
33062 .ecindex IIDsysfil3
33063
33064
33065
33066
33067
33068
33069 . ////////////////////////////////////////////////////////////////////////////
33070 . ////////////////////////////////////////////////////////////////////////////
33071
33072 .chapter "Message processing" "CHAPmsgproc"
33073 .scindex IIDmesproc "message" "general processing"
33074 Exim performs various transformations on the sender and recipient addresses of
33075 all messages that it handles, and also on the messages' header lines. Some of
33076 these are optional and configurable, while others always take place. All of
33077 this processing, except rewriting as a result of routing, and the addition or
33078 removal of header lines while delivering, happens when a message is received,
33079 before it is placed on Exim's queue.
33080
33081 Some of the automatic processing takes place by default only for
33082 &"locally-originated"& messages. This adjective is used to describe messages
33083 that are not received over TCP/IP, but instead are passed to an Exim process on
33084 its standard input. This includes the interactive &"local SMTP"& case that is
33085 set up by the &%-bs%& command line option.
33086
33087 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33088 or ::1) are not considered to be locally-originated. Exim does not treat the
33089 loopback interface specially in any way.
33090
33091 If you want the loopback interface to be treated specially, you must ensure
33092 that there are appropriate entries in your ACLs.
33093
33094
33095
33096
33097 .section "Submission mode for non-local messages" "SECTsubmodnon"
33098 .cindex "message" "submission"
33099 .cindex "submission mode"
33100 Processing that happens automatically for locally-originated messages (unless
33101 &%suppress_local_fixups%& is set) can also be requested for messages that are
33102 received over TCP/IP. The term &"submission mode"& is used to describe this
33103 state. Submission mode is set by the modifier
33104 .code
33105 control = submission
33106 .endd
33107 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33108 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33109 a local submission, and is normally used when the source of the message is
33110 known to be an MUA running on a client host (as opposed to an MTA). For
33111 example, to set submission mode for messages originating on the IPv4 loopback
33112 interface, you could include the following in the MAIL ACL:
33113 .code
33114 warn  hosts = 127.0.0.1
33115       control = submission
33116 .endd
33117 .cindex "&%sender_retain%& submission option"
33118 There are some options that can be used when setting submission mode. A slash
33119 is used to separate options. For example:
33120 .code
33121 control = submission/sender_retain
33122 .endd
33123 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33124 true and &%local_from_check%& false for the current incoming message. The first
33125 of these allows an existing &'Sender:'& header in the message to remain, and
33126 the second suppresses the check to ensure that &'From:'& matches the
33127 authenticated sender. With this setting, Exim still fixes up messages by adding
33128 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33129 attempt to check sender authenticity in header lines.
33130
33131 When &%sender_retain%& is not set, a submission mode setting may specify a
33132 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33133 example:
33134 .code
33135 control = submission/domain=some.domain
33136 .endd
33137 The domain may be empty. How this value is used is described in sections
33138 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33139 that allows you to specify the user's full name for inclusion in a created
33140 &'Sender:'& or &'From:'& header line. For example:
33141 .code
33142 accept authenticated = *
33143        control = submission/domain=wonderland.example/\
33144                             name=${lookup {$authenticated_id} \
33145                                    lsearch {/etc/exim/namelist}}
33146 .endd
33147 Because the name may contain any characters, including slashes, the &%name%&
33148 option must be given last. The remainder of the string is used as the name. For
33149 the example above, if &_/etc/exim/namelist_& contains:
33150 .code
33151 bigegg:  Humpty Dumpty
33152 .endd
33153 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33154 line would be:
33155 .code
33156 Sender: Humpty Dumpty <bigegg@wonderland.example>
33157 .endd
33158 .cindex "return path" "in submission mode"
33159 By default, submission mode forces the return path to the same address as is
33160 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33161 specified, the return path is also left unchanged.
33162
33163 &*Note*&: The changes caused by submission mode take effect after the predata
33164 ACL. This means that any sender checks performed before the fix-ups use the
33165 untrusted sender address specified by the user, not the trusted sender address
33166 specified by submission mode. Although this might be slightly unexpected, it
33167 does mean that you can configure ACL checks to spot that a user is trying to
33168 spoof another's address.
33169
33170 .section "Line endings" "SECTlineendings"
33171 .cindex "line endings"
33172 .cindex "carriage return"
33173 .cindex "linefeed"
33174 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33175 linefeed) is the line ending for messages transmitted over the Internet using
33176 SMTP over TCP/IP. However, within individual operating systems, different
33177 conventions are used. For example, Unix-like systems use just LF, but others
33178 use CRLF or just CR.
33179
33180 Exim was designed for Unix-like systems, and internally, it stores messages
33181 using the system's convention of a single LF as a line terminator. When
33182 receiving a message, all line endings are translated to this standard format.
33183 Originally, it was thought that programs that passed messages directly to an
33184 MTA within an operating system would use that system's convention. Experience
33185 has shown that this is not the case; for example, there are Unix applications
33186 that use CRLF in this circumstance. For this reason, and for compatibility with
33187 other MTAs, the way Exim handles line endings for all messages is now as
33188 follows:
33189
33190 .ilist
33191 LF not preceded by CR is treated as a line ending.
33192 .next
33193 CR is treated as a line ending; if it is immediately followed by LF, the LF
33194 is ignored.
33195 .next
33196 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33197 nor a local message in the state where a line containing only a dot is a
33198 terminator.
33199 .next
33200 If a bare CR is encountered within a header line, an extra space is added after
33201 the line terminator so as not to end the header line. The reasoning behind this
33202 is that bare CRs in header lines are most likely either to be mistakes, or
33203 people trying to play silly games.
33204 .next
33205 If the first header line received in a message ends with CRLF, a subsequent
33206 bare LF in a header line is treated in the same way as a bare CR in a header
33207 line.
33208 .endlist
33209
33210
33211
33212
33213
33214 .section "Unqualified addresses" "SECID218"
33215 .cindex "unqualified addresses"
33216 .cindex "address" "qualification"
33217 By default, Exim expects every envelope address it receives from an external
33218 host to be fully qualified. Unqualified addresses cause negative responses to
33219 SMTP commands. However, because SMTP is used as a means of transporting
33220 messages from MUAs running on personal workstations, there is sometimes a
33221 requirement to accept unqualified addresses from specific hosts or IP networks.
33222
33223 Exim has two options that separately control which hosts may send unqualified
33224 sender or recipient addresses in SMTP commands, namely
33225 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33226 cases, if an unqualified address is accepted, it is qualified by adding the
33227 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33228
33229 .oindex "&%qualify_domain%&"
33230 .oindex "&%qualify_recipient%&"
33231 Unqualified addresses in header lines are automatically qualified for messages
33232 that are locally originated, unless the &%-bnq%& option is given on the command
33233 line. For messages received over SMTP, unqualified addresses in header lines
33234 are qualified only if unqualified addresses are permitted in SMTP commands. In
33235 other words, such qualification is also controlled by
33236 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33237
33238
33239
33240
33241 .section "The UUCP From line" "SECID219"
33242 .cindex "&""From""& line"
33243 .cindex "UUCP" "&""From""& line"
33244 .cindex "sender" "address"
33245 .oindex "&%uucp_from_pattern%&"
33246 .oindex "&%uucp_from_sender%&"
33247 .cindex "envelope sender"
33248 .cindex "Sendmail compatibility" "&""From""& line"
33249 Messages that have come from UUCP (and some other applications) often begin
33250 with a line containing the envelope sender and a timestamp, following the word
33251 &"From"&. Examples of two common formats are:
33252 .code
33253 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33254 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33255 .endd
33256 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33257 Exim recognizes such lines at the start of messages that are submitted to it
33258 via the command line (that is, on the standard input). It does not recognize
33259 such lines in incoming SMTP messages, unless the sending host matches
33260 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33261 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33262 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33263 default value matches the two common cases shown above and puts the address
33264 that follows &"From"& into &$1$&.
33265
33266 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33267 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33268 a trusted user, the message's sender address is constructed by expanding the
33269 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33270 then parsed as an RFC 2822 address. If there is no domain, the local part is
33271 qualified with &%qualify_domain%& unless it is the empty string. However, if
33272 the command line &%-f%& option is used, it overrides the &"From"& line.
33273
33274 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33275 sender address is not changed. This is also the case for incoming SMTP messages
33276 that are permitted to contain &"From"& lines.
33277
33278 Only one &"From"& line is recognized. If there is more than one, the second is
33279 treated as a data line that starts the body of the message, as it is not valid
33280 as a header line. This also happens if a &"From"& line is present in an
33281 incoming SMTP message from a source that is not permitted to send them.
33282
33283
33284
33285 .section "Resent- header lines" "SECID220"
33286 .cindex "&%Resent-%& header lines"
33287 RFC 2822 makes provision for sets of header lines starting with the string
33288 &`Resent-`& to be added to a message when it is resent by the original
33289 recipient to somebody else. These headers are &'Resent-Date:'&,
33290 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33291 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33292
33293 .blockquote
33294 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33295 processing of replies or other such automatic actions on messages.'&
33296 .endblockquote
33297
33298 This leaves things a bit vague as far as other processing actions such as
33299 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33300 follows:
33301
33302 .ilist
33303 A &'Resent-From:'& line that just contains the login id of the submitting user
33304 is automatically rewritten in the same way as &'From:'& (see below).
33305 .next
33306 If there's a rewriting rule for a particular header line, it is also applied to
33307 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33308 &'From:'& also rewrites &'Resent-From:'&.
33309 .next
33310 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33311 also removed.
33312 .next
33313 For a locally-submitted message,
33314 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33315 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33316 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33317 included in log lines in this case.
33318 .next
33319 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33320 &%Resent-%& header lines are present.
33321 .endlist
33322
33323
33324
33325
33326 .section "The Auto-Submitted: header line" "SECID221"
33327 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33328 includes the header line:
33329 .code
33330 Auto-Submitted: auto-replied
33331 .endd
33332
33333 .section "The Bcc: header line" "SECID222"
33334 .cindex "&'Bcc:'& header line"
33335 If Exim is called with the &%-t%& option, to take recipient addresses from a
33336 message's header, it removes any &'Bcc:'& header line that may exist (after
33337 extracting its addresses). If &%-t%& is not present on the command line, any
33338 existing &'Bcc:'& is not removed.
33339
33340
33341 .section "The Date: header line" "SECID223"
33342 .cindex "&'Date:'& header line"
33343 If a locally-generated or submission-mode message has no &'Date:'& header line,
33344 Exim adds one, using the current date and time, unless the
33345 &%suppress_local_fixups%& control has been specified.
33346
33347 .section "The Delivery-date: header line" "SECID224"
33348 .cindex "&'Delivery-date:'& header line"
33349 .oindex "&%delivery_date_remove%&"
33350 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33351 set. Exim can be configured to add them to the final delivery of messages. (See
33352 the generic &%delivery_date_add%& transport option.) They should not be present
33353 in messages in transit. If the &%delivery_date_remove%& configuration option is
33354 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33355 messages.
33356
33357
33358 .section "The Envelope-to: header line" "SECID225"
33359 .cindex "&'Envelope-to:'& header line"
33360 .oindex "&%envelope_to_remove%&"
33361 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33362 Exim can be configured to add them to the final delivery of messages. (See the
33363 generic &%envelope_to_add%& transport option.) They should not be present in
33364 messages in transit. If the &%envelope_to_remove%& configuration option is set
33365 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33366 messages.
33367
33368
33369 .section "The From: header line" "SECTthefrohea"
33370 .cindex "&'From:'& header line"
33371 .cindex "Sendmail compatibility" "&""From""& line"
33372 .cindex "message" "submission"
33373 .cindex "submission mode"
33374 If a submission-mode message does not contain a &'From:'& header line, Exim
33375 adds one if either of the following conditions is true:
33376
33377 .ilist
33378 The envelope sender address is not empty (that is, this is not a bounce
33379 message). The added header line copies the envelope sender address.
33380 .next
33381 .vindex "&$authenticated_id$&"
33382 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33383 .olist
33384 .vindex "&$qualify_domain$&"
33385 If no domain is specified by the submission control, the local part is
33386 &$authenticated_id$& and the domain is &$qualify_domain$&.
33387 .next
33388 If a non-empty domain is specified by the submission control, the local
33389 part is &$authenticated_id$&, and the domain is the specified domain.
33390 .next
33391 If an empty domain is specified by the submission control,
33392 &$authenticated_id$& is assumed to be the complete address.
33393 .endlist
33394 .endlist
33395
33396 A non-empty envelope sender takes precedence.
33397
33398 If a locally-generated incoming message does not contain a &'From:'& header
33399 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33400 containing the sender's address. The calling user's login name and full name
33401 are used to construct the address, as described in section &<<SECTconstr>>&.
33402 They are obtained from the password data by calling &[getpwuid()]& (but see the
33403 &%unknown_login%& configuration option). The address is qualified with
33404 &%qualify_domain%&.
33405
33406 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33407 &'From:'& header line containing just the unqualified login name of the calling
33408 user, this is replaced by an address containing the user's login name and full
33409 name as described in section &<<SECTconstr>>&.
33410
33411
33412 .section "The Message-ID: header line" "SECID226"
33413 .cindex "&'Message-ID:'& header line"
33414 .cindex "message" "submission"
33415 .oindex "&%message_id_header_text%&"
33416 If a locally-generated or submission-mode incoming message does not contain a
33417 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33418 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33419 to the message. If there are any &'Resent-:'& headers in the message, it
33420 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33421 message id, preceded by the letter E to ensure it starts with a letter, and
33422 followed by @ and the primary host name. Additional information can be included
33423 in this header line by setting the &%message_id_header_text%& and/or
33424 &%message_id_header_domain%& options.
33425
33426
33427 .section "The Received: header line" "SECID227"
33428 .cindex "&'Received:'& header line"
33429 A &'Received:'& header line is added at the start of every message. The
33430 contents are defined by the &%received_header_text%& configuration option, and
33431 Exim automatically adds a semicolon and a timestamp to the configured string.
33432
33433 The &'Received:'& header is generated as soon as the message's header lines
33434 have been received. At this stage, the timestamp in the &'Received:'& header
33435 line is the time that the message started to be received. This is the value
33436 that is seen by the DATA ACL and by the &[local_scan()]& function.
33437
33438 Once a message is accepted, the timestamp in the &'Received:'& header line is
33439 changed to the time of acceptance, which is (apart from a small delay while the
33440 -H spool file is written) the earliest time at which delivery could start.
33441
33442
33443 .section "The References: header line" "SECID228"
33444 .cindex "&'References:'& header line"
33445 Messages created by the &(autoreply)& transport include a &'References:'&
33446 header line. This is constructed according to the rules that are described in
33447 section 3.64 of RFC 2822 (which states that replies should contain such a
33448 header line), and section 3.14 of RFC 3834 (which states that automatic
33449 responses are not different in this respect). However, because some mail
33450 processing software does not cope well with very long header lines, no more
33451 than 12 message IDs are copied from the &'References:'& header line in the
33452 incoming message. If there are more than 12, the first one and then the final
33453 11 are copied, before adding the message ID of the incoming message.
33454
33455
33456
33457 .section "The Return-path: header line" "SECID229"
33458 .cindex "&'Return-path:'& header line"
33459 .oindex "&%return_path_remove%&"
33460 &'Return-path:'& header lines are defined as something an MTA may insert when
33461 it does the final delivery of messages. (See the generic &%return_path_add%&
33462 transport option.) Therefore, they should not be present in messages in
33463 transit. If the &%return_path_remove%& configuration option is set (the
33464 default), Exim removes &'Return-path:'& header lines from incoming messages.
33465
33466
33467
33468 .section "The Sender: header line" "SECTthesenhea"
33469 .cindex "&'Sender:'& header line"
33470 .cindex "message" "submission"
33471 For a locally-originated message from an untrusted user, Exim may remove an
33472 existing &'Sender:'& header line, and it may add a new one. You can modify
33473 these actions by setting the &%local_sender_retain%& option true, the
33474 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33475 control setting.
33476
33477 When a local message is received from an untrusted user and
33478 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33479 control has not been set, a check is made to see if the address given in the
33480 &'From:'& header line is the correct (local) sender of the message. The address
33481 that is expected has the login name as the local part and the value of
33482 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33483 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33484 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33485 line is added to the message.
33486
33487 If you set &%local_from_check%& false, this checking does not occur. However,
33488 the removal of an existing &'Sender:'& line still happens, unless you also set
33489 &%local_sender_retain%& to be true. It is not possible to set both of these
33490 options true at the same time.
33491
33492 .cindex "submission mode"
33493 By default, no processing of &'Sender:'& header lines is done for messages
33494 received over TCP/IP or for messages submitted by trusted users. However, when
33495 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33496 not specified on the submission control, the following processing takes place:
33497
33498 .vindex "&$authenticated_id$&"
33499 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33500 authenticated, and &$authenticated_id$& is not empty, a sender address is
33501 created as follows:
33502
33503 .ilist
33504 .vindex "&$qualify_domain$&"
33505 If no domain is specified by the submission control, the local part is
33506 &$authenticated_id$& and the domain is &$qualify_domain$&.
33507 .next
33508 If a non-empty domain is specified by the submission control, the local part
33509 is &$authenticated_id$&, and the domain is the specified domain.
33510 .next
33511 If an empty domain is specified by the submission control,
33512 &$authenticated_id$& is assumed to be the complete address.
33513 .endlist
33514
33515 This address is compared with the address in the &'From:'& header line. If they
33516 are different, a &'Sender:'& header line containing the created address is
33517 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33518 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33519
33520 .cindex "return path" "created from &'Sender:'&"
33521 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33522 the message (the envelope sender address) is changed to be the same address,
33523 except in the case of submission mode when &%sender_retain%& is specified.
33524
33525
33526
33527 .section "Adding and removing header lines in routers and transports" &&&
33528          "SECTheadersaddrem"
33529 .cindex "header lines" "adding; in router or transport"
33530 .cindex "header lines" "removing; in router or transport"
33531 When a message is delivered, the addition and removal of header lines can be
33532 specified in a system filter, or on any of the routers and transports that
33533 process the message. Section &<<SECTaddremheasys>>& contains details about
33534 modifying headers in a system filter. Header lines can also be added in an ACL
33535 as a message is received (see section &<<SECTaddheadacl>>&).
33536
33537 In contrast to what happens in a system filter, header modifications that are
33538 specified on routers and transports apply only to the particular recipient
33539 addresses that are being processed by those routers and transports. These
33540 changes do not actually take place until a copy of the message is being
33541 transported. Therefore, they do not affect the basic set of header lines, and
33542 they do not affect the values of the variables that refer to header lines.
33543
33544 &*Note*&: In particular, this means that any expansions in the configuration of
33545 the transport cannot refer to the modified header lines, because such
33546 expansions all occur before the message is actually transported.
33547
33548 For both routers and transports, the argument of a &%headers_add%&
33549 option must be in the form of one or more RFC 2822 header lines, separated by
33550 newlines (coded as &"\n"&). For example:
33551 .code
33552 headers_add = X-added-header: added by $primary_hostname\n\
33553               X-added-second: another added header line
33554 .endd
33555 Exim does not check the syntax of these added header lines.
33556
33557 Multiple &%headers_add%& options for a single router or transport can be
33558 specified; the values will append to a single list of header lines.
33559 Each header-line is separately expanded.
33560
33561 The argument of a &%headers_remove%& option must consist of a colon-separated
33562 list of header names. This is confusing, because header names themselves are
33563 often terminated by colons. In this case, the colons are the list separators,
33564 not part of the names. For example:
33565 .code
33566 headers_remove = return-receipt-to:acknowledge-to
33567 .endd
33568
33569 Multiple &%headers_remove%& options for a single router or transport can be
33570 specified; the arguments will append to a single header-names list.
33571 Each item is separately expanded.
33572 Note that colons in complex expansions which are used to
33573 form all or part of a &%headers_remove%& list
33574 will act as list separators.
33575
33576 When &%headers_add%& or &%headers_remove%& is specified on a router,
33577 items are expanded at routing time,
33578 and then associated with all addresses that are
33579 accepted by that router, and also with any new addresses that it generates. If
33580 an address passes through several routers as a result of aliasing or
33581 forwarding, the changes are cumulative.
33582
33583 .oindex "&%unseen%&"
33584 However, this does not apply to multiple routers that result from the use of
33585 the &%unseen%& option. Any header modifications that were specified by the
33586 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33587
33588 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33589 settings cannot be delivered together in a batch, so a transport is always
33590 dealing with a set of addresses that have the same header-processing
33591 requirements.
33592
33593 The transport starts by writing the original set of header lines that arrived
33594 with the message, possibly modified by the system filter. As it writes out
33595 these lines, it consults the list of header names that were attached to the
33596 recipient address(es) by &%headers_remove%& options in routers, and it also
33597 consults the transport's own &%headers_remove%& option. Header lines whose
33598 names are on either of these lists are not written out. If there are multiple
33599 instances of any listed header, they are all skipped.
33600
33601 After the remaining original header lines have been written, new header
33602 lines that were specified by routers' &%headers_add%& options are written, in
33603 the order in which they were attached to the address. These are followed by any
33604 header lines specified by the transport's &%headers_add%& option.
33605
33606 This way of handling header line modifications in routers and transports has
33607 the following consequences:
33608
33609 .ilist
33610 The original set of header lines, possibly modified by the system filter,
33611 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33612 to it, at all times.
33613 .next
33614 Header lines that are added by a router's
33615 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33616 expansion syntax in subsequent routers or the transport.
33617 .next
33618 Conversely, header lines that are specified for removal by &%headers_remove%&
33619 in a router remain visible to subsequent routers and the transport.
33620 .next
33621 Headers added to an address by &%headers_add%& in a router cannot be removed by
33622 a later router or by a transport.
33623 .next
33624 An added header can refer to the contents of an original header that is to be
33625 removed, even it has the same name as the added header. For example:
33626 .code
33627 headers_remove = subject
33628 headers_add = Subject: new subject (was: $h_subject:)
33629 .endd
33630 .endlist
33631
33632 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33633 for a &(redirect)& router that has the &%one_time%& option set.
33634
33635
33636
33637
33638
33639 .section "Constructed addresses" "SECTconstr"
33640 .cindex "address" "constructed"
33641 .cindex "constructed address"
33642 When Exim constructs a sender address for a locally-generated message, it uses
33643 the form
33644 .display
33645 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33646 .endd
33647 For example:
33648 .code
33649 Zaphod Beeblebrox <zaphod@end.univ.example>
33650 .endd
33651 The user name is obtained from the &%-F%& command line option if set, or
33652 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33653 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33654 ampersand character, this is replaced by the login name with the first letter
33655 upper cased, as is conventional in a number of operating systems. See the
33656 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33657 The &%unknown_username%& option can be used to specify user names in cases when
33658 there is no password file entry.
33659
33660 .cindex "RFC 2047"
33661 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33662 parts of it if necessary. In addition, if it contains any non-printing
33663 characters, it is encoded as described in RFC 2047, which defines a way of
33664 including non-ASCII characters in header lines. The value of the
33665 &%headers_charset%& option specifies the name of the encoding that is used (the
33666 characters are assumed to be in this encoding). The setting of
33667 &%print_topbitchars%& controls whether characters with the top bit set (that
33668 is, with codes greater than 127) count as printing characters or not.
33669
33670
33671
33672 .section "Case of local parts" "SECID230"
33673 .cindex "case of local parts"
33674 .cindex "local part" "case of"
33675 RFC 2822 states that the case of letters in the local parts of addresses cannot
33676 be assumed to be non-significant. Exim preserves the case of local parts of
33677 addresses, but by default it uses a lower-cased form when it is routing,
33678 because on most Unix systems, usernames are in lower case and case-insensitive
33679 routing is required. However, any particular router can be made to use the
33680 original case for local parts by setting the &%caseful_local_part%& generic
33681 router option.
33682
33683 .cindex "mixed-case login names"
33684 If you must have mixed-case user names on your system, the best way to proceed,
33685 assuming you want case-independent handling of incoming email, is to set up
33686 your first router to convert incoming local parts in your domains to the
33687 correct case by means of a file lookup. For example:
33688 .code
33689 correct_case:
33690   driver = redirect
33691   domains = +local_domains
33692   data = ${lookup{$local_part}cdb\
33693               {/etc/usercased.cdb}{$value}fail}\
33694               @$domain
33695 .endd
33696 For this router, the local part is forced to lower case by the default action
33697 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33698 up a new local part in the correct case. If you then set &%caseful_local_part%&
33699 on any subsequent routers which process your domains, they will operate on
33700 local parts with the correct case in a case-sensitive manner.
33701
33702
33703
33704 .section "Dots in local parts" "SECID231"
33705 .cindex "dot" "in local part"
33706 .cindex "local part" "dots in"
33707 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33708 part may not begin or end with a dot, nor have two consecutive dots in the
33709 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33710 empty components for compatibility.
33711
33712
33713
33714 .section "Rewriting addresses" "SECID232"
33715 .cindex "rewriting" "addresses"
33716 Rewriting of sender and recipient addresses, and addresses in headers, can
33717 happen automatically, or as the result of configuration options, as described
33718 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33719 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33720
33721 Automatic rewriting includes qualification, as mentioned above. The other case
33722 in which it can happen is when an incomplete non-local domain is given. The
33723 routing process may cause this to be expanded into the full domain name. For
33724 example, a header such as
33725 .code
33726 To: hare@teaparty
33727 .endd
33728 might get rewritten as
33729 .code
33730 To: hare@teaparty.wonderland.fict.example
33731 .endd
33732 Rewriting as a result of routing is the one kind of message processing that
33733 does not happen at input time, as it cannot be done until the address has
33734 been routed.
33735
33736 Strictly, one should not do &'any'& deliveries of a message until all its
33737 addresses have been routed, in case any of the headers get changed as a
33738 result of routing. However, doing this in practice would hold up many
33739 deliveries for unreasonable amounts of time, just because one address could not
33740 immediately be routed. Exim therefore does not delay other deliveries when
33741 routing of one or more addresses is deferred.
33742 .ecindex IIDmesproc
33743
33744
33745
33746 . ////////////////////////////////////////////////////////////////////////////
33747 . ////////////////////////////////////////////////////////////////////////////
33748
33749 .chapter "SMTP processing" "CHAPSMTP"
33750 .scindex IIDsmtpproc1 "SMTP" "processing details"
33751 .scindex IIDsmtpproc2 "LMTP" "processing details"
33752 Exim supports a number of different ways of using the SMTP protocol, and its
33753 LMTP variant, which is an interactive protocol for transferring messages into a
33754 closed mail store application. This chapter contains details of how SMTP is
33755 processed. For incoming mail, the following are available:
33756
33757 .ilist
33758 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33759 .next
33760 SMTP over the standard input and output (the &%-bs%& option);
33761 .next
33762 Batched SMTP on the standard input (the &%-bS%& option).
33763 .endlist
33764
33765 For mail delivery, the following are available:
33766
33767 .ilist
33768 SMTP over TCP/IP (the &(smtp)& transport);
33769 .next
33770 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33771 &"lmtp"&);
33772 .next
33773 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33774 transport);
33775 .next
33776 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33777 the &%use_bsmtp%& option set).
33778 .endlist
33779
33780 &'Batched SMTP'& is the name for a process in which batches of messages are
33781 stored in or read from files (or pipes), in a format in which SMTP commands are
33782 used to contain the envelope information.
33783
33784
33785
33786 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33787 .cindex "SMTP" "outgoing over TCP/IP"
33788 .cindex "outgoing SMTP over TCP/IP"
33789 .cindex "LMTP" "over TCP/IP"
33790 .cindex "outgoing LMTP over TCP/IP"
33791 .cindex "EHLO"
33792 .cindex "HELO"
33793 .cindex "SIZE option on MAIL command"
33794 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33795 The &%protocol%& option selects which protocol is to be used, but the actual
33796 processing is the same in both cases.
33797
33798 If, in response to its EHLO command, Exim is told that the SIZE
33799 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33800 command. The value of <&'n'&> is the message size plus the value of the
33801 &%size_addition%& option (default 1024) to allow for additions to the message
33802 such as per-transport header lines, or changes made in a
33803 .cindex "transport" "filter"
33804 .cindex "filter" "transport filter"
33805 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33806 suppressed.
33807
33808 If the remote server advertises support for PIPELINING, Exim uses the
33809 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33810 required for the transaction.
33811
33812 If the remote server advertises support for the STARTTLS command, and Exim
33813 was built to support TLS encryption, it tries to start a TLS session unless the
33814 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33815 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33816 is called for verification.
33817
33818 If the remote server advertises support for the AUTH command, Exim scans
33819 the authenticators configuration for any suitable client settings, as described
33820 in chapter &<<CHAPSMTPAUTH>>&.
33821
33822 .cindex "carriage return"
33823 .cindex "linefeed"
33824 Responses from the remote host are supposed to be terminated by CR followed by
33825 LF. However, there are known to be hosts that do not send CR characters, so in
33826 order to be able to interwork with such hosts, Exim treats LF on its own as a
33827 line terminator.
33828
33829 If a message contains a number of different addresses, all those with the same
33830 characteristics (for example, the same envelope sender) that resolve to the
33831 same set of hosts, in the same order, are sent in a single SMTP transaction,
33832 even if they are for different domains, unless there are more than the setting
33833 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33834 they are split into groups containing no more than &%max_rcpt%&s addresses
33835 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33836 in parallel sessions. The order of hosts with identical MX values is not
33837 significant when checking whether addresses can be batched in this way.
33838
33839 When the &(smtp)& transport suffers a temporary failure that is not
33840 message-related, Exim updates its transport-specific database, which contains
33841 records indexed by host name that remember which messages are waiting for each
33842 particular host. It also updates the retry database with new retry times.
33843
33844 .cindex "hints database" "retry keys"
33845 Exim's retry hints are based on host name plus IP address, so if one address of
33846 a multi-homed host is broken, it will soon be skipped most of the time.
33847 See the next section for more detail about error handling.
33848
33849 .cindex "SMTP" "passed connection"
33850 .cindex "SMTP" "batching over TCP/IP"
33851 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33852 looks in the hints database for the transport to see if there are any queued
33853 messages waiting for the host to which it is connected. If it finds one, it
33854 creates a new Exim process using the &%-MC%& option (which can only be used by
33855 a process running as root or the Exim user) and passes the TCP/IP socket to it
33856 so that it can deliver another message using the same socket. The new process
33857 does only those deliveries that are routed to the connected host, and may in
33858 turn pass the socket on to a third process, and so on.
33859
33860 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33861 limit the number of messages sent down a single TCP/IP connection.
33862
33863 .cindex "asterisk" "after IP address"
33864 The second and subsequent messages delivered down an existing connection are
33865 identified in the main log by the addition of an asterisk after the closing
33866 square bracket of the IP address.
33867
33868
33869
33870
33871 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33872 .cindex "error" "in outgoing SMTP"
33873 .cindex "SMTP" "errors in outgoing"
33874 .cindex "host" "error"
33875 Three different kinds of error are recognized for outgoing SMTP: host errors,
33876 message errors, and recipient errors.
33877
33878 .vlist
33879 .vitem "&*Host errors*&"
33880 A host error is not associated with a particular message or with a
33881 particular recipient of a message. The host errors are:
33882
33883 .ilist
33884 Connection refused or timed out,
33885 .next
33886 Any error response code on connection,
33887 .next
33888 Any error response code to EHLO or HELO,
33889 .next
33890 Loss of connection at any time, except after &"."&,
33891 .next
33892 I/O errors at any time,
33893 .next
33894 Timeouts during the session, other than in response to MAIL, RCPT or
33895 the &"."& at the end of the data.
33896 .endlist ilist
33897
33898 For a host error, a permanent error response on connection, or in response to
33899 EHLO, causes all addresses routed to the host to be failed. Any other host
33900 error causes all addresses to be deferred, and retry data to be created for the
33901 host. It is not tried again, for any message, until its retry time arrives. If
33902 the current set of addresses are not all delivered in this run (to some
33903 alternative host), the message is added to the list of those waiting for this
33904 host, so if it is still undelivered when a subsequent successful delivery is
33905 made to the host, it will be sent down the same SMTP connection.
33906
33907 .vitem "&*Message errors*&"
33908 .cindex "message" "error"
33909 A message error is associated with a particular message when sent to a
33910 particular host, but not with a particular recipient of the message. The
33911 message errors are:
33912
33913 .ilist
33914 Any error response code to MAIL, DATA, or the &"."& that terminates
33915 the data,
33916 .next
33917 Timeout after MAIL,
33918 .next
33919 Timeout or loss of connection after the &"."& that terminates the data. A
33920 timeout after the DATA command itself is treated as a host error, as is loss of
33921 connection at any other time.
33922 .endlist ilist
33923
33924 For a message error, a permanent error response (5&'xx'&) causes all addresses
33925 to be failed, and a delivery error report to be returned to the sender. A
33926 temporary error response (4&'xx'&), or one of the timeouts, causes all
33927 addresses to be deferred. Retry data is not created for the host, but instead,
33928 a retry record for the combination of host plus message id is created. The
33929 message is not added to the list of those waiting for this host. This ensures
33930 that the failing message will not be sent to this host again until the retry
33931 time arrives. However, other messages that are routed to the host are not
33932 affected, so if it is some property of the message that is causing the error,
33933 it will not stop the delivery of other mail.
33934
33935 If the remote host specified support for the SIZE parameter in its response
33936 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33937 over-large message will cause a message error because the error arrives as a
33938 response to MAIL.
33939
33940 .vitem "&*Recipient errors*&"
33941 .cindex "recipient" "error"
33942 A recipient error is associated with a particular recipient of a message. The
33943 recipient errors are:
33944
33945 .ilist
33946 Any error response to RCPT,
33947 .next
33948 Timeout after RCPT.
33949 .endlist
33950
33951 For a recipient error, a permanent error response (5&'xx'&) causes the
33952 recipient address to be failed, and a bounce message to be returned to the
33953 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33954 address to be deferred, and routing retry data to be created for it. This is
33955 used to delay processing of the address in subsequent queue runs, until its
33956 routing retry time arrives. This applies to all messages, but because it
33957 operates only in queue runs, one attempt will be made to deliver a new message
33958 to the failing address before the delay starts to operate. This ensures that,
33959 if the failure is really related to the message rather than the recipient
33960 (&"message too big for this recipient"& is a possible example), other messages
33961 have a chance of getting delivered. If a delivery to the address does succeed,
33962 the retry information gets cleared, so all stuck messages get tried again, and
33963 the retry clock is reset.
33964
33965 The message is not added to the list of those waiting for this host. Use of the
33966 host for other messages is unaffected, and except in the case of a timeout,
33967 other recipients are processed independently, and may be successfully delivered
33968 in the current SMTP session. After a timeout it is of course impossible to
33969 proceed with the session, so all addresses get deferred. However, those other
33970 than the one that failed do not suffer any subsequent retry delays. Therefore,
33971 if one recipient is causing trouble, the others have a chance of getting
33972 through when a subsequent delivery attempt occurs before the failing
33973 recipient's retry time.
33974 .endlist
33975
33976 In all cases, if there are other hosts (or IP addresses) available for the
33977 current set of addresses (for example, from multiple MX records), they are
33978 tried in this run for any undelivered addresses, subject of course to their
33979 own retry data. In other words, recipient error retry data does not take effect
33980 until the next delivery attempt.
33981
33982 Some hosts have been observed to give temporary error responses to every
33983 MAIL command at certain times (&"insufficient space"& has been seen). It
33984 would be nice if such circumstances could be recognized, and defer data for the
33985 host itself created, but this is not possible within the current Exim design.
33986 What actually happens is that retry data for every (host, message) combination
33987 is created.
33988
33989 The reason that timeouts after MAIL and RCPT are treated specially is that
33990 these can sometimes arise as a result of the remote host's verification
33991 procedures. Exim makes this assumption, and treats them as if a temporary error
33992 response had been received. A timeout after &"."& is treated specially because
33993 it is known that some broken implementations fail to recognize the end of the
33994 message if the last character of the last line is a binary zero. Thus, it is
33995 helpful to treat this case as a message error.
33996
33997 Timeouts at other times are treated as host errors, assuming a problem with the
33998 host, or the connection to it. If a timeout after MAIL, RCPT,
33999 or &"."& is really a connection problem, the assumption is that at the next try
34000 the timeout is likely to occur at some other point in the dialogue, causing it
34001 then to be treated as a host error.
34002
34003 There is experimental evidence that some MTAs drop the connection after the
34004 terminating &"."& if they do not like the contents of the message for some
34005 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34006 should be given. That is why Exim treats this case as a message rather than a
34007 host error, in order not to delay other messages to the same host.
34008
34009
34010
34011
34012 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34013 .cindex "SMTP" "incoming over TCP/IP"
34014 .cindex "incoming SMTP over TCP/IP"
34015 .cindex "inetd"
34016 .cindex "daemon"
34017 Incoming SMTP messages can be accepted in one of two ways: by running a
34018 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34019 &_/etc/inetd.conf_& should be like this:
34020 .code
34021 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34022 .endd
34023 Exim distinguishes between this case and the case of a locally running user
34024 agent using the &%-bs%& option by checking whether or not the standard input is
34025 a socket. When it is, either the port must be privileged (less than 1024), or
34026 the caller must be root or the Exim user. If any other user passes a socket
34027 with an unprivileged port number, Exim prints a message on the standard error
34028 stream and exits with an error code.
34029
34030 By default, Exim does not make a log entry when a remote host connects or
34031 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34032 unexpected. It can be made to write such log entries by setting the
34033 &%smtp_connection%& log selector.
34034
34035 .cindex "carriage return"
34036 .cindex "linefeed"
34037 Commands from the remote host are supposed to be terminated by CR followed by
34038 LF. However, there are known to be hosts that do not send CR characters. In
34039 order to be able to interwork with such hosts, Exim treats LF on its own as a
34040 line terminator.
34041 Furthermore, because common code is used for receiving messages from all
34042 sources, a CR on its own is also interpreted as a line terminator. However, the
34043 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34044
34045 .cindex "EHLO" "invalid data"
34046 .cindex "HELO" "invalid data"
34047 One area that sometimes gives rise to problems concerns the EHLO or
34048 HELO commands. Some clients send syntactically invalid versions of these
34049 commands, which Exim rejects by default. (This is nothing to do with verifying
34050 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34051 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34052 match the broken hosts that send invalid commands.
34053
34054 .cindex "SIZE option on MAIL command"
34055 .cindex "MAIL" "SIZE option"
34056 The amount of disk space available is checked whenever SIZE is received on
34057 a MAIL command, independently of whether &%message_size_limit%& or
34058 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34059 false. A temporary error is given if there is not enough space. If
34060 &%check_spool_space%& is set, the check is for that amount of space plus the
34061 value given with SIZE, that is, it checks that the addition of the incoming
34062 message will not reduce the space below the threshold.
34063
34064 When a message is successfully received, Exim includes the local message id in
34065 its response to the final &"."& that terminates the data. If the remote host
34066 logs this text it can help with tracing what has happened to a message.
34067
34068 The Exim daemon can limit the number of simultaneous incoming connections it is
34069 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34070 number of simultaneous incoming connections from a single remote host (see the
34071 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34072 rejected using the SMTP temporary error code 421.
34073
34074 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34075 subprocess has finished, as this can get lost at busy times. Instead, it looks
34076 for completed subprocesses every time it wakes up. Provided there are other
34077 things happening (new incoming calls, starts of queue runs), completed
34078 processes will be noticed and tidied away. On very quiet systems you may
34079 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34080 it will be noticed when the daemon next wakes up.
34081
34082 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34083 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34084 high system load &-- for details see the &%smtp_accept_reserve%&,
34085 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34086 applies in both the daemon and &'inetd'& cases.
34087
34088 Exim normally starts a delivery process for each message received, though this
34089 can be varied by means of the &%-odq%& command line option and the
34090 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34091 number of simultaneously running delivery processes started in this way from
34092 SMTP input can be limited by the &%smtp_accept_queue%& and
34093 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34094 subsequently received messages are just put on the input queue without starting
34095 a delivery process.
34096
34097 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34098 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34099 started up from the &'inetd'& daemon, because in that case each connection is
34100 handled by an entirely independent Exim process. Control by load average is,
34101 however, available with &'inetd'&.
34102
34103 Exim can be configured to verify addresses in incoming SMTP commands as they
34104 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34105 to rewrite addresses at this time &-- before any syntax checking is done. See
34106 section &<<SECTrewriteS>>&.
34107
34108 Exim can also be configured to limit the rate at which a client host submits
34109 MAIL and RCPT commands in a single SMTP session. See the
34110 &%smtp_ratelimit_hosts%& option.
34111
34112
34113
34114 .section "Unrecognized SMTP commands" "SECID234"
34115 .cindex "SMTP" "unrecognized commands"
34116 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34117 commands during a single SMTP connection, it drops the connection after sending
34118 the error response to the last command. The default value for
34119 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34120 abuse that subvert web servers into making connections to SMTP ports; in these
34121 circumstances, a number of non-SMTP lines are sent first.
34122
34123
34124 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34125 .cindex "SMTP" "syntax errors"
34126 .cindex "SMTP" "protocol errors"
34127 A syntax error is detected if an SMTP command is recognized, but there is
34128 something syntactically wrong with its data, for example, a malformed email
34129 address in a RCPT command. Protocol errors include invalid command
34130 sequencing such as RCPT before MAIL. If Exim receives more than
34131 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34132 drops the connection after sending the error response to the last command. The
34133 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34134 broken clients that loop sending bad commands (yes, it has been seen).
34135
34136
34137
34138 .section "Use of non-mail SMTP commands" "SECID236"
34139 .cindex "SMTP" "non-mail commands"
34140 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34141 DATA. Exim counts such commands, and drops the connection if there are too
34142 many of them in a single SMTP session. This action catches some
34143 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34144 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34145 defines what &"too many"& means. Its default value is 10.
34146
34147 When a new message is expected, one occurrence of RSET is not counted. This
34148 allows a client to send one RSET between messages (this is not necessary,
34149 but some clients do it). Exim also allows one uncounted occurrence of HELO
34150 or EHLO, and one occurrence of STARTTLS between messages. After
34151 starting up a TLS session, another EHLO is expected, and so it too is not
34152 counted.
34153
34154 The first occurrence of AUTH in a connection, or immediately following
34155 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34156 RCPT, DATA, and QUIT are counted.
34157
34158 You can control which hosts are subject to the limit set by
34159 &%smtp_accept_max_nonmail%& by setting
34160 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34161 the limit apply to all hosts. This option means that you can exclude any
34162 specific badly-behaved hosts that you have to live with.
34163
34164
34165
34166
34167 .section "The VRFY and EXPN commands" "SECID237"
34168 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34169 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34170 appropriate) in order to decide whether the command should be accepted or not.
34171
34172 .new
34173 .cindex "VRFY" "processing"
34174 When no ACL is defined for VRFY, or if it rejects without
34175 setting an explicit response code, the command is accepted
34176 (with a 252 SMTP response code)
34177 in order to support awkward clients that do a VRFY before every RCPT.
34178 .wen
34179 When VRFY is accepted, it runs exactly the same code as when Exim is
34180 called with the &%-bv%& option, and returns 250/451/550
34181 SMTP response codes.
34182
34183 .cindex "EXPN" "processing"
34184 If no ACL for EXPN is defined, the command is rejected.
34185 When EXPN is accepted, a single-level expansion of the address is done.
34186 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34187 than a verification (the &%-bv%& option). If an unqualified local part is given
34188 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34189 of VRFY and EXPN commands are logged on the main and reject logs, and
34190 VRFY verification failures are logged on the main log for consistency with
34191 RCPT failures.
34192
34193
34194
34195 .section "The ETRN command" "SECTETRN"
34196 .cindex "ETRN" "processing"
34197 RFC 1985 describes an SMTP command called ETRN that is designed to
34198 overcome the security problems of the TURN command (which has fallen into
34199 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34200 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34201 should be accepted or not. If no ACL is defined, the command is rejected.
34202
34203 The ETRN command is concerned with &"releasing"& messages that are awaiting
34204 delivery to certain hosts. As Exim does not organize its message queue by host,
34205 the only form of ETRN that is supported by default is the one where the
34206 text starts with the &"#"& prefix, in which case the remainder of the text is
34207 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34208 the &%-R%& option to happen, with the remainder of the ETRN text as its
34209 argument. For example,
34210 .code
34211 ETRN #brigadoon
34212 .endd
34213 runs the command
34214 .code
34215 exim -R brigadoon
34216 .endd
34217 which causes a delivery attempt on all messages with undelivered addresses
34218 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34219 default), Exim prevents the simultaneous execution of more than one queue run
34220 for the same argument string as a result of an ETRN command. This stops
34221 a misbehaving client from starting more than one queue runner at once.
34222
34223 .cindex "hints database" "ETRN serialization"
34224 Exim implements the serialization by means of a hints database in which a
34225 record is written whenever a process is started by ETRN, and deleted when
34226 the process completes. However, Exim does not keep the SMTP session waiting for
34227 the ETRN process to complete. Once ETRN is accepted, the client is sent
34228 a &"success"& return code. Obviously there is scope for hints records to get
34229 left lying around if there is a system or program crash. To guard against this,
34230 Exim ignores any records that are more than six hours old.
34231
34232 .oindex "&%smtp_etrn_command%&"
34233 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34234 used. This specifies a command that is run whenever ETRN is received,
34235 whatever the form of its argument. For
34236 example:
34237 .code
34238 smtp_etrn_command = /etc/etrn_command $domain \
34239                     $sender_host_address
34240 .endd
34241 .vindex "&$domain$&"
34242 The string is split up into arguments which are independently expanded. The
34243 expansion variable &$domain$& is set to the argument of the ETRN command,
34244 and no syntax checking is done on the contents of this argument. Exim does not
34245 wait for the command to complete, so its status code is not checked. Exim runs
34246 under its own uid and gid when receiving incoming SMTP, so it is not possible
34247 for it to change them before running the command.
34248
34249
34250
34251 .section "Incoming local SMTP" "SECID238"
34252 .cindex "SMTP" "local incoming"
34253 Some user agents use SMTP to pass messages to their local MTA using the
34254 standard input and output, as opposed to passing the envelope on the command
34255 line and writing the message to the standard input. This is supported by the
34256 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34257 messages over TCP/IP (including the use of ACLs), except that the envelope
34258 sender given in a MAIL command is ignored unless the caller is trusted. In
34259 an ACL you can detect this form of SMTP input by testing for an empty host
34260 identification. It is common to have this as the first line in the ACL that
34261 runs for RCPT commands:
34262 .code
34263 accept hosts = :
34264 .endd
34265 This accepts SMTP messages from local processes without doing any other tests.
34266
34267
34268
34269 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34270 .cindex "SMTP" "batched outgoing"
34271 .cindex "batched SMTP output"
34272 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34273 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34274 be output in BSMTP format. No SMTP responses are possible for this form of
34275 delivery. All it is doing is using SMTP commands as a way of transmitting the
34276 envelope along with the message.
34277
34278 The message is written to the file or pipe preceded by the SMTP commands
34279 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34280 the message that start with a dot have an extra dot added. The SMTP command
34281 HELO is not normally used. If it is required, the &%message_prefix%& option
34282 can be used to specify it.
34283
34284 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34285 one recipient address at a time by default. However, you can arrange for them
34286 to handle several addresses at once by setting the &%batch_max%& option. When
34287 this is done for BSMTP, messages may contain multiple RCPT commands. See
34288 chapter &<<CHAPbatching>>& for more details.
34289
34290 .vindex "&$host$&"
34291 When one or more addresses are routed to a BSMTP transport by a router that
34292 sets up a host list, the name of the first host on the list is available to the
34293 transport in the variable &$host$&. Here is an example of such a transport and
34294 router:
34295 .code
34296 begin routers
34297 route_append:
34298   driver = manualroute
34299   transport = smtp_appendfile
34300   route_list = domain.example  batch.host.example
34301
34302 begin transports
34303 smtp_appendfile:
34304   driver = appendfile
34305   directory = /var/bsmtp/$host
34306   batch_max = 1000
34307   use_bsmtp
34308   user = exim
34309 .endd
34310 This causes messages addressed to &'domain.example'& to be written in BSMTP
34311 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34312 message (unless there are more than 1000 recipients).
34313
34314
34315
34316 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34317 .cindex "SMTP" "batched incoming"
34318 .cindex "batched SMTP input"
34319 The &%-bS%& command line option causes Exim to accept one or more messages by
34320 reading SMTP on the standard input, but to generate no responses. If the caller
34321 is trusted, the senders in the MAIL commands are believed; otherwise the
34322 sender is always the caller of Exim. Unqualified senders and receivers are not
34323 rejected (there seems little point) but instead just get qualified. HELO
34324 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34325 as NOOP; QUIT quits.
34326
34327 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34328 ACL is run in the same way as for non-SMTP local input.
34329
34330 If an error is detected while reading a message, including a missing &"."& at
34331 the end, Exim gives up immediately. It writes details of the error to the
34332 standard output in a stylized way that the calling program should be able to
34333 make some use of automatically, for example:
34334 .code
34335 554 Unexpected end of file
34336 Transaction started in line 10
34337 Error detected in line 14
34338 .endd
34339 It writes a more verbose version, for human consumption, to the standard error
34340 file, for example:
34341 .code
34342 An error was detected while processing a file of BSMTP input.
34343 The error message was:
34344
34345 501 '>' missing at end of address
34346
34347 The SMTP transaction started in line 10.
34348 The error was detected in line 12.
34349 The SMTP command at fault was:
34350
34351 rcpt to:<malformed@in.com.plete
34352
34353 1 previous message was successfully processed.
34354 The rest of the batch was abandoned.
34355 .endd
34356 The return code from Exim is zero only if there were no errors. It is 1 if some
34357 messages were accepted before an error was detected, and 2 if no messages were
34358 accepted.
34359 .ecindex IIDsmtpproc1
34360 .ecindex IIDsmtpproc2
34361
34362
34363
34364 . ////////////////////////////////////////////////////////////////////////////
34365 . ////////////////////////////////////////////////////////////////////////////
34366
34367 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34368          "Customizing messages"
34369 When a message fails to be delivered, or remains on the queue for more than a
34370 configured amount of time, Exim sends a message to the original sender, or
34371 to an alternative configured address. The text of these messages is built into
34372 the code of Exim, but it is possible to change it, either by adding a single
34373 string, or by replacing each of the paragraphs by text supplied in a file.
34374
34375 The &'From:'& and &'To:'& header lines are automatically generated; you can
34376 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34377 option. Exim also adds the line
34378 .code
34379 Auto-Submitted: auto-generated
34380 .endd
34381 to all warning and bounce messages,
34382
34383
34384 .section "Customizing bounce messages" "SECID239"
34385 .cindex "customizing" "bounce message"
34386 .cindex "bounce message" "customizing"
34387 If &%bounce_message_text%& is set, its contents are included in the default
34388 message immediately after &"This message was created automatically by mail
34389 delivery software."& The string is not expanded. It is not used if
34390 &%bounce_message_file%& is set.
34391
34392 When &%bounce_message_file%& is set, it must point to a template file for
34393 constructing error messages. The file consists of a series of text items,
34394 separated by lines consisting of exactly four asterisks. If the file cannot be
34395 opened, default text is used and a message is written to the main and panic
34396 logs. If any text item in the file is empty, default text is used for that
34397 item.
34398
34399 .vindex "&$bounce_recipient$&"
34400 .vindex "&$bounce_return_size_limit$&"
34401 Each item of text that is read from the file is expanded, and there are two
34402 expansion variables which can be of use here: &$bounce_recipient$& is set to
34403 the recipient of an error message while it is being created, and
34404 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34405 option, rounded to a whole number.
34406
34407 The items must appear in the file in the following order:
34408
34409 .ilist
34410 The first item is included in the headers, and should include at least a
34411 &'Subject:'& header. Exim does not check the syntax of these headers.
34412 .next
34413 The second item forms the start of the error message. After it, Exim lists the
34414 failing addresses with their error messages.
34415 .next
34416 The third item is used to introduce any text from pipe transports that is to be
34417 returned to the sender. It is omitted if there is no such text.
34418 .next
34419 The fourth, fifth and sixth items will be ignored and may be empty.
34420 The fields exist for back-compatibility
34421 .endlist
34422
34423 The default state (&%bounce_message_file%& unset) is equivalent to the
34424 following file, in which the sixth item is empty. The &'Subject:'& and some
34425 other lines have been split in order to fit them on the page:
34426 .code
34427 Subject: Mail delivery failed
34428   ${if eq{$sender_address}{$bounce_recipient}
34429   {: returning message to sender}}
34430 ****
34431 This message was created automatically by mail delivery software.
34432
34433 A message ${if eq{$sender_address}{$bounce_recipient}
34434   {that you sent }{sent by
34435
34436 <$sender_address>
34437
34438 }}could not be delivered to all of its recipients.
34439 This is a permanent error. The following address(es) failed:
34440 ****
34441 The following text was generated during the delivery attempt(s):
34442 ****
34443 ------ This is a copy of the message, including all the headers.
34444   ------
34445 ****
34446 ------ The body of the message is $message_size characters long;
34447   only the first
34448 ------ $bounce_return_size_limit or so are included here.
34449 ****
34450 .endd
34451 .section "Customizing warning messages" "SECTcustwarn"
34452 .cindex "customizing" "warning message"
34453 .cindex "warning of delay" "customizing the message"
34454 The option &%warn_message_file%& can be pointed at a template file for use when
34455 warnings about message delays are created. In this case there are only three
34456 text sections:
34457
34458 .ilist
34459 The first item is included in the headers, and should include at least a
34460 &'Subject:'& header. Exim does not check the syntax of these headers.
34461 .next
34462 The second item forms the start of the warning message. After it, Exim lists
34463 the delayed addresses.
34464 .next
34465 The third item then ends the message.
34466 .endlist
34467
34468 The default state is equivalent to the following file, except that some lines
34469 have been split here, in order to fit them on the page:
34470 .code
34471 Subject: Warning: message $message_exim_id delayed
34472   $warn_message_delay
34473 ****
34474 This message was created automatically by mail delivery software.
34475
34476 A message ${if eq{$sender_address}{$warn_message_recipients}
34477 {that you sent }{sent by
34478
34479 <$sender_address>
34480
34481 }}has not been delivered to all of its recipients after
34482 more than $warn_message_delay on the queue on $primary_hostname.
34483
34484 The message identifier is:     $message_exim_id
34485 The subject of the message is: $h_subject
34486 The date of the message is:    $h_date
34487
34488 The following address(es) have not yet been delivered:
34489 ****
34490 No action is required on your part. Delivery attempts will
34491 continue for some time, and this warning may be repeated at
34492 intervals if the message remains undelivered. Eventually the
34493 mail delivery software will give up, and when that happens,
34494 the message will be returned to you.
34495 .endd
34496 .vindex "&$warn_message_delay$&"
34497 .vindex "&$warn_message_recipients$&"
34498 However, in the default state the subject and date lines are omitted if no
34499 appropriate headers exist. During the expansion of this file,
34500 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34501 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34502 of recipients for the warning message. There may be more than one if there are
34503 multiple addresses with different &%errors_to%& settings on the routers that
34504 handled them.
34505
34506
34507
34508
34509 . ////////////////////////////////////////////////////////////////////////////
34510 . ////////////////////////////////////////////////////////////////////////////
34511
34512 .chapter "Some common configuration settings" "CHAPcomconreq"
34513 This chapter discusses some configuration settings that seem to be fairly
34514 common. More examples and discussion can be found in the Exim book.
34515
34516
34517
34518 .section "Sending mail to a smart host" "SECID240"
34519 .cindex "smart host" "example router"
34520 If you want to send all mail for non-local domains to a &"smart host"&, you
34521 should replace the default &(dnslookup)& router with a router which does the
34522 routing explicitly:
34523 .code
34524 send_to_smart_host:
34525   driver = manualroute
34526   route_list = !+local_domains smart.host.name
34527   transport = remote_smtp
34528 .endd
34529 You can use the smart host's IP address instead of the name if you wish.
34530 If you are using Exim only to submit messages to a smart host, and not for
34531 receiving incoming messages, you can arrange for it to do the submission
34532 synchronously by setting the &%mua_wrapper%& option (see chapter
34533 &<<CHAPnonqueueing>>&).
34534
34535
34536
34537
34538 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34539 .cindex "mailing lists"
34540 Exim can be used to run simple mailing lists, but for large and/or complicated
34541 requirements, the use of additional specialized mailing list software such as
34542 Majordomo or Mailman is recommended.
34543
34544 The &(redirect)& router can be used to handle mailing lists where each list
34545 is maintained in a separate file, which can therefore be managed by an
34546 independent manager. The &%domains%& router option can be used to run these
34547 lists in a separate domain from normal mail. For example:
34548 .code
34549 lists:
34550   driver = redirect
34551   domains = lists.example
34552   file = /usr/lists/$local_part
34553   forbid_pipe
34554   forbid_file
34555   errors_to = $local_part-request@lists.example
34556   no_more
34557 .endd
34558 This router is skipped for domains other than &'lists.example'&. For addresses
34559 in that domain, it looks for a file that matches the local part. If there is no
34560 such file, the router declines, but because &%no_more%& is set, no subsequent
34561 routers are tried, and so the whole delivery fails.
34562
34563 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34564 expanded into a file name or a pipe delivery, which is usually inappropriate in
34565 a mailing list.
34566
34567 .oindex "&%errors_to%&"
34568 The &%errors_to%& option specifies that any delivery errors caused by addresses
34569 taken from a mailing list are to be sent to the given address rather than the
34570 original sender of the message. However, before acting on this, Exim verifies
34571 the error address, and ignores it if verification fails.
34572
34573 For example, using the configuration above, mail sent to
34574 &'dicts@lists.example'& is passed on to those addresses contained in
34575 &_/usr/lists/dicts_&, with error reports directed to
34576 &'dicts-request@lists.example'&, provided that this address can be verified.
34577 There could be a file called &_/usr/lists/dicts-request_& containing
34578 the address(es) of this particular list's manager(s), but other approaches,
34579 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34580 or &%local_part_suffix%& options) to handle addresses of the form
34581 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34582
34583
34584
34585 .section "Syntax errors in mailing lists" "SECID241"
34586 .cindex "mailing lists" "syntax errors in"
34587 If an entry in redirection data contains a syntax error, Exim normally defers
34588 delivery of the original address. That means that a syntax error in a mailing
34589 list holds up all deliveries to the list. This may not be appropriate when a
34590 list is being maintained automatically from data supplied by users, and the
34591 addresses are not rigorously checked.
34592
34593 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34594 entries that fail to parse, noting the incident in the log. If in addition
34595 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34596 whenever a broken address is skipped. It is usually appropriate to set
34597 &%syntax_errors_to%& to the same address as &%errors_to%&.
34598
34599
34600
34601 .section "Re-expansion of mailing lists" "SECID242"
34602 .cindex "mailing lists" "re-expansion of"
34603 Exim remembers every individual address to which a message has been delivered,
34604 in order to avoid duplication, but it normally stores only the original
34605 recipient addresses with a message. If all the deliveries to a mailing list
34606 cannot be done at the first attempt, the mailing list is re-expanded when the
34607 delivery is next tried. This means that alterations to the list are taken into
34608 account at each delivery attempt, so addresses that have been added to
34609 the list since the message arrived will therefore receive a copy of the
34610 message, even though it pre-dates their subscription.
34611
34612 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34613 on the &(redirect)& router. If this is done, any addresses generated by the
34614 router that fail to deliver at the first attempt are added to the message as
34615 &"top level"& addresses, and the parent address that generated them is marked
34616 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34617 subsequent delivery attempts. The disadvantage of this is that if any of the
34618 failing addresses are incorrect, correcting them in the file has no effect on
34619 pre-existing messages.
34620
34621 The original top-level address is remembered with each of the generated
34622 addresses, and is output in any log messages. However, any intermediate parent
34623 addresses are not recorded. This makes a difference to the log only if the
34624 &%all_parents%& selector is set, but for mailing lists there is normally only
34625 one level of expansion anyway.
34626
34627
34628
34629 .section "Closed mailing lists" "SECID243"
34630 .cindex "mailing lists" "closed"
34631 The examples so far have assumed open mailing lists, to which anybody may
34632 send mail. It is also possible to set up closed lists, where mail is accepted
34633 from specified senders only. This is done by making use of the generic
34634 &%senders%& option to restrict the router that handles the list.
34635
34636 The following example uses the same file as a list of recipients and as a list
34637 of permitted senders. It requires three routers:
34638 .code
34639 lists_request:
34640   driver = redirect
34641   domains = lists.example
34642   local_part_suffix = -request
34643   file = /usr/lists/$local_part$local_part_suffix
34644   no_more
34645
34646 lists_post:
34647   driver = redirect
34648   domains = lists.example
34649   senders = ${if exists {/usr/lists/$local_part}\
34650              {lsearch;/usr/lists/$local_part}{*}}
34651   file = /usr/lists/$local_part
34652   forbid_pipe
34653   forbid_file
34654   errors_to = $local_part-request@lists.example
34655   no_more
34656
34657 lists_closed:
34658   driver = redirect
34659   domains = lists.example
34660   allow_fail
34661   data = :fail: $local_part@lists.example is a closed mailing list
34662 .endd
34663 All three routers have the same &%domains%& setting, so for any other domains,
34664 they are all skipped. The first router runs only if the local part ends in
34665 &%-request%&. It handles messages to the list manager(s) by means of an open
34666 mailing list.
34667
34668 The second router runs only if the &%senders%& precondition is satisfied. It
34669 checks for the existence of a list that corresponds to the local part, and then
34670 checks that the sender is on the list by means of a linear search. It is
34671 necessary to check for the existence of the file before trying to search it,
34672 because otherwise Exim thinks there is a configuration error. If the file does
34673 not exist, the expansion of &%senders%& is *, which matches all senders. This
34674 means that the router runs, but because there is no list, declines, and
34675 &%no_more%& ensures that no further routers are run. The address fails with an
34676 &"unrouteable address"& error.
34677
34678 The third router runs only if the second router is skipped, which happens when
34679 a mailing list exists, but the sender is not on it. This router forcibly fails
34680 the address, giving a suitable error message.
34681
34682
34683
34684
34685 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34686 .cindex "VERP"
34687 .cindex "Variable Envelope Return Paths"
34688 .cindex "envelope sender"
34689 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34690 are a way of helping mailing list administrators discover which subscription
34691 address is the cause of a particular delivery failure. The idea is to encode
34692 the original recipient address in the outgoing envelope sender address, so that
34693 if the message is forwarded by another host and then subsequently bounces, the
34694 original recipient can be extracted from the recipient address of the bounce.
34695
34696 .oindex &%errors_to%&
34697 .oindex &%return_path%&
34698 Envelope sender addresses can be modified by Exim using two different
34699 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34700 list examples), or the &%return_path%& option on a transport. The second of
34701 these is effective only if the message is successfully delivered to another
34702 host; it is not used for errors detected on the local host (see the description
34703 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34704 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34705 .code
34706 verp_smtp:
34707   driver = smtp
34708   max_rcpt = 1
34709   return_path = \
34710     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34711       {$1-request+$local_part=$domain@your.dom.example}fail}
34712 .endd
34713 This has the effect of rewriting the return path (envelope sender) on outgoing
34714 SMTP messages, if the local part of the original return path ends in
34715 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34716 local part and domain of the recipient into the return path. Suppose, for
34717 example, that a message whose return path has been set to
34718 &'somelist-request@your.dom.example'& is sent to
34719 &'subscriber@other.dom.example'&. In the transport, the return path is
34720 rewritten as
34721 .code
34722 somelist-request+subscriber=other.dom.example@your.dom.example
34723 .endd
34724 .vindex "&$local_part$&"
34725 For this to work, you must tell Exim to send multiple copies of messages that
34726 have more than one recipient, so that each copy has just one recipient. This is
34727 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34728 might be sent to several different recipients in the same domain, in which case
34729 &$local_part$& is not available in the transport, because it is not unique.
34730
34731 Unless your host is doing nothing but mailing list deliveries, you should
34732 probably use a separate transport for the VERP deliveries, so as not to use
34733 extra resources in making one-per-recipient copies for other deliveries. This
34734 can easily be done by expanding the &%transport%& option in the router:
34735 .code
34736 dnslookup:
34737   driver = dnslookup
34738   domains = ! +local_domains
34739   transport = \
34740     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34741       {verp_smtp}{remote_smtp}}
34742   no_more
34743 .endd
34744 If you want to change the return path using &%errors_to%& in a router instead
34745 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34746 routers that handle mailing list addresses. This will ensure that all delivery
34747 errors, including those detected on the local host, are sent to the VERP
34748 address.
34749
34750 On a host that does no local deliveries and has no manual routing, only the
34751 &(dnslookup)& router needs to be changed. A special transport is not needed for
34752 SMTP deliveries. Every mailing list recipient has its own return path value,
34753 and so Exim must hand them to the transport one at a time. Here is an example
34754 of a &(dnslookup)& router that implements VERP:
34755 .code
34756 verp_dnslookup:
34757   driver = dnslookup
34758   domains = ! +local_domains
34759   transport = remote_smtp
34760   errors_to = \
34761     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34762      {$1-request+$local_part=$domain@your.dom.example}fail}
34763   no_more
34764 .endd
34765 Before you start sending out messages with VERPed return paths, you must also
34766 configure Exim to accept the bounce messages that come back to those paths.
34767 Typically this is done by setting a &%local_part_suffix%& option for a
34768 router, and using this to route the messages to wherever you want to handle
34769 them.
34770
34771 The overhead incurred in using VERP depends very much on the size of the
34772 message, the number of recipient addresses that resolve to the same remote
34773 host, and the speed of the connection over which the message is being sent. If
34774 a lot of addresses resolve to the same host and the connection is slow, sending
34775 a separate copy of the message for each address may take substantially longer
34776 than sending a single copy with many recipients (for which VERP cannot be
34777 used).
34778
34779
34780
34781
34782
34783
34784 .section "Virtual domains" "SECTvirtualdomains"
34785 .cindex "virtual domains"
34786 .cindex "domain" "virtual"
34787 The phrase &'virtual domain'& is unfortunately used with two rather different
34788 meanings:
34789
34790 .ilist
34791 A domain for which there are no real mailboxes; all valid local parts are
34792 aliases for other email addresses. Common examples are organizational
34793 top-level domains and &"vanity"& domains.
34794 .next
34795 One of a number of independent domains that are all handled by the same host,
34796 with mailboxes on that host, but where the mailbox owners do not necessarily
34797 have login accounts on that host.
34798 .endlist
34799
34800 The first usage is probably more common, and does seem more &"virtual"& than
34801 the second. This kind of domain can be handled in Exim with a straightforward
34802 aliasing router. One approach is to create a separate alias file for each
34803 virtual domain. Exim can test for the existence of the alias file to determine
34804 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34805 to a router of this form:
34806 .code
34807 virtual:
34808   driver = redirect
34809   domains = dsearch;/etc/mail/virtual
34810   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34811   no_more
34812 .endd
34813 The &%domains%& option specifies that the router is to be skipped, unless there
34814 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34815 domain that is being processed. When the router runs, it looks up the local
34816 part in the file to find a new address (or list of addresses). The &%no_more%&
34817 setting ensures that if the lookup fails (leading to &%data%& being an empty
34818 string), Exim gives up on the address without trying any subsequent routers.
34819
34820 This one router can handle all the virtual domains because the alias file names
34821 follow a fixed pattern. Permissions can be arranged so that appropriate people
34822 can edit the different alias files. A successful aliasing operation results in
34823 a new envelope recipient address, which is then routed from scratch.
34824
34825 The other kind of &"virtual"& domain can also be handled in a straightforward
34826 way. One approach is to create a file for each domain containing a list of
34827 valid local parts, and use it in a router like this:
34828 .code
34829 my_domains:
34830   driver = accept
34831   domains = dsearch;/etc/mail/domains
34832   local_parts = lsearch;/etc/mail/domains/$domain
34833   transport = my_mailboxes
34834 .endd
34835 The address is accepted if there is a file for the domain, and the local part
34836 can be found in the file. The &%domains%& option is used to check for the
34837 file's existence because &%domains%& is tested before the &%local_parts%&
34838 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34839 because that option is tested after &%local_parts%&. The transport is as
34840 follows:
34841 .code
34842 my_mailboxes:
34843   driver = appendfile
34844   file = /var/mail/$domain/$local_part
34845   user = mail
34846 .endd
34847 This uses a directory of mailboxes for each domain. The &%user%& setting is
34848 required, to specify which uid is to be used for writing to the mailboxes.
34849
34850 The configuration shown here is just one example of how you might support this
34851 requirement. There are many other ways this kind of configuration can be set
34852 up, for example, by using a database instead of separate files to hold all the
34853 information about the domains.
34854
34855
34856
34857 .section "Multiple user mailboxes" "SECTmulbox"
34858 .cindex "multiple mailboxes"
34859 .cindex "mailbox" "multiple"
34860 .cindex "local part" "prefix"
34861 .cindex "local part" "suffix"
34862 Heavy email users often want to operate with multiple mailboxes, into which
34863 incoming mail is automatically sorted. A popular way of handling this is to
34864 allow users to use multiple sender addresses, so that replies can easily be
34865 identified. Users are permitted to add prefixes or suffixes to their local
34866 parts for this purpose. The wildcard facility of the generic router options
34867 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34868 example, consider this router:
34869 .code
34870 userforward:
34871   driver = redirect
34872   check_local_user
34873   file = $home/.forward
34874   local_part_suffix = -*
34875   local_part_suffix_optional
34876   allow_filter
34877 .endd
34878 .vindex "&$local_part_suffix$&"
34879 It runs a user's &_.forward_& file for all local parts of the form
34880 &'username-*'&. Within the filter file the user can distinguish different
34881 cases by testing the variable &$local_part_suffix$&. For example:
34882 .code
34883 if $local_part_suffix contains -special then
34884 save /home/$local_part/Mail/special
34885 endif
34886 .endd
34887 If the filter file does not exist, or does not deal with such addresses, they
34888 fall through to subsequent routers, and, assuming no subsequent use of the
34889 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34890 control over which suffixes are valid.
34891
34892 Alternatively, a suffix can be used to trigger the use of a different
34893 &_.forward_& file &-- which is the way a similar facility is implemented in
34894 another MTA:
34895 .code
34896 userforward:
34897   driver = redirect
34898   check_local_user
34899   file = $home/.forward$local_part_suffix
34900   local_part_suffix = -*
34901   local_part_suffix_optional
34902   allow_filter
34903 .endd
34904 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34905 example, &_.forward-special_& is used. Once again, if the appropriate file
34906 does not exist, or does not deal with the address, it is passed on to
34907 subsequent routers, which could, if required, look for an unqualified
34908 &_.forward_& file to use as a default.
34909
34910
34911
34912 .section "Simplified vacation processing" "SECID244"
34913 .cindex "vacation processing"
34914 The traditional way of running the &'vacation'& program is for a user to set up
34915 a pipe command in a &_.forward_& file
34916 (see section &<<SECTspecitredli>>& for syntax details).
34917 This is prone to error by inexperienced users. There are two features of Exim
34918 that can be used to make this process simpler for users:
34919
34920 .ilist
34921 A local part prefix such as &"vacation-"& can be specified on a router which
34922 can cause the message to be delivered directly to the &'vacation'& program, or
34923 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34924 &_.forward_& file are then much simpler. For example:
34925 .code
34926 spqr, vacation-spqr
34927 .endd
34928 .next
34929 The &%require_files%& generic router option can be used to trigger a
34930 vacation delivery by checking for the existence of a certain file in the
34931 user's home directory. The &%unseen%& generic option should also be used, to
34932 ensure that the original delivery also proceeds. In this case, all the user has
34933 to do is to create a file called, say, &_.vacation_&, containing a vacation
34934 message.
34935 .endlist
34936
34937 Another advantage of both these methods is that they both work even when the
34938 use of arbitrary pipes by users is locked out.
34939
34940
34941
34942 .section "Taking copies of mail" "SECID245"
34943 .cindex "message" "copying every"
34944 Some installations have policies that require archive copies of all messages to
34945 be made. A single copy of each message can easily be taken by an appropriate
34946 command in a system filter, which could, for example, use a different file for
34947 each day's messages.
34948
34949 There is also a shadow transport mechanism that can be used to take copies of
34950 messages that are successfully delivered by local transports, one copy per
34951 delivery. This could be used, &'inter alia'&, to implement automatic
34952 notification of delivery by sites that insist on doing such things.
34953
34954
34955
34956 .section "Intermittently connected hosts" "SECID246"
34957 .cindex "intermittently connected hosts"
34958 It has become quite common (because it is cheaper) for hosts to connect to the
34959 Internet periodically rather than remain connected all the time. The normal
34960 arrangement is that mail for such hosts accumulates on a system that is
34961 permanently connected.
34962
34963 Exim was designed for use on permanently connected hosts, and so it is not
34964 particularly well-suited to use in an intermittently connected environment.
34965 Nevertheless there are some features that can be used.
34966
34967
34968 .section "Exim on the upstream server host" "SECID247"
34969 It is tempting to arrange for incoming mail for the intermittently connected
34970 host to remain on Exim's queue until the client connects. However, this
34971 approach does not scale very well. Two different kinds of waiting message are
34972 being mixed up in the same queue &-- those that cannot be delivered because of
34973 some temporary problem, and those that are waiting for their destination host
34974 to connect. This makes it hard to manage the queue, as well as wasting
34975 resources, because each queue runner scans the entire queue.
34976
34977 A better approach is to separate off those messages that are waiting for an
34978 intermittently connected host. This can be done by delivering these messages
34979 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34980 format, from where they are transmitted by other software when their
34981 destination connects. This makes it easy to collect all the mail for one host
34982 in a single directory, and to apply local timeout rules on a per-message basis
34983 if required.
34984
34985 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34986 you are doing this, you should configure Exim with a long retry period for the
34987 intermittent host. For example:
34988 .code
34989 cheshire.wonderland.fict.example    *   F,5d,24h
34990 .endd
34991 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34992 which messages it has queued up for that host. Once the intermittent host comes
34993 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34994 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34995 causes all the queued up messages to be delivered, often down a single SMTP
34996 connection. While the host remains connected, any new messages get delivered
34997 immediately.
34998
34999 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35000 issued with a different IP address each time it connects, Exim's retry
35001 mechanisms on the holding host get confused, because the IP address is normally
35002 used as part of the key string for holding retry information. This can be
35003 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35004 Since this has disadvantages for permanently connected hosts, it is best to
35005 arrange a separate transport for the intermittently connected ones.
35006
35007
35008
35009 .section "Exim on the intermittently connected client host" "SECID248"
35010 The value of &%smtp_accept_queue_per_connection%& should probably be
35011 increased, or even set to zero (that is, disabled) on the intermittently
35012 connected host, so that all incoming messages down a single connection get
35013 delivered immediately.
35014
35015 .cindex "SMTP" "passed connection"
35016 .cindex "SMTP" "multiple deliveries"
35017 .cindex "multiple SMTP deliveries"
35018 Mail waiting to be sent from an intermittently connected host will probably
35019 not have been routed, because without a connection DNS lookups are not
35020 possible. This means that if a normal queue run is done at connection time,
35021 each message is likely to be sent in a separate SMTP session. This can be
35022 avoided by starting the queue run with a command line option beginning with
35023 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35024 first pass, routing is done but no deliveries take place. The second pass is a
35025 normal queue run; since all the messages have been previously routed, those
35026 destined for the same host are likely to get sent as multiple deliveries in a
35027 single SMTP connection.
35028
35029
35030
35031 . ////////////////////////////////////////////////////////////////////////////
35032 . ////////////////////////////////////////////////////////////////////////////
35033
35034 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35035          "Exim as a non-queueing client"
35036 .cindex "client, non-queueing"
35037 .cindex "smart host" "suppressing queueing"
35038 On a personal computer, it is a common requirement for all
35039 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35040 configured to operate that way, for all the popular operating systems.
35041 However, there are some MUAs for Unix-like systems that cannot be so
35042 configured: they submit messages using the command line interface of
35043 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35044 messages this way.
35045
35046 If the personal computer runs continuously, there is no problem, because it can
35047 run a conventional MTA that handles delivery to the smart host, and deal with
35048 any delays via its queueing mechanism. However, if the computer does not run
35049 continuously or runs different operating systems at different times, queueing
35050 email is not desirable.
35051
35052 There is therefore a requirement for something that can provide the
35053 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35054 any queueing or retrying facilities. Furthermore, the delivery to the smart
35055 host should be synchronous, so that if it fails, the sending MUA is immediately
35056 informed. In other words, we want something that extends an MUA that submits
35057 to a local MTA via the command line so that it behaves like one that submits
35058 to a remote smart host using TCP/SMTP.
35059
35060 There are a number of applications (for example, there is one called &'ssmtp'&)
35061 that do this job. However, people have found them to be lacking in various
35062 ways. For instance, you might want to allow aliasing and forwarding to be done
35063 before sending a message to the smart host.
35064
35065 Exim already had the necessary infrastructure for doing this job. Just a few
35066 tweaks were needed to make it behave as required, though it is somewhat of an
35067 overkill to use a fully-featured MTA for this purpose.
35068
35069 .oindex "&%mua_wrapper%&"
35070 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35071 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35072 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35073 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35074 compatible router and transport configuration. Typically there will be just one
35075 router and one transport, sending everything to a smart host.
35076
35077 When run in MUA wrapping mode, the behaviour of Exim changes in the
35078 following ways:
35079
35080 .ilist
35081 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35082 In other words, the only way to submit messages is via the command line.
35083 .next
35084 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35085 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35086 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35087 does not finish until the delivery attempt is complete. If the delivery is
35088 successful, a zero return code is given.
35089 .next
35090 Address redirection is permitted, but the final routing for all addresses must
35091 be to the same remote transport, and to the same list of hosts. Furthermore,
35092 the return address (envelope sender) must be the same for all recipients, as
35093 must any added or deleted header lines. In other words, it must be possible to
35094 deliver the message in a single SMTP transaction, however many recipients there
35095 are.
35096 .next
35097 If these conditions are not met, or if routing any address results in a
35098 failure or defer status, or if Exim is unable to deliver all the recipients
35099 successfully to one of the smart hosts, delivery of the entire message fails.
35100 .next
35101 Because no queueing is allowed, all failures are treated as permanent; there
35102 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35103 smart host. Furthermore, because only a single yes/no response can be given to
35104 the caller, it is not possible to deliver to some recipients and not others. If
35105 there is an error (temporary or permanent) for any recipient, all are failed.
35106 .next
35107 If more than one smart host is listed, Exim will try another host after a
35108 connection failure or a timeout, in the normal way. However, if this kind of
35109 failure happens for all the hosts, the delivery fails.
35110 .next
35111 When delivery fails, an error message is written to the standard error stream
35112 (as well as to Exim's log), and Exim exits to the caller with a return code
35113 value 1. The message is expunged from Exim's spool files. No bounce messages
35114 are ever generated.
35115 .next
35116 No retry data is maintained, and any retry rules are ignored.
35117 .next
35118 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35119 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35120 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35121 .endlist
35122
35123 The overall effect is that Exim makes a single synchronous attempt to deliver
35124 the message, failing if there is any kind of problem. Because no local
35125 deliveries are done and no daemon can be run, Exim does not need root
35126 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35127 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35128 the advantages and disadvantages of running without root privilege.
35129
35130
35131
35132
35133 . ////////////////////////////////////////////////////////////////////////////
35134 . ////////////////////////////////////////////////////////////////////////////
35135
35136 .chapter "Log files" "CHAPlog"
35137 .scindex IIDloggen "log" "general description"
35138 .cindex "log" "types of"
35139 Exim writes three different logs, referred to as the main log, the reject log,
35140 and the panic log:
35141
35142 .ilist
35143 .cindex "main log"
35144 The main log records the arrival of each message and each delivery in a single
35145 line in each case. The format is as compact as possible, in an attempt to keep
35146 down the size of log files. Two-character flag sequences make it easy to pick
35147 out these lines. A number of other events are recorded in the main log. Some of
35148 them are optional, in which case the &%log_selector%& option controls whether
35149 they are included or not. A Perl script called &'eximstats'&, which does simple
35150 analysis of main log files, is provided in the Exim distribution (see section
35151 &<<SECTmailstat>>&).
35152 .next
35153 .cindex "reject log"
35154 The reject log records information from messages that are rejected as a result
35155 of a configuration option (that is, for policy reasons).
35156 The first line of each rejection is a copy of the line that is also written to
35157 the main log. Then, if the message's header has been read at the time the log
35158 is written, its contents are written to this log. Only the original header
35159 lines are available; header lines added by ACLs are not logged. You can use the
35160 reject log to check that your policy controls are working correctly; on a busy
35161 host this may be easier than scanning the main log for rejection messages. You
35162 can suppress the writing of the reject log by setting &%write_rejectlog%&
35163 false.
35164 .next
35165 .cindex "panic log"
35166 .cindex "system log"
35167 When certain serious errors occur, Exim writes entries to its panic log. If the
35168 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35169 are usually written to the main log as well, but can get lost amid the mass of
35170 other entries. The panic log should be empty under normal circumstances. It is
35171 therefore a good idea to check it (or to have a &'cron'& script check it)
35172 regularly, in order to become aware of any problems. When Exim cannot open its
35173 panic log, it tries as a last resort to write to the system log (syslog). This
35174 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35175 message itself is written at priority LOG_CRIT.
35176 .endlist
35177
35178 Every log line starts with a timestamp, in the format shown in the following
35179 example. Note that many of the examples shown in this chapter are line-wrapped.
35180 In the log file, this would be all on one line:
35181 .code
35182 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35183   by QUIT
35184 .endd
35185 By default, the timestamps are in the local timezone. There are two
35186 ways of changing this:
35187
35188 .ilist
35189 You can set the &%timezone%& option to a different time zone; in particular, if
35190 you set
35191 .code
35192 timezone = UTC
35193 .endd
35194 the timestamps will be in UTC (aka GMT).
35195 .next
35196 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35197 example:
35198 .code
35199 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35200 .endd
35201 .endlist
35202
35203 .cindex "log" "process ids in"
35204 .cindex "pid (process id)" "in log lines"
35205 Exim does not include its process id in log lines by default, but you can
35206 request that it does so by specifying the &`pid`& log selector (see section
35207 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35208 brackets, immediately after the time and date.
35209
35210
35211
35212
35213 .section "Where the logs are written" "SECTwhelogwri"
35214 .cindex "log" "destination"
35215 .cindex "log" "to file"
35216 .cindex "log" "to syslog"
35217 .cindex "syslog"
35218 The logs may be written to local files, or to syslog, or both. However, it
35219 should be noted that many syslog implementations use UDP as a transport, and
35220 are therefore unreliable in the sense that messages are not guaranteed to
35221 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35222 It has also been reported that on large log files (tens of megabytes) you may
35223 need to tweak syslog to prevent it syncing the file with each write &-- on
35224 Linux this has been seen to make syslog take 90% plus of CPU time.
35225
35226 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35227 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35228 configuration. This latter string is expanded, so it can contain, for example,
35229 references to the host name:
35230 .code
35231 log_file_path = /var/log/$primary_hostname/exim_%slog
35232 .endd
35233 It is generally advisable, however, to set the string in &_Local/Makefile_&
35234 rather than at run time, because then the setting is available right from the
35235 start of Exim's execution. Otherwise, if there's something it wants to log
35236 before it has read the configuration file (for example, an error in the
35237 configuration file) it will not use the path you want, and may not be able to
35238 log at all.
35239
35240 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35241 list, currently limited to at most two items. This is one option where the
35242 facility for changing a list separator may not be used. The list must always be
35243 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35244 otherwise the item must either be an absolute path, containing &`%s`& at the
35245 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35246 implying the use of a default path.
35247
35248 When Exim encounters an empty item in the list, it searches the list defined by
35249 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35250 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35251 mean &"use the path specified at build time"&. It no such item exists, log
35252 files are written in the &_log_& subdirectory of the spool directory. This is
35253 equivalent to the setting:
35254 .code
35255 log_file_path = $spool_directory/log/%slog
35256 .endd
35257 If you do not specify anything at build time or run time,
35258 or if you unset the option at run time (i.e. &`log_file_path = `&),
35259 that is where the logs are written.
35260
35261 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35262 are in use &-- see section &<<SECTdatlogfil>>& below.
35263
35264 Here are some examples of possible settings:
35265 .display
35266 &`LOG_FILE_PATH=syslog                    `& syslog only
35267 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35268 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35269 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35270 .endd
35271 If there are more than two paths in the list, the first is used and a panic
35272 error is logged.
35273
35274
35275
35276 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35277 .cindex "log" "cycling local files"
35278 .cindex "cycling logs"
35279 .cindex "&'exicyclog'&"
35280 .cindex "log" "local files; writing to"
35281 Some operating systems provide centralized and standardized methods for cycling
35282 log files. For those that do not, a utility script called &'exicyclog'& is
35283 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35284 main and reject logs each time it is called. The maximum number of old logs to
35285 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35286
35287 An Exim delivery process opens the main log when it first needs to write to it,
35288 and it keeps the file open in case subsequent entries are required &-- for
35289 example, if a number of different deliveries are being done for the same
35290 message. However, remote SMTP deliveries can take a long time, and this means
35291 that the file may be kept open long after it is renamed if &'exicyclog'& or
35292 something similar is being used to rename log files on a regular basis. To
35293 ensure that a switch of log files is noticed as soon as possible, Exim calls
35294 &[stat()]& on the main log's name before reusing an open file, and if the file
35295 does not exist, or its inode has changed, the old file is closed and Exim
35296 tries to open the main log from scratch. Thus, an old log file may remain open
35297 for quite some time, but no Exim processes should write to it once it has been
35298 renamed.
35299
35300
35301
35302 .section "Datestamped log files" "SECTdatlogfil"
35303 .cindex "log" "datestamped files"
35304 Instead of cycling the main and reject log files by renaming them
35305 periodically, some sites like to use files whose names contain a datestamp,
35306 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35307 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35308 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35309 point where the datestamp is required. For example:
35310 .code
35311 log_file_path = /var/spool/exim/log/%slog-%D
35312 log_file_path = /var/log/exim-%s-%D.log
35313 log_file_path = /var/spool/exim/log/%D-%slog
35314 log_file_path = /var/log/exim/%s.%M
35315 .endd
35316 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35317 examples of names generated by the above examples:
35318 .code
35319 /var/spool/exim/log/mainlog-20021225
35320 /var/log/exim-reject-20021225.log
35321 /var/spool/exim/log/20021225-mainlog
35322 /var/log/exim/main.200212
35323 .endd
35324 When this form of log file is specified, Exim automatically switches to new
35325 files at midnight. It does not make any attempt to compress old logs; you
35326 will need to write your own script if you require this. You should not
35327 run &'exicyclog'& with this form of logging.
35328
35329 The location of the panic log is also determined by &%log_file_path%&, but it
35330 is not datestamped, because rotation of the panic log does not make sense.
35331 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35332 the string. In addition, if it immediately follows a slash, a following
35333 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35334 character is removed. Thus, the four examples above would give these panic
35335 log names:
35336 .code
35337 /var/spool/exim/log/paniclog
35338 /var/log/exim-panic.log
35339 /var/spool/exim/log/paniclog
35340 /var/log/exim/panic
35341 .endd
35342
35343
35344 .section "Logging to syslog" "SECID249"
35345 .cindex "log" "syslog; writing to"
35346 The use of syslog does not change what Exim logs or the format of its messages,
35347 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35348 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35349 that, the same strings are written to syslog as to log files. The syslog
35350 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35351 by default, but you can change these by setting the &%syslog_facility%& and
35352 &%syslog_processname%& options, respectively. If Exim was compiled with
35353 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35354 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35355 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35356 the time and host name to each line.
35357 The three log streams are mapped onto syslog priorities as follows:
35358
35359 .ilist
35360 &'mainlog'& is mapped to LOG_INFO
35361 .next
35362 &'rejectlog'& is mapped to LOG_NOTICE
35363 .next
35364 &'paniclog'& is mapped to LOG_ALERT
35365 .endlist
35366
35367 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35368 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35369 these are routed by syslog to the same place. You can suppress this duplication
35370 by setting &%syslog_duplication%& false.
35371
35372 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35373 entries contain multiple lines when headers are included. To cope with both
35374 these cases, entries written to syslog are split into separate &[syslog()]&
35375 calls at each internal newline, and also after a maximum of
35376 870 data characters. (This allows for a total syslog line length of 1024, when
35377 additions such as timestamps are added.) If you are running a syslog
35378 replacement that can handle lines longer than the 1024 characters allowed by
35379 RFC 3164, you should set
35380 .code
35381 SYSLOG_LONG_LINES=yes
35382 .endd
35383 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35384 lines, but it still splits at internal newlines in &'reject'& log entries.
35385
35386 To make it easy to re-assemble split lines later, each component of a split
35387 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35388 where <&'n'&> is the component number and <&'m'&> is the total number of
35389 components in the entry. The / delimiter is used when the line was split
35390 because it was too long; if it was split because of an internal newline, the \
35391 delimiter is used. For example, supposing the length limit to be 50 instead of
35392 870, the following would be the result of a typical rejection message to
35393 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35394 name, and pid as added by syslog:
35395 .code
35396 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35397 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35398 [3/5]  when scanning for sender: missing or malformed lo
35399 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35400 [5/5] mple>)
35401 .endd
35402 The same error might cause the following lines to be written to &"rejectlog"&
35403 (LOG_NOTICE):
35404 .code
35405 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35406 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35407 [3/18] er when scanning for sender: missing or malformed
35408 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35409 [5\18] .example>)
35410 [6\18] Recipients: ph10@some.domain.cam.example
35411 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35412 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35413 [9\18]        id 16RdAL-0006pc-00
35414 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35415 [11\18] 09:43 +0100
35416 [12\18] F From: <>
35417 [13\18]   Subject: this is a test header
35418 [18\18]   X-something: this is another header
35419 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35420 [16\18] le>
35421 [17\18] B Bcc:
35422 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35423 .endd
35424 Log lines that are neither too long nor contain newlines are written to syslog
35425 without modification.
35426
35427 If only syslog is being used, the Exim monitor is unable to provide a log tail
35428 display, unless syslog is routing &'mainlog'& to a file on the local host and
35429 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35430 where it is.
35431
35432
35433
35434 .section "Log line flags" "SECID250"
35435 One line is written to the main log for each message received, and for each
35436 successful, unsuccessful, and delayed delivery. These lines can readily be
35437 picked out by the distinctive two-character flags that immediately follow the
35438 timestamp. The flags are:
35439 .display
35440 &`<=`&     message arrival
35441 &`=>`&     normal message delivery
35442 &`->`&     additional address in same delivery
35443 &`>>`&     cutthrough message delivery
35444 &`*>`&     delivery suppressed by &%-N%&
35445 &`**`&     delivery failed; address bounced
35446 &`==`&     delivery deferred; temporary problem
35447 .endd
35448
35449
35450 .section "Logging message reception" "SECID251"
35451 .cindex "log" "reception line"
35452 The format of the single-line entry in the main log that is written for every
35453 message received is shown in the basic example below, which is split over
35454 several lines in order to fit it on the page:
35455 .code
35456 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35457   H=mailer.fict.example [192.168.123.123] U=exim
35458   P=smtp S=5678 id=<incoming message id>
35459 .endd
35460 The address immediately following &"<="& is the envelope sender address. A
35461 bounce message is shown with the sender address &"<>"&, and if it is locally
35462 generated, this is followed by an item of the form
35463 .code
35464 R=<message id>
35465 .endd
35466 which is a reference to the message that caused the bounce to be sent.
35467
35468 .cindex "HELO"
35469 .cindex "EHLO"
35470 For messages from other hosts, the H and U fields identify the remote host and
35471 record the RFC 1413 identity of the user that sent the message, if one was
35472 received. The number given in square brackets is the IP address of the sending
35473 host. If there is a single, unparenthesized  host name in the H field, as
35474 above, it has been verified to correspond to the IP address (see the
35475 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35476 by the remote host in the SMTP HELO or EHLO command, and has not been
35477 verified. If verification yields a different name to that given for HELO or
35478 EHLO, the verified name appears first, followed by the HELO or EHLO
35479 name in parentheses.
35480
35481 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35482 without brackets, in the HELO or EHLO command, leading to entries in
35483 the log containing text like these examples:
35484 .code
35485 H=(10.21.32.43) [192.168.8.34]
35486 H=([10.21.32.43]) [192.168.8.34]
35487 .endd
35488 This can be confusing. Only the final address in square brackets can be relied
35489 on.
35490
35491 For locally generated messages (that is, messages not received over TCP/IP),
35492 the H field is omitted, and the U field contains the login name of the caller
35493 of Exim.
35494
35495 .cindex "authentication" "logging"
35496 .cindex "AUTH" "logging"
35497 For all messages, the P field specifies the protocol used to receive the
35498 message. This is the value that is stored in &$received_protocol$&. In the case
35499 of incoming SMTP messages, the value indicates whether or not any SMTP
35500 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35501 session was encrypted, there is an additional X field that records the cipher
35502 suite that was used.
35503
35504 .cindex log protocol
35505 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35506 hosts that have authenticated themselves using the SMTP AUTH command. The first
35507 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35508 there is an additional item A= followed by the name of the authenticator that
35509 was used. If an authenticated identification was set up by the authenticator's
35510 &%server_set_id%& option, this is logged too, separated by a colon from the
35511 authenticator name.
35512
35513 .cindex "size" "of message"
35514 The id field records the existing message id, if present. The size of the
35515 received message is given by the S field. When the message is delivered,
35516 headers may be removed or added, so that the size of delivered copies of the
35517 message may not correspond with this value (and indeed may be different to each
35518 other).
35519
35520 The &%log_selector%& option can be used to request the logging of additional
35521 data when a message is received. See section &<<SECTlogselector>>& below.
35522
35523
35524
35525 .section "Logging deliveries" "SECID252"
35526 .cindex "log" "delivery line"
35527 The format of the single-line entry in the main log that is written for every
35528 delivery is shown in one of the examples below, for local and remote
35529 deliveries, respectively. Each example has been split into multiple lines in order
35530 to fit it on the page:
35531 .code
35532 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35533   <marv@hitch.fict.example> R=localuser T=local_delivery
35534 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35535   monk@holistic.fict.example R=dnslookup T=remote_smtp
35536   H=holistic.fict.example [192.168.234.234]
35537 .endd
35538 For ordinary local deliveries, the original address is given in angle brackets
35539 after the final delivery address, which might be a pipe or a file. If
35540 intermediate address(es) exist between the original and the final address, the
35541 last of these is given in parentheses after the final address. The R and T
35542 fields record the router and transport that were used to process the address.
35543
35544 If SMTP AUTH was used for the delivery there is an additional item A=
35545 followed by the name of the authenticator that was used.
35546 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35547 option, this is logged too, separated by a colon from the authenticator name.
35548
35549 If a shadow transport was run after a successful local delivery, the log line
35550 for the successful delivery has an item added on the end, of the form
35551 .display
35552 &`ST=<`&&'shadow transport name'&&`>`&
35553 .endd
35554 If the shadow transport did not succeed, the error message is put in
35555 parentheses afterwards.
35556
35557 .cindex "asterisk" "after IP address"
35558 When more than one address is included in a single delivery (for example, two
35559 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35560 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35561 down a single SMTP connection, an asterisk follows the IP address in the log
35562 lines for the second and subsequent messages.
35563
35564 .cindex "delivery" "cutthrough; logging"
35565 .cindex "cutthrough" "logging"
35566 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35567 line precedes the reception line, since cutthrough waits for a possible
35568 rejection from the destination in case it can reject the sourced item.
35569
35570 The generation of a reply message by a filter file gets logged as a
35571 &"delivery"& to the addressee, preceded by &">"&.
35572
35573 The &%log_selector%& option can be used to request the logging of additional
35574 data when a message is delivered. See section &<<SECTlogselector>>& below.
35575
35576
35577 .section "Discarded deliveries" "SECID253"
35578 .cindex "discarded messages"
35579 .cindex "message" "discarded"
35580 .cindex "delivery" "discarded; logging"
35581 When a message is discarded as a result of the command &"seen finish"& being
35582 obeyed in a filter file which generates no deliveries, a log entry of the form
35583 .code
35584 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35585   <low.club@bridge.example> R=userforward
35586 .endd
35587 is written, to record why no deliveries are logged. When a message is discarded
35588 because it is aliased to &":blackhole:"& the log line is like this:
35589 .code
35590 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35591   <hole@nowhere.example> R=blackhole_router
35592 .endd
35593
35594
35595 .section "Deferred deliveries" "SECID254"
35596 When a delivery is deferred, a line of the following form is logged:
35597 .code
35598 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35599   R=dnslookup T=smtp defer (146): Connection refused
35600 .endd
35601 In the case of remote deliveries, the error is the one that was given for the
35602 last IP address that was tried. Details of individual SMTP failures are also
35603 written to the log, so the above line would be preceded by something like
35604 .code
35605 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35606   mail1.endrest.example [192.168.239.239]: Connection refused
35607 .endd
35608 When a deferred address is skipped because its retry time has not been reached,
35609 a message is written to the log, but this can be suppressed by setting an
35610 appropriate value in &%log_selector%&.
35611
35612
35613
35614 .section "Delivery failures" "SECID255"
35615 .cindex "delivery" "failure; logging"
35616 If a delivery fails because an address cannot be routed, a line of the
35617 following form is logged:
35618 .code
35619 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35620   <jim@trek99.example>: unknown mail domain
35621 .endd
35622 If a delivery fails at transport time, the router and transport are shown, and
35623 the response from the remote host is included, as in this example:
35624 .code
35625 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35626   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35627   after pipelined RCPT TO:<ace400@pb.example>: host
35628   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35629   <ace400@pb.example>...Addressee unknown
35630 .endd
35631 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35632 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35633 disabling PIPELINING. The log lines for all forms of delivery failure are
35634 flagged with &`**`&.
35635
35636
35637
35638 .section "Fake deliveries" "SECID256"
35639 .cindex "delivery" "fake; logging"
35640 If a delivery does not actually take place because the &%-N%& option has been
35641 used to suppress it, a normal delivery line is written to the log, except that
35642 &"=>"& is replaced by &"*>"&.
35643
35644
35645
35646 .section "Completion" "SECID257"
35647 A line of the form
35648 .code
35649 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35650 .endd
35651 is written to the main log when a message is about to be removed from the spool
35652 at the end of its processing.
35653
35654
35655
35656
35657 .section "Summary of Fields in Log Lines" "SECID258"
35658 .cindex "log" "summary of fields"
35659 A summary of the field identifiers that are used in log lines is shown in
35660 the following table:
35661 .display
35662 &`A   `&        authenticator name (and optional id and sender)
35663 &`C   `&        SMTP confirmation on delivery
35664 &`    `&        command list for &"no mail in SMTP session"&
35665 &`CV  `&        certificate verification status
35666 &`D   `&        duration of &"no mail in SMTP session"&
35667 &`DN  `&        distinguished name from peer certificate
35668 &`DT  `&        on &`=>`& lines: time taken for a delivery
35669 &`F   `&        sender address (on delivery lines)
35670 &`H   `&        host name and IP address
35671 &`I   `&        local interface used
35672 &`id  `&        message id for incoming message
35673 &`P   `&        on &`<=`& lines: protocol used
35674 &`    `&        on &`=>`& and &`**`& lines: return path
35675 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35676 &`QT  `&        on &`=>`& lines: time spent on queue so far
35677 &`    `&        on &"Completed"& lines: time spent on queue
35678 &`R   `&        on &`<=`& lines: reference for local bounce
35679 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35680 &`S   `&        size of message in bytes
35681 &`SNI `&        server name indication from TLS client hello
35682 &`ST  `&        shadow transport name
35683 &`T   `&        on &`<=`& lines: message subject (topic)
35684 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35685 &`U   `&        local user or RFC 1413 identity
35686 &`X   `&        TLS cipher suite
35687 .endd
35688
35689
35690 .section "Other log entries" "SECID259"
35691 Various other types of log entry are written from time to time. Most should be
35692 self-explanatory. Among the more common are:
35693
35694 .ilist
35695 .cindex "retry" "time not reached"
35696 &'retry time not reached'&&~&~An address previously suffered a temporary error
35697 during routing or local delivery, and the time to retry has not yet arrived.
35698 This message is not written to an individual message log file unless it happens
35699 during the first delivery attempt.
35700 .next
35701 &'retry time not reached for any host'&&~&~An address previously suffered
35702 temporary errors during remote delivery, and the retry time has not yet arrived
35703 for any of the hosts to which it is routed.
35704 .next
35705 .cindex "spool directory" "file locked"
35706 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35707 some other Exim process is already working on the message. This can be quite
35708 common if queue running processes are started at frequent intervals. The
35709 &'exiwhat'& utility script can be used to find out what Exim processes are
35710 doing.
35711 .next
35712 .cindex "error" "ignored"
35713 &'error ignored'&&~&~There are several circumstances that give rise to this
35714 message:
35715 .olist
35716 Exim failed to deliver a bounce message whose age was greater than
35717 &%ignore_bounce_errors_after%&. The bounce was discarded.
35718 .next
35719 A filter file set up a delivery using the &"noerror"& option, and the delivery
35720 failed. The delivery was discarded.
35721 .next
35722 A delivery set up by a router configured with
35723 . ==== As this is a nested list, any displays it contains must be indented
35724 . ==== as otherwise they are too far to the left.
35725 .code
35726     errors_to = <>
35727 .endd
35728 failed. The delivery was discarded.
35729 .endlist olist
35730 .endlist ilist
35731
35732
35733
35734
35735
35736 .section "Reducing or increasing what is logged" "SECTlogselector"
35737 .cindex "log" "selectors"
35738 By setting the &%log_selector%& global option, you can disable some of Exim's
35739 default logging, or you can request additional logging. The value of
35740 &%log_selector%& is made up of names preceded by plus or minus characters. For
35741 example:
35742 .code
35743 log_selector = +arguments -retry_defer
35744 .endd
35745 The list of optional log items is in the following table, with the default
35746 selection marked by asterisks:
35747 .display
35748 &` 8bitmime                   `&  received 8BITMIME status
35749 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35750 &` address_rewrite            `&  address rewriting
35751 &` all_parents                `&  all parents in => lines
35752 &` arguments                  `&  command line arguments
35753 &`*connection_reject          `&  connection rejections
35754 &`*delay_delivery             `&  immediate delivery delayed
35755 &` deliver_time               `&  time taken to perform delivery
35756 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35757 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35758 &`*etrn                       `&  ETRN commands
35759 &`*host_lookup_failed         `&  as it says
35760 &` ident_timeout              `&  timeout for ident connection
35761 &` incoming_interface         `&  local interface on <= and => lines
35762 &` incoming_port              `&  remote port on <= lines
35763 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35764 .new
35765 &` outgoing_interface         `&  local interface on => lines
35766 .wen
35767 &` outgoing_port              `&  add remote port to => lines
35768 &`*queue_run                  `&  start and end queue runs
35769 &` queue_time                 `&  time on queue for one recipient
35770 &` queue_time_overall         `&  time on queue for whole message
35771 &` pid                        `&  Exim process id
35772 .new
35773 &` proxy                      `&  proxy address on <= and => lines
35774 .wen
35775 &` received_recipients        `&  recipients on <= lines
35776 &` received_sender            `&  sender on <= lines
35777 &`*rejected_header            `&  header contents on reject log
35778 &`*retry_defer                `&  &"retry time not reached"&
35779 &` return_path_on_delivery    `&  put return path on => and ** lines
35780 &` sender_on_delivery         `&  add sender to => lines
35781 &`*sender_verify_fail         `&  sender verification failures
35782 &`*size_reject                `&  rejection because too big
35783 &`*skip_delivery              `&  delivery skipped in a queue run
35784 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35785 &` smtp_connection            `&  incoming SMTP connections
35786 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35787 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35788 &` smtp_no_mail               `&  session with no MAIL commands
35789 &` smtp_protocol_error        `&  SMTP protocol errors
35790 &` smtp_syntax_error          `&  SMTP syntax errors
35791 &` subject                    `&  contents of &'Subject:'& on <= lines
35792 &`*tls_certificate_verified   `&  certificate verification status
35793 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35794 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35795 &` tls_sni                    `&  TLS SNI on <= lines
35796 &` unknown_in_list            `&  DNS lookup failed in list match
35797
35798 &` all                        `&  all of the above
35799 .endd
35800 See also the &%slow_lookup_log%& main configuration option,
35801 section &<<SECID99>>&
35802
35803 More details on each of these items follows:
35804
35805 .ilist
35806 .cindex "8BITMIME"
35807 .cindex "log" "8BITMIME"
35808 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35809 which may help in tracking down interoperability issues with ancient MTAs
35810 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35811 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35812 &`7BIT`& and &`8BITMIME`& respectively.
35813 .next
35814 .cindex "&%warn%& ACL verb" "log when skipping"
35815 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35816 its conditions cannot be evaluated, a log line to this effect is written if
35817 this log selector is set.
35818 .next
35819 .cindex "log" "rewriting"
35820 .cindex "rewriting" "logging"
35821 &%address_rewrite%&: This applies both to global rewrites and per-transport
35822 rewrites, but not to rewrites in filters run as an unprivileged user (because
35823 such users cannot access the log).
35824 .next
35825 .cindex "log" "full parentage"
35826 &%all_parents%&: Normally only the original and final addresses are logged on
35827 delivery lines; with this selector, intermediate parents are given in
35828 parentheses between them.
35829 .next
35830 .cindex "log" "Exim arguments"
35831 .cindex "Exim arguments, logging"
35832 &%arguments%&: This causes Exim to write the arguments with which it was called
35833 to the main log, preceded by the current working directory. This is a debugging
35834 feature, added to make it easier to find out how certain MUAs call
35835 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35836 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35837 that are empty or that contain white space are quoted. Non-printing characters
35838 are shown as escape sequences. This facility cannot log unrecognized arguments,
35839 because the arguments are checked before the configuration file is read. The
35840 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35841 between the caller and Exim.
35842 .next
35843 .cindex "log" "connection rejections"
35844 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35845 connection is rejected, for whatever reason.
35846 .next
35847 .cindex "log" "delayed delivery"
35848 .cindex "delayed delivery, logging"
35849 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35850 started for an incoming message because the load is too high or too many
35851 messages were received on one connection. Logging does not occur if no delivery
35852 process is started because &%queue_only%& is set or &%-odq%& was used.
35853 .next
35854 .cindex "log" "delivery duration"
35855 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35856 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35857 .next
35858 .cindex "log" "message size on delivery"
35859 .cindex "size" "of message"
35860 &%delivery_size%&: For each delivery, the size of message delivered is added to
35861 the &"=>"& line, tagged with S=.
35862 .next
35863 .cindex "log" "dnslist defer"
35864 .cindex "DNS list" "logging defer"
35865 .cindex "black list (DNS)"
35866 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35867 DNS black list suffers a temporary error.
35868 .next
35869 .cindex "log" "ETRN commands"
35870 .cindex "ETRN" "logging"
35871 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35872 is run to determine whether or not it is actually accepted. An invalid ETRN
35873 command, or one received within a message transaction is not logged by this
35874 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35875 .next
35876 .cindex "log" "host lookup failure"
35877 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35878 any addresses, or when a lookup of an IP address fails to find a host name, a
35879 log line is written. This logging does not apply to direct DNS lookups when
35880 routing email addresses, but it does apply to &"byname"& lookups.
35881 .next
35882 .cindex "log" "ident timeout"
35883 .cindex "RFC 1413" "logging timeout"
35884 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35885 client's ident port times out.
35886 .next
35887 .cindex "log" "incoming interface"
35888 .cindex "log" "local interface"
35889 .cindex "log" "local address and port"
35890 .cindex "TCP/IP" "logging local address and port"
35891 .cindex "interface" "logging"
35892 &%incoming_interface%&: The interface on which a message was received is added
35893 to the &"<="& line as an IP address in square brackets, tagged by I= and
35894 followed by a colon and the port number. The local interface and port are also
35895 added to other SMTP log lines, for example &"SMTP connection from"&, to
35896 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35897 .new
35898 The latter can be disabled by turning off the &%outgoing_interface%& option.
35899 .wen
35900 .next
35901 .new
35902 .cindex log "incoming proxy address"
35903 .cindex proxy "logging proxy address"
35904 .cindex "TCP/IP" "logging proxy address"
35905 &%proxy%&: The internal (closest to the system running Exim) IP address
35906 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35907 on a proxied connection
35908 or the &"=>"& line for a message delivered on a proxied connection..
35909 See &<<SECTproxyInbound>>& for more information.
35910 .wen
35911 .next
35912 .cindex "log" "incoming remote port"
35913 .cindex "port" "logging remote"
35914 .cindex "TCP/IP" "logging incoming remote port"
35915 .vindex "&$sender_fullhost$&"
35916 .vindex "&$sender_rcvhost$&"
35917 &%incoming_port%&: The remote port number from which a message was received is
35918 added to log entries and &'Received:'& header lines, following the IP address
35919 in square brackets, and separated from it by a colon. This is implemented by
35920 changing the value that is put in the &$sender_fullhost$& and
35921 &$sender_rcvhost$& variables. Recording the remote port number has become more
35922 important with the widening use of NAT (see RFC 2505).
35923 .next
35924 .cindex "log" "dropped connection"
35925 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35926 connection is unexpectedly dropped.
35927 .next
35928 .cindex "log" "outgoing interface"
35929 .cindex "log" "local interface"
35930 .cindex "log" "local address and port"
35931 .cindex "TCP/IP" "logging local address and port"
35932 .cindex "interface" "logging"
35933 .new
35934 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35935 interface on which a message was sent is added to delivery lines as an I= tag
35936 followed by IP address in square brackets. You can disable this by turning
35937 off the &%outgoing_interface%& option.
35938 .wen
35939 .next
35940 .cindex "log" "outgoing remote port"
35941 .cindex "port" "logging outgoint remote"
35942 .cindex "TCP/IP" "logging ougtoing remote port"
35943 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35944 containing => tags) following the IP address.
35945 .new
35946 The local port is also added if &%incoming_interface%& and
35947 &%outgoing_interface%& are both enabled.
35948 .wen
35949 This option is not included in the default setting, because for most ordinary
35950 configurations, the remote port number is always 25 (the SMTP port), and the
35951 local port is a random ephemeral port.
35952 .next
35953 .cindex "log" "process ids in"
35954 .cindex "pid (process id)" "in log lines"
35955 &%pid%&: The current process id is added to every log line, in square brackets,
35956 immediately after the time and date.
35957 .next
35958 .cindex "log" "queue run"
35959 .cindex "queue runner" "logging"
35960 &%queue_run%&: The start and end of every queue run are logged.
35961 .next
35962 .cindex "log" "queue time"
35963 &%queue_time%&: The amount of time the message has been in the queue on the
35964 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35965 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35966 includes reception time as well as the delivery time for the current address.
35967 This means that it may be longer than the difference between the arrival and
35968 delivery log line times, because the arrival log line is not written until the
35969 message has been successfully received.
35970 .next
35971 &%queue_time_overall%&: The amount of time the message has been in the queue on
35972 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35973 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35974 message, so it includes reception time as well as the total delivery time.
35975 .next
35976 .cindex "log" "recipients"
35977 &%received_recipients%&: The recipients of a message are listed in the main log
35978 as soon as the message is received. The list appears at the end of the log line
35979 that is written when a message is received, preceded by the word &"for"&. The
35980 addresses are listed after they have been qualified, but before any rewriting
35981 has taken place.
35982 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35983 in the list.
35984 .next
35985 .cindex "log" "sender reception"
35986 &%received_sender%&: The unrewritten original sender of a message is added to
35987 the end of the log line that records the message's arrival, after the word
35988 &"from"& (before the recipients if &%received_recipients%& is also set).
35989 .next
35990 .cindex "log" "header lines for rejection"
35991 &%rejected_header%&: If a message's header has been received at the time a
35992 rejection is written to the reject log, the complete header is added to the
35993 log. Header logging can be turned off individually for messages that are
35994 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35995 .next
35996 .cindex "log" "retry defer"
35997 &%retry_defer%&: A log line is written if a delivery is deferred because a
35998 retry time has not yet been reached. However, this &"retry time not reached"&
35999 message is always omitted from individual message logs after the first delivery
36000 attempt.
36001 .next
36002 .cindex "log" "return path"
36003 &%return_path_on_delivery%&: The return path that is being transmitted with
36004 the message is included in delivery and bounce lines, using the tag P=.
36005 This is omitted if no delivery actually happens, for example, if routing fails,
36006 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36007 .next
36008 .cindex "log" "sender on delivery"
36009 &%sender_on_delivery%&: The message's sender address is added to every delivery
36010 and bounce line, tagged by F= (for &"from"&).
36011 This is the original sender that was received with the message; it is not
36012 necessarily the same as the outgoing return path.
36013 .next
36014 .cindex "log" "sender verify failure"
36015 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36016 gives details of a sender verification failure is not written. Log lines for
36017 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36018 detail is lost.
36019 .next
36020 .cindex "log" "size rejection"
36021 &%size_reject%&: A log line is written whenever a message is rejected because
36022 it is too big.
36023 .next
36024 .cindex "log" "frozen messages; skipped"
36025 .cindex "frozen messages" "logging skipping"
36026 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36027 queue run because it is frozen or because another process is already delivering
36028 it.
36029 .cindex "&""spool file is locked""&"
36030 The message that is written is &"spool file is locked"&.
36031 .next
36032 .cindex "log" "smtp confirmation"
36033 .cindex "SMTP" "logging confirmation"
36034 .cindex "LMTP" "logging confirmation"
36035 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36036 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36037 A number of MTAs (including Exim) return an identifying string in this
36038 response.
36039 .next
36040 .cindex "log" "SMTP connections"
36041 .cindex "SMTP" "logging connections"
36042 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36043 established or closed, unless the connection is from a host that matches
36044 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36045 only when the closure is unexpected.) This applies to connections from local
36046 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36047 dropped in the middle of a message, a log line is always written, whether or
36048 not this selector is set, but otherwise nothing is written at the start and end
36049 of connections unless this selector is enabled.
36050
36051 For TCP/IP connections to an Exim daemon, the current number of connections is
36052 included in the log message for each new connection, but note that the count is
36053 reset if the daemon is restarted.
36054 Also, because connections are closed (and the closure is logged) in
36055 subprocesses, the count may not include connections that have been closed but
36056 whose termination the daemon has not yet noticed. Thus, while it is possible to
36057 match up the opening and closing of connections in the log, the value of the
36058 logged counts may not be entirely accurate.
36059 .next
36060 .cindex "log" "SMTP transaction; incomplete"
36061 .cindex "SMTP" "logging incomplete transactions"
36062 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36063 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36064 and the message sender plus any accepted recipients are included in the log
36065 line. This can provide evidence of dictionary attacks.
36066 .next
36067 .cindex "log" "non-MAIL SMTP sessions"
36068 .cindex "MAIL" "logging session without"
36069 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36070 connection terminates without having issued a MAIL command. This includes both
36071 the case when the connection is dropped, and the case when QUIT is used. It
36072 does not include cases where the connection is rejected right at the start (by
36073 an ACL, or because there are too many connections, or whatever). These cases
36074 already have their own log lines.
36075
36076 The log line that is written contains the identity of the client in the usual
36077 way, followed by D= and a time, which records the duration of the connection.
36078 If the connection was authenticated, this fact is logged exactly as it is for
36079 an incoming message, with an A= item. If the connection was encrypted, CV=,
36080 DN=, and X= items may appear as they do for an incoming message, controlled by
36081 the same logging options.
36082
36083 Finally, if any SMTP commands were issued during the connection, a C= item
36084 is added to the line, listing the commands that were used. For example,
36085 .code
36086 C=EHLO,QUIT
36087 .endd
36088 shows that the client issued QUIT straight after EHLO. If there were fewer
36089 than 20 commands, they are all listed. If there were more than 20 commands,
36090 the last 20 are listed, preceded by &"..."&. However, with the default
36091 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36092 have been aborted before 20 non-mail commands are processed.
36093 .next
36094 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36095 colon-separated, is appended to the A= item for a message arrival or delivery
36096 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36097 was accepted or used.
36098 .next
36099 .cindex "log" "SMTP protocol error"
36100 .cindex "SMTP" "logging protocol error"
36101 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36102 encountered. Exim does not have perfect detection of all protocol errors
36103 because of transmission delays and the use of pipelining. If PIPELINING has
36104 been advertised to a client, an Exim server assumes that the client will use
36105 it, and therefore it does not count &"expected"& errors (for example, RCPT
36106 received after rejecting MAIL) as protocol errors.
36107 .next
36108 .cindex "SMTP" "logging syntax errors"
36109 .cindex "SMTP" "syntax errors; logging"
36110 .cindex "SMTP" "unknown command; logging"
36111 .cindex "log" "unknown SMTP command"
36112 .cindex "log" "SMTP syntax error"
36113 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36114 encountered. An unrecognized command is treated as a syntax error. For an
36115 external connection, the host identity is given; for an internal connection
36116 using &%-bs%& the sender identification (normally the calling user) is given.
36117 .next
36118 .cindex "log" "subject"
36119 .cindex "subject, logging"
36120 &%subject%&: The subject of the message is added to the arrival log line,
36121 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36122 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36123 specifies whether characters with values greater than 127 should be logged
36124 unchanged, or whether they should be rendered as escape sequences.
36125 .next
36126 .cindex "log" "certificate verification"
36127 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36128 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36129 verified, and &`CV=no`& if not.
36130 .next
36131 .cindex "log" "TLS cipher"
36132 .cindex "TLS" "logging cipher"
36133 &%tls_cipher%&: When a message is sent or received over an encrypted
36134 connection, the cipher suite used is added to the log line, preceded by X=.
36135 .next
36136 .cindex "log" "TLS peer DN"
36137 .cindex "TLS" "logging peer DN"
36138 &%tls_peerdn%&: When a message is sent or received over an encrypted
36139 connection, and a certificate is supplied by the remote host, the peer DN is
36140 added to the log line, preceded by DN=.
36141 .next
36142 .cindex "log" "TLS SNI"
36143 .cindex "TLS" "logging SNI"
36144 &%tls_sni%&: When a message is received over an encrypted connection, and
36145 the remote host provided the Server Name Indication extension, the SNI is
36146 added to the log line, preceded by SNI=.
36147 .next
36148 .cindex "log" "DNS failure in list"
36149 &%unknown_in_list%&: This setting causes a log entry to be written when the
36150 result of a list match is failure because a DNS lookup failed.
36151 .endlist
36152
36153
36154 .section "Message log" "SECID260"
36155 .cindex "message" "log file for"
36156 .cindex "log" "message log; description of"
36157 .cindex "&_msglog_& directory"
36158 .oindex "&%preserve_message_logs%&"
36159 In addition to the general log files, Exim writes a log file for each message
36160 that it handles. The names of these per-message logs are the message ids, and
36161 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36162 message log contains copies of the log lines that apply to the message. This
36163 makes it easier to inspect the status of an individual message without having
36164 to search the main log. A message log is deleted when processing of the message
36165 is complete, unless &%preserve_message_logs%& is set, but this should be used
36166 only with great care because they can fill up your disk very quickly.
36167
36168 On a heavily loaded system, it may be desirable to disable the use of
36169 per-message logs, in order to reduce disk I/O. This can be done by setting the
36170 &%message_logs%& option false.
36171 .ecindex IIDloggen
36172
36173
36174
36175
36176 . ////////////////////////////////////////////////////////////////////////////
36177 . ////////////////////////////////////////////////////////////////////////////
36178
36179 .chapter "Exim utilities" "CHAPutils"
36180 .scindex IIDutils "utilities"
36181 A number of utility scripts and programs are supplied with Exim and are
36182 described in this chapter. There is also the Exim Monitor, which is covered in
36183 the next chapter. The utilities described here are:
36184
36185 .itable none 0 0 3  7* left  15* left  40* left
36186 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36187   "list what Exim processes are doing"
36188 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36189 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36190 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36191 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36192                                                 various criteria"
36193 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36194 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36195   "extract statistics from the log"
36196 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36197   "check address acceptance from given IP"
36198 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36199 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36200 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36201 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36202 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36203 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36204 .endtable
36205
36206 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36207 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36208 &url(http://duncanthrax.net/exilog/) for details.
36209
36210
36211
36212
36213 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36214 .cindex "&'exiwhat'&"
36215 .cindex "process, querying"
36216 .cindex "SIGUSR1"
36217 On operating systems that can restart a system call after receiving a signal
36218 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36219 a line describing what it is doing to the file &_exim-process.info_& in the
36220 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36221 processes it can find, having first emptied the file. It then waits for one
36222 second to allow the Exim processes to react before displaying the results. In
36223 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36224 send the signal to the Exim processes, so it is normally run as root.
36225
36226 &*Warning*&: This is not an efficient process. It is intended for occasional
36227 use by system administrators. It is not sensible, for example, to set up a
36228 script that sends SIGUSR1 signals to Exim processes at short intervals.
36229
36230
36231 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36232 varies in different operating systems. Not only are different options used,
36233 but the format of the output is different. For this reason, there are some
36234 system configuration options that configure exactly how &'exiwhat'& works. If
36235 it doesn't seem to be working for you, check the following compile-time
36236 options:
36237 .display
36238 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36239 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36240 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36241 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36242 .endd
36243 An example of typical output from &'exiwhat'& is
36244 .code
36245 164 daemon: -q1h, listening on port 25
36246 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36247 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36248   [10.19.42.42] (editor@ref.example)
36249 10592 handling incoming call from [192.168.243.242]
36250 10628 accepting a local non-SMTP message
36251 .endd
36252 The first number in the output line is the process number. The third line has
36253 been split here, in order to fit it on the page.
36254
36255
36256
36257 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36258 .cindex "&'exiqgrep'&"
36259 .cindex "queue" "grepping"
36260 This utility is a Perl script contributed by Matt Hubbard. It runs
36261 .code
36262 exim -bpu
36263 .endd
36264 or (in case &*-a*& switch is specified)
36265 .code
36266 exim -bp
36267 .endd
36268 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36269 contain alternate exim configuration the queue management might be using.
36270
36271 to obtain a queue listing, and then greps the output to select messages
36272 that match given criteria. The following selection options are available:
36273
36274 .vlist
36275 .vitem &*-f*&&~<&'regex'&>
36276 Match the sender address using a case-insensitive search. The field that is
36277 tested is enclosed in angle brackets, so you can test for bounce messages with
36278 .code
36279 exiqgrep -f '^<>$'
36280 .endd
36281 .vitem &*-r*&&~<&'regex'&>
36282 Match a recipient address using a case-insensitive search. The field that is
36283 tested is not enclosed in angle brackets.
36284
36285 .vitem &*-s*&&~<&'regex'&>
36286 Match against the size field.
36287
36288 .vitem &*-y*&&~<&'seconds'&>
36289 Match messages that are younger than the given time.
36290
36291 .vitem &*-o*&&~<&'seconds'&>
36292 Match messages that are older than the given time.
36293
36294 .vitem &*-z*&
36295 Match only frozen messages.
36296
36297 .vitem &*-x*&
36298 Match only non-frozen messages.
36299 .endlist
36300
36301 The following options control the format of the output:
36302
36303 .vlist
36304 .vitem &*-c*&
36305 Display only the count of matching messages.
36306
36307 .vitem &*-l*&
36308 Long format &-- display the full message information as output by Exim. This is
36309 the default.
36310
36311 .vitem &*-i*&
36312 Display message ids only.
36313
36314 .vitem &*-b*&
36315 Brief format &-- one line per message.
36316
36317 .vitem &*-R*&
36318 Display messages in reverse order.
36319
36320 .vitem &*-a*&
36321 Include delivered recipients in queue listing.
36322 .endlist
36323
36324 There is one more option, &%-h%&, which outputs a list of options.
36325
36326
36327
36328 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36329 .cindex "&'exiqsumm'&"
36330 .cindex "queue" "summary"
36331 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36332 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36333 running a command such as
36334 .code
36335 exim -bp | exiqsumm
36336 .endd
36337 The output consists of one line for each domain that has messages waiting for
36338 it, as in the following example:
36339 .code
36340 3   2322   74m   66m  msn.com.example
36341 .endd
36342 Each line lists the number of pending deliveries for a domain, their total
36343 volume, and the length of time that the oldest and the newest messages have
36344 been waiting. Note that the number of pending deliveries is greater than the
36345 number of messages when messages have more than one recipient.
36346
36347 A summary line is output at the end. By default the output is sorted on the
36348 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36349 the output to be sorted by oldest message and by count of messages,
36350 respectively. There are also three options that split the messages for each
36351 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36352 separates frozen messages, and &%-s%& separates messages according to their
36353 sender.
36354
36355 The output of &'exim -bp'& contains the original addresses in the message, so
36356 this also applies to the output from &'exiqsumm'&. No domains from addresses
36357 generated by aliasing or forwarding are included (unless the &%one_time%&
36358 option of the &(redirect)& router has been used to convert them into &"top
36359 level"& addresses).
36360
36361
36362
36363
36364 .section "Extracting specific information from the log (exigrep)" &&&
36365          "SECTextspeinf"
36366 .cindex "&'exigrep'&"
36367 .cindex "log" "extracts; grepping for"
36368 The &'exigrep'& utility is a Perl script that searches one or more main log
36369 files for entries that match a given pattern. When it finds a match, it
36370 extracts all the log entries for the relevant message, not just those that
36371 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36372 given message, or all mail for a given user, or for a given host, for example.
36373 The input files can be in Exim log format or syslog format.
36374 If a matching log line is not associated with a specific message, it is
36375 included in &'exigrep'&'s output without any additional lines. The usage is:
36376 .display
36377 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36378 .endd
36379 If no log file names are given on the command line, the standard input is read.
36380
36381 The &%-t%& argument specifies a number of seconds. It adds an additional
36382 condition for message selection. Messages that are complete are shown only if
36383 they spent more than <&'n'&> seconds on the queue.
36384
36385 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36386 makes it case-sensitive. This may give a performance improvement when searching
36387 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36388 option; with &%-I%& they do not. In both cases it is possible to change the
36389 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36390
36391 The &%-l%& option means &"literal"&, that is, treat all characters in the
36392 pattern as standing for themselves. Otherwise the pattern must be a Perl
36393 regular expression.
36394
36395 The &%-v%& option inverts the matching condition. That is, a line is selected
36396 if it does &'not'& match the pattern.
36397
36398 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36399 that are generated as a result/response to a message that &'exigrep'& matched
36400 normally.
36401
36402 Example of &%-M%&:
36403 user_a sends a message to user_b, which generates a bounce back to user_b. If
36404 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36405 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36406 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36407 when searching for &"user_a"& will show both messages since the bounce is
36408 &"related"& to or a &"result"& of the first message that was found by the
36409 search term.
36410
36411 If the location of a &'zcat'& command is known from the definition of
36412 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36413 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36414 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36415 autodetection of some well known compression extensions.
36416
36417
36418 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36419 .cindex "&'exipick'&"
36420 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36421 lists messages from the queue according to a variety of criteria. For details
36422 of &'exipick'&'s facilities, visit the web page at
36423 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36424 the &%--help%& option.
36425
36426
36427 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36428 .cindex "log" "cycling local files"
36429 .cindex "cycling logs"
36430 .cindex "&'exicyclog'&"
36431 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36432 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36433 you are using log files with datestamps in their names (see section
36434 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36435 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36436 There are two command line options for &'exicyclog'&:
36437 .ilist
36438 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36439 default that is set when Exim is built. The default default is 10.
36440 .next
36441 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36442 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36443 overriding the script's default, which is to find the setting from Exim's
36444 configuration.
36445 .endlist
36446
36447 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36448 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36449 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36450 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36451 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36452 logs are handled similarly.
36453
36454 If the limit is greater than 99, the script uses 3-digit numbers such as
36455 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36456 to one that is greater, or &'vice versa'&, you will have to fix the names of
36457 any existing log files.
36458
36459 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36460 the end are deleted. All files with numbers greater than 01 are compressed,
36461 using a compression command which is configured by the COMPRESS_COMMAND
36462 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36463 root &%crontab%& entry of the form
36464 .code
36465 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36466 .endd
36467 assuming you have used the name &"exim"& for the Exim user. You can run
36468 &'exicyclog'& as root if you wish, but there is no need.
36469
36470
36471
36472 .section "Mail statistics (eximstats)" "SECTmailstat"
36473 .cindex "statistics"
36474 .cindex "&'eximstats'&"
36475 A Perl script called &'eximstats'& is provided for extracting statistical
36476 information from log files. The output is either plain text, or HTML.
36477 Exim log files are also supported by the &'Lire'& system produced by the
36478 LogReport Foundation &url(http://www.logreport.org).
36479
36480 The &'eximstats'& script has been hacked about quite a bit over time. The
36481 latest version is the result of some extensive revision by Steve Campbell. A
36482 lot of information is given by default, but there are options for suppressing
36483 various parts of it. Following any options, the arguments to the script are a
36484 list of files, which should be main log files. For example:
36485 .code
36486 eximstats -nr /var/spool/exim/log/mainlog.01
36487 .endd
36488 By default, &'eximstats'& extracts information about the number and volume of
36489 messages received from or delivered to various hosts. The information is sorted
36490 both by message count and by volume, and the top fifty hosts in each category
36491 are listed on the standard output. Similar information, based on email
36492 addresses or domains instead of hosts can be requested by means of various
36493 options. For messages delivered and received locally, similar statistics are
36494 also produced per user.
36495
36496 The output also includes total counts and statistics about delivery errors, and
36497 histograms showing the number of messages received and deliveries made in each
36498 hour of the day. A delivery with more than one address in its envelope (for
36499 example, an SMTP transaction with more than one RCPT command) is counted
36500 as a single delivery by &'eximstats'&.
36501
36502 Though normally more deliveries than receipts are reported (as messages may
36503 have multiple recipients), it is possible for &'eximstats'& to report more
36504 messages received than delivered, even though the queue is empty at the start
36505 and end of the period in question. If an incoming message contains no valid
36506 recipients, no deliveries are recorded for it. A bounce message is handled as
36507 an entirely separate message.
36508
36509 &'eximstats'& always outputs a grand total summary giving the volume and number
36510 of messages received and deliveries made, and the number of hosts involved in
36511 each case. It also outputs the number of messages that were delayed (that is,
36512 not completely delivered at the first attempt), and the number that had at
36513 least one address that failed.
36514
36515 The remainder of the output is in sections that can be independently disabled
36516 or modified by various options. It consists of a summary of deliveries by
36517 transport, histograms of messages received and delivered per time interval
36518 (default per hour), information about the time messages spent on the queue,
36519 a list of relayed messages, lists of the top fifty sending hosts, local
36520 senders, destination hosts, and destination local users by count and by volume,
36521 and a list of delivery errors that occurred.
36522
36523 The relay information lists messages that were actually relayed, that is, they
36524 came from a remote host and were directly delivered to some other remote host,
36525 without being processed (for example, for aliasing or forwarding) locally.
36526
36527 There are quite a few options for &'eximstats'& to control exactly what it
36528 outputs. These are documented in the Perl script itself, and can be extracted
36529 by running the command &(perldoc)& on the script. For example:
36530 .code
36531 perldoc /usr/exim/bin/eximstats
36532 .endd
36533
36534 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36535 .cindex "&'exim_checkaccess'&"
36536 .cindex "policy control" "checking access"
36537 .cindex "checking access"
36538 The &%-bh%& command line argument allows you to run a fake SMTP session with
36539 debugging output, in order to check what Exim is doing when it is applying
36540 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36541 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36542 sometimes you just want to answer the question &"Does this address have
36543 access?"& without bothering with any further details.
36544
36545 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36546 two arguments, an IP address and an email address:
36547 .code
36548 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36549 .endd
36550 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36551 given email address would be accepted in a RCPT command in a TCP/IP
36552 connection from the host with the given IP address. The output of the utility
36553 is either the word &"accepted"&, or the SMTP error response, for example:
36554 .code
36555 Rejected:
36556 550 Relay not permitted
36557 .endd
36558 When running this test, the utility uses &`<>`& as the envelope sender address
36559 for the MAIL command, but you can change this by providing additional
36560 options. These are passed directly to the Exim command. For example, to specify
36561 that the test is to be run with the sender address &'himself@there.example'&
36562 you can use:
36563 .code
36564 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36565                  -f himself@there.example
36566 .endd
36567 Note that these additional Exim command line items must be given after the two
36568 mandatory arguments.
36569
36570 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36571 while running its checks. You can run checks that include callouts by using
36572 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36573
36574
36575
36576 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36577 .cindex "DBM" "building dbm files"
36578 .cindex "building DBM files"
36579 .cindex "&'exim_dbmbuild'&"
36580 .cindex "lower casing"
36581 .cindex "binary zero" "in lookup key"
36582 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36583 the format used by the &(lsearch)& lookup (see section
36584 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36585 names as keys and the remainder of the information as data. The lower-casing
36586 can be prevented by calling the program with the &%-nolc%& option.
36587
36588 A terminating zero is included as part of the key string. This is expected by
36589 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36590 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36591 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36592 files.
36593
36594 The program requires two arguments: the name of the input file (which can be a
36595 single hyphen to indicate the standard input), and the name of the output file.
36596 It creates the output under a temporary name, and then renames it if all went
36597 well.
36598
36599 .cindex "USE_DB"
36600 If the native DB interface is in use (USE_DB is set in a compile-time
36601 configuration file &-- this is common in free versions of Unix) the two file
36602 names must be different, because in this mode the Berkeley DB functions create
36603 a single output file using exactly the name given. For example,
36604 .code
36605 exim_dbmbuild /etc/aliases /etc/aliases.db
36606 .endd
36607 reads the system alias file and creates a DBM version of it in
36608 &_/etc/aliases.db_&.
36609
36610 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36611 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36612 environment, the suffixes are added to the second argument of
36613 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36614 when the Berkeley functions are used in compatibility mode (though this is not
36615 recommended), because in that case it adds a &_.db_& suffix to the file name.
36616
36617 If a duplicate key is encountered, the program outputs a warning, and when it
36618 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36619 option is used. By default, only the first of a set of duplicates is used &--
36620 this makes it compatible with &(lsearch)& lookups. There is an option
36621 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36622 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36623 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36624 return code is 2.
36625
36626
36627
36628
36629 .section "Finding individual retry times (exinext)" "SECTfinindret"
36630 .cindex "retry" "times"
36631 .cindex "&'exinext'&"
36632 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36633 fish specific information out of the retry database. Given a mail domain (or a
36634 complete address), it looks up the hosts for that domain, and outputs any retry
36635 information for the hosts or for the domain. At present, the retry information
36636 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36637 output. For example:
36638 .code
36639 $ exinext piglet@milne.fict.example
36640 kanga.milne.example:192.168.8.1 error 146: Connection refused
36641   first failed: 21-Feb-1996 14:57:34
36642   last tried:   21-Feb-1996 14:57:34
36643   next try at:  21-Feb-1996 15:02:34
36644 roo.milne.example:192.168.8.3 error 146: Connection refused
36645   first failed: 20-Jan-1996 13:12:08
36646   last tried:   21-Feb-1996 11:42:03
36647   next try at:  21-Feb-1996 19:42:03
36648   past final cutoff time
36649 .endd
36650 You can also give &'exinext'& a local part, without a domain, and it
36651 will give any retry information for that local part in your default domain.
36652 A message id can be used to obtain retry information pertaining to a specific
36653 message. This exists only when an attempt to deliver a message to a remote host
36654 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36655 &'exinext'& is not particularly efficient, but then it is not expected to be
36656 run very often.
36657
36658 The &'exinext'& utility calls Exim to find out information such as the location
36659 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36660 passed on to the &'exim'& commands. The first specifies an alternate Exim
36661 configuration file, and the second sets macros for use within the configuration
36662 file. These features are mainly to help in testing, but might also be useful in
36663 environments where more than one configuration file is in use.
36664
36665
36666
36667 .section "Hints database maintenance" "SECThindatmai"
36668 .cindex "hints database" "maintenance"
36669 .cindex "maintaining Exim's hints database"
36670 Three utility programs are provided for maintaining the DBM files that Exim
36671 uses to contain its delivery hint information. Each program requires two
36672 arguments. The first specifies the name of Exim's spool directory, and the
36673 second is the name of the database it is to operate on. These are as follows:
36674
36675 .ilist
36676 &'retry'&: the database of retry information
36677 .next
36678 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36679 for remote hosts
36680 .next
36681 &'callout'&: the callout cache
36682 .next
36683 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36684 .next
36685 &'misc'&: other hints data
36686 .endlist
36687
36688 The &'misc'& database is used for
36689
36690 .ilist
36691 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36692 .next
36693 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36694 &(smtp)& transport)
36695 .next
36696 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36697 in a transport)
36698 .endlist
36699
36700
36701
36702 .section "exim_dumpdb" "SECID261"
36703 .cindex "&'exim_dumpdb'&"
36704 The entire contents of a database are written to the standard output by the
36705 &'exim_dumpdb'& program, which has no options or arguments other than the
36706 spool and database names. For example, to dump the retry database:
36707 .code
36708 exim_dumpdb /var/spool/exim retry
36709 .endd
36710 Two lines of output are produced for each entry:
36711 .code
36712 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36713 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36714 .endd
36715 The first item on the first line is the key of the record. It starts with one
36716 of the letters R, or T, depending on whether it refers to a routing or
36717 transport retry. For a local delivery, the next part is the local address; for
36718 a remote delivery it is the name of the remote host, followed by its failing IP
36719 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36720 transport). If the remote port is not the standard one (port 25), it is added
36721 to the IP address. Then there follows an error code, an additional error code,
36722 and a textual description of the error.
36723
36724 The three times on the second line are the time of first failure, the time of
36725 the last delivery attempt, and the computed time for the next attempt. The line
36726 ends with an asterisk if the cutoff time for the last retry rule has been
36727 exceeded.
36728
36729 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36730 consists of a host name followed by a list of ids for messages that are or were
36731 waiting to be delivered to that host. If there are a very large number for any
36732 one host, continuation records, with a sequence number added to the host name,
36733 may be seen. The data in these records is often out of date, because a message
36734 may be routed to several alternative hosts, and Exim makes no effort to keep
36735 cross-references.
36736
36737
36738
36739 .section "exim_tidydb" "SECID262"
36740 .cindex "&'exim_tidydb'&"
36741 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36742 database. If run with no options, it removes all records that are more than 30
36743 days old. The age is calculated from the date and time that the record was last
36744 updated. Note that, in the case of the retry database, it is &'not'& the time
36745 since the first delivery failure. Information about a host that has been down
36746 for more than 30 days will remain in the database, provided that the record is
36747 updated sufficiently often.
36748
36749 The cutoff date can be altered by means of the &%-t%& option, which must be
36750 followed by a time. For example, to remove all records older than a week from
36751 the retry database:
36752 .code
36753 exim_tidydb -t 7d /var/spool/exim retry
36754 .endd
36755 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36756 message ids. In the former these appear as data in records keyed by host &--
36757 they were messages that were waiting for that host &-- and in the latter they
36758 are the keys for retry information for messages that have suffered certain
36759 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36760 message ids in database records are those of messages that are still on the
36761 queue. Message ids for messages that no longer exist are removed from
36762 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36763 For the &'retry'& database, records whose keys are non-existent message ids are
36764 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36765 whenever it removes information from the database.
36766
36767 Certain records are automatically removed by Exim when they are no longer
36768 needed, but others are not. For example, if all the MX hosts for a domain are
36769 down, a retry record is created for each one. If the primary MX host comes back
36770 first, its record is removed when Exim successfully delivers to it, but the
36771 records for the others remain because Exim has not tried to use those hosts.
36772
36773 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36774 hints databases. You should do this at a quiet time of day, because it requires
36775 a database to be locked (and therefore inaccessible to Exim) while it does its
36776 work. Removing records from a DBM file does not normally make the file smaller,
36777 but all the common DBM libraries are able to re-use the space that is released.
36778 After an initial phase of increasing in size, the databases normally reach a
36779 point at which they no longer get any bigger, as long as they are regularly
36780 tidied.
36781
36782 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36783 databases is likely to keep on increasing.
36784
36785
36786
36787
36788 .section "exim_fixdb" "SECID263"
36789 .cindex "&'exim_fixdb'&"
36790 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36791 Its main use is for testing Exim, but it might also be occasionally useful for
36792 getting round problems in a live system. It has no options, and its interface
36793 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36794 key of a database record can then be entered, and the data for that record is
36795 displayed.
36796
36797 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36798 except the &'retry'& database, that is the only operation that can be carried
36799 out. For the &'retry'& database, each field is output preceded by a number, and
36800 data for individual fields can be changed by typing the field number followed
36801 by new data, for example:
36802 .code
36803 > 4 951102:1000
36804 .endd
36805 resets the time of the next delivery attempt. Time values are given as a
36806 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36807 used as optional separators.
36808
36809
36810
36811
36812 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36813 .cindex "mailbox" "maintenance"
36814 .cindex "&'exim_lock'&"
36815 .cindex "locking mailboxes"
36816 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36817 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36818 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36819 a user agent while investigating a problem. The utility requires the name of
36820 the file as its first argument. If the locking is successful, the second
36821 argument is run as a command (using C's &[system()]& function); if there is no
36822 second argument, the value of the SHELL environment variable is used; if this
36823 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36824 is unlocked and the utility ends. The following options are available:
36825
36826 .vlist
36827 .vitem &%-fcntl%&
36828 Use &[fcntl()]& locking on the open mailbox.
36829
36830 .vitem &%-flock%&
36831 Use &[flock()]& locking on the open mailbox, provided the operating system
36832 supports it.
36833
36834 .vitem &%-interval%&
36835 This must be followed by a number, which is a number of seconds; it sets the
36836 interval to sleep between retries (default 3).
36837
36838 .vitem &%-lockfile%&
36839 Create a lock file before opening the mailbox.
36840
36841 .vitem &%-mbx%&
36842 Lock the mailbox using MBX rules.
36843
36844 .vitem &%-q%&
36845 Suppress verification output.
36846
36847 .vitem &%-retries%&
36848 This must be followed by a number; it sets the number of times to try to get
36849 the lock (default 10).
36850
36851 .vitem &%-restore_time%&
36852 This option causes &%exim_lock%& to restore the modified and read times to the
36853 locked file before exiting. This allows you to access a locked mailbox (for
36854 example, to take a backup copy) without disturbing the times that the user
36855 subsequently sees.
36856
36857 .vitem &%-timeout%&
36858 This must be followed by a number, which is a number of seconds; it sets a
36859 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36860 default), a non-blocking call is used.
36861
36862 .vitem &%-v%&
36863 Generate verbose output.
36864 .endlist
36865
36866 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36867 default is to create a lock file and also to use &[fcntl()]& locking on the
36868 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36869 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36870 requires that the directory containing the file be writeable. Locking by lock
36871 file does not last for ever; Exim assumes that a lock file is expired if it is
36872 more than 30 minutes old.
36873
36874 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36875 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36876 to be taken out on the open mailbox, and an exclusive lock on the file
36877 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36878 number of the mailbox file. When the locking is released, if an exclusive lock
36879 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36880
36881 The default output contains verification of the locking that takes place. The
36882 &%-v%& option causes some additional information to be given. The &%-q%& option
36883 suppresses all output except error messages.
36884
36885 A command such as
36886 .code
36887 exim_lock /var/spool/mail/spqr
36888 .endd
36889 runs an interactive shell while the file is locked, whereas
36890 .display
36891 &`exim_lock -q /var/spool/mail/spqr <<End`&
36892 <&'some commands'&>
36893 &`End`&
36894 .endd
36895 runs a specific non-interactive sequence of commands while the file is locked,
36896 suppressing all verification output. A single command can be run by a command
36897 such as
36898 .code
36899 exim_lock -q /var/spool/mail/spqr \
36900   "cp /var/spool/mail/spqr /some/where"
36901 .endd
36902 Note that if a command is supplied, it must be entirely contained within the
36903 second argument &-- hence the quotes.
36904 .ecindex IIDutils
36905
36906
36907 . ////////////////////////////////////////////////////////////////////////////
36908 . ////////////////////////////////////////////////////////////////////////////
36909
36910 .chapter "The Exim monitor" "CHAPeximon"
36911 .scindex IIDeximon "Exim monitor" "description"
36912 .cindex "X-windows"
36913 .cindex "&'eximon'&"
36914 .cindex "Local/eximon.conf"
36915 .cindex "&_exim_monitor/EDITME_&"
36916 The Exim monitor is an application which displays in an X window information
36917 about the state of Exim's queue and what Exim is doing. An admin user can
36918 perform certain operations on messages from this GUI interface; however all
36919 such facilities are also available from the command line, and indeed, the
36920 monitor itself makes use of the command line to perform any actions requested.
36921
36922
36923
36924 .section "Running the monitor" "SECID264"
36925 The monitor is started by running the script called &'eximon'&. This is a shell
36926 script that sets up a number of environment variables, and then runs the
36927 binary called &_eximon.bin_&. The default appearance of the monitor window can
36928 be changed by editing the &_Local/eximon.conf_& file created by editing
36929 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36930 parameters are for.
36931
36932 The parameters that get built into the &'eximon'& script can be overridden for
36933 a particular invocation by setting up environment variables of the same names,
36934 preceded by &`EXIMON_`&. For example, a shell command such as
36935 .code
36936 EXIMON_LOG_DEPTH=400 eximon
36937 .endd
36938 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36939 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36940 overrides the Exim log file configuration. This makes it possible to have
36941 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36942 syslog messages are routed to a file on the local host.
36943
36944 X resources can be used to change the appearance of the window in the normal
36945 way. For example, a resource setting of the form
36946 .code
36947 Eximon*background: gray94
36948 .endd
36949 changes the colour of the background to light grey rather than white. The
36950 stripcharts are drawn with both the data lines and the reference lines in
36951 black. This means that the reference lines are not visible when on top of the
36952 data. However, their colour can be changed by setting a resource called
36953 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36954 For example, if your X server is running Unix, you could set up lighter
36955 reference lines in the stripcharts by obeying
36956 .code
36957 xrdb -merge <<End
36958 Eximon*highlight: gray
36959 End
36960 .endd
36961 .cindex "admin user"
36962 In order to see the contents of messages on the queue, and to operate on them,
36963 &'eximon'& must either be run as root or by an admin user.
36964
36965 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36966 contain X11 resource parameters interpreted by the X11 library.  In addition,
36967 if the first parameter starts with the string "gdb" then it is removed and the
36968 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36969 versioned variants of gdb can be invoked).
36970
36971 The monitor's window is divided into three parts. The first contains one or
36972 more stripcharts and two action buttons, the second contains a &"tail"& of the
36973 main log file, and the third is a display of the queue of messages awaiting
36974 delivery, with two more action buttons. The following sections describe these
36975 different parts of the display.
36976
36977
36978
36979
36980 .section "The stripcharts" "SECID265"
36981 .cindex "stripchart"
36982 The first stripchart is always a count of messages on the queue. Its name can
36983 be configured by setting QUEUE_STRIPCHART_NAME in the
36984 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36985 configuration script by regular expression matches on log file entries, making
36986 it possible to display, for example, counts of messages delivered to certain
36987 hosts or using certain transports. The supplied defaults display counts of
36988 received and delivered messages, and of local and SMTP deliveries. The default
36989 period between stripchart updates is one minute; this can be adjusted by a
36990 parameter in the &_Local/eximon.conf_& file.
36991
36992 The stripchart displays rescale themselves automatically as the value they are
36993 displaying changes. There are always 10 horizontal lines in each chart; the
36994 title string indicates the value of each division when it is greater than one.
36995 For example, &"x2"& means that each division represents a value of 2.
36996
36997 It is also possible to have a stripchart which shows the percentage fullness of
36998 a particular disk partition, which is useful when local deliveries are confined
36999 to a single partition.
37000
37001 .cindex "&%statvfs%& function"
37002 This relies on the availability of the &[statvfs()]& function or equivalent in
37003 the operating system. Most, but not all versions of Unix that support Exim have
37004 this. For this particular stripchart, the top of the chart always represents
37005 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37006 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37007 &_Local/eximon.conf_& file.
37008
37009
37010
37011
37012 .section "Main action buttons" "SECID266"
37013 .cindex "size" "of monitor window"
37014 .cindex "Exim monitor" "window size"
37015 .cindex "window size"
37016 Below the stripcharts there is an action button for quitting the monitor. Next
37017 to this is another button marked &"Size"&. They are placed here so that
37018 shrinking the window to its default minimum size leaves just the queue count
37019 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37020 the window to expand to its maximum size, unless it is already at the maximum,
37021 in which case it is reduced to its minimum.
37022
37023 When expanding to the maximum, if the window cannot be fully seen where it
37024 currently is, it is moved back to where it was the last time it was at full
37025 size. When it is expanding from its minimum size, the old position is
37026 remembered, and next time it is reduced to the minimum it is moved back there.
37027
37028 The idea is that you can keep a reduced window just showing one or two
37029 stripcharts at a convenient place on your screen, easily expand it to show
37030 the full window when required, and just as easily put it back to what it was.
37031 The idea is copied from what the &'twm'& window manager does for its
37032 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37033 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37034
37035 Normally, the monitor starts up with the window at its full size, but it can be
37036 built so that it starts up with the window at its smallest size, by setting
37037 START_SMALL=yes in &_Local/eximon.conf_&.
37038
37039
37040
37041 .section "The log display" "SECID267"
37042 .cindex "log" "tail of; in monitor"
37043 The second section of the window is an area in which a display of the tail of
37044 the main log is maintained.
37045 To save space on the screen, the timestamp on each log line is shortened by
37046 removing the date and, if &%log_timezone%& is set, the timezone.
37047 The log tail is not available when the only destination for logging data is
37048 syslog, unless the syslog lines are routed to a local file whose name is passed
37049 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37050
37051 The log sub-window has a scroll bar at its lefthand side which can be used to
37052 move back to look at earlier text, and the up and down arrow keys also have a
37053 scrolling effect. The amount of log that is kept depends on the setting of
37054 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37055 to use. When this is full, the earlier 50% of data is discarded &-- this is
37056 much more efficient than throwing it away line by line. The sub-window also has
37057 a horizontal scroll bar for accessing the ends of long log lines. This is the
37058 only means of horizontal scrolling; the right and left arrow keys are not
37059 available. Text can be cut from this part of the window using the mouse in the
37060 normal way. The size of this subwindow is controlled by parameters in the
37061 configuration file &_Local/eximon.conf_&.
37062
37063 Searches of the text in the log window can be carried out by means of the ^R
37064 and ^S keystrokes, which default to a reverse and a forward search,
37065 respectively. The search covers only the text that is displayed in the window.
37066 It cannot go further back up the log.
37067
37068 The point from which the search starts is indicated by a caret marker. This is
37069 normally at the end of the text in the window, but can be positioned explicitly
37070 by pointing and clicking with the left mouse button, and is moved automatically
37071 by a successful search. If new text arrives in the window when it is scrolled
37072 back, the caret remains where it is, but if the window is not scrolled back,
37073 the caret is moved to the end of the new text.
37074
37075 Pressing ^R or ^S pops up a window into which the search text can be typed.
37076 There are buttons for selecting forward or reverse searching, for carrying out
37077 the search, and for cancelling. If the &"Search"& button is pressed, the search
37078 happens and the window remains so that further searches can be done. If the
37079 &"Return"& key is pressed, a single search is done and the window is closed. If
37080 ^C is typed the search is cancelled.
37081
37082 The searching facility is implemented using the facilities of the Athena text
37083 widget. By default this pops up a window containing both &"search"& and
37084 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37085 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37086 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37087 provided version of &%TextPop%& when the remaining parts of the text widget
37088 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37089 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37090 on these systems, at the expense of having unwanted items in the search popup
37091 window.
37092
37093
37094
37095 .section "The queue display" "SECID268"
37096 .cindex "queue" "display in monitor"
37097 The bottom section of the monitor window contains a list of all messages that
37098 are on the queue, which includes those currently being received or delivered,
37099 as well as those awaiting delivery. The size of this subwindow is controlled by
37100 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37101 at which it is updated is controlled by another parameter in the same file &--
37102 the default is 5 minutes, since queue scans can be quite expensive. However,
37103 there is an &"Update"& action button just above the display which can be used
37104 to force an update of the queue display at any time.
37105
37106 When a host is down for some time, a lot of pending mail can build up for it,
37107 and this can make it hard to deal with other messages on the queue. To help
37108 with this situation there is a button next to &"Update"& called &"Hide"&. If
37109 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37110 type anything in here and press &"Return"&, the text is added to a chain of
37111 such texts, and if every undelivered address in a message matches at least one
37112 of the texts, the message is not displayed.
37113
37114 If there is an address that does not match any of the texts, all the addresses
37115 are displayed as normal. The matching happens on the ends of addresses so, for
37116 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37117 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37118 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37119 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37120 a hide request is automatically cancelled after one hour.
37121
37122 While the dialogue box is displayed, you can't press any buttons or do anything
37123 else to the monitor window. For this reason, if you want to cut text from the
37124 queue display to use in the dialogue box, you have to do the cutting before
37125 pressing the &"Hide"& button.
37126
37127 The queue display contains, for each unhidden queued message, the length of
37128 time it has been on the queue, the size of the message, the message id, the
37129 message sender, and the first undelivered recipient, all on one line. If it is
37130 a bounce message, the sender is shown as &"<>"&. If there is more than one
37131 recipient to which the message has not yet been delivered, subsequent ones are
37132 listed on additional lines, up to a maximum configured number, following which
37133 an ellipsis is displayed. Recipients that have already received the message are
37134 not shown.
37135
37136 .cindex "frozen messages" "display"
37137 If a message is frozen, an asterisk is displayed at the left-hand side.
37138
37139 The queue display has a vertical scroll bar, and can also be scrolled by means
37140 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37141 The text searching facilities, as described above for the log window, are also
37142 available, but the caret is always moved to the end of the text when the queue
37143 display is updated.
37144
37145
37146
37147 .section "The queue menu" "SECID269"
37148 .cindex "queue" "menu in monitor"
37149 If the &%shift%& key is held down and the left button is clicked when the mouse
37150 pointer is over the text for any message, an action menu pops up, and the first
37151 line of the queue display for the message is highlighted. This does not affect
37152 any selected text.
37153
37154 If you want to use some other event for popping up the menu, you can set the
37155 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37156 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37157 value set in this parameter is a standard X event description. For example, to
37158 run eximon using &%ctrl%& rather than &%shift%& you could use
37159 .code
37160 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37161 .endd
37162 The title of the menu is the message id, and it contains entries which act as
37163 follows:
37164
37165 .ilist
37166 &'message log'&: The contents of the message log for the message are displayed
37167 in a new text window.
37168 .next
37169 &'headers'&: Information from the spool file that contains the envelope
37170 information and headers is displayed in a new text window. See chapter
37171 &<<CHAPspool>>& for a description of the format of spool files.
37172 .next
37173 &'body'&: The contents of the spool file containing the body of the message are
37174 displayed in a new text window. There is a default limit of 20,000 bytes to the
37175 amount of data displayed. This can be changed by setting the BODY_MAX
37176 option at compile time, or the EXIMON_BODY_MAX option at run time.
37177 .next
37178 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37179 delivery of the message. This causes an automatic thaw if the message is
37180 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37181 a new text window. The delivery is run in a separate process, to avoid holding
37182 up the monitor while the delivery proceeds.
37183 .next
37184 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37185 that the message be frozen.
37186 .next
37187 .cindex "thawing messages"
37188 .cindex "unfreezing messages"
37189 .cindex "frozen messages" "thawing"
37190 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37191 that the message be thawed.
37192 .next
37193 .cindex "delivery" "forcing failure"
37194 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37195 that Exim gives up trying to deliver the message. A bounce message is generated
37196 for any remaining undelivered addresses.
37197 .next
37198 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37199 that the message be deleted from the system without generating a bounce
37200 message.
37201 .next
37202 &'add recipient'&: A dialog box is displayed into which a recipient address can
37203 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37204 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37205 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37206 causes a call to Exim to be made using the &%-Mar%& option to request that an
37207 additional recipient be added to the message, unless the entry box is empty, in
37208 which case no action is taken.
37209 .next
37210 &'mark delivered'&: A dialog box is displayed into which a recipient address
37211 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37212 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37213 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37214 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37215 recipient address as already delivered, unless the entry box is empty, in which
37216 case no action is taken.
37217 .next
37218 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37219 mark all recipient addresses as already delivered.
37220 .next
37221 &'edit sender'&: A dialog box is displayed initialized with the current
37222 sender's address. Pressing RETURN causes a call to Exim to be made using the
37223 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37224 in which case no action is taken. If you want to set an empty sender (as in
37225 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37226 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37227 the address is qualified with that domain.
37228 .endlist
37229
37230 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37231 other cases when a call to Exim is made, if there is any output from Exim (in
37232 particular, if the command fails) a window containing the command and the
37233 output is displayed. Otherwise, the results of the action are normally apparent
37234 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37235 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37236 if no output is generated.
37237
37238 The queue display is automatically updated for actions such as freezing and
37239 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37240 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37241 force an update of the display after one of these actions.
37242
37243 In any text window that is displayed as result of a menu action, the normal
37244 cut-and-paste facility is available, and searching can be carried out using ^R
37245 and ^S, as described above for the log tail window.
37246 .ecindex IIDeximon
37247
37248
37249
37250
37251
37252 . ////////////////////////////////////////////////////////////////////////////
37253 . ////////////////////////////////////////////////////////////////////////////
37254
37255 .chapter "Security considerations" "CHAPsecurity"
37256 .scindex IIDsecurcon "security" "discussion of"
37257 This chapter discusses a number of issues concerned with security, some of
37258 which are also covered in other parts of this manual.
37259
37260 For reasons that this author does not understand, some people have promoted
37261 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37262 existence of this chapter in the documentation. However, the intent of the
37263 chapter is simply to describe the way Exim works in relation to certain
37264 security concerns, not to make any specific claims about the effectiveness of
37265 its security as compared with other MTAs.
37266
37267 What follows is a description of the way Exim is supposed to be. Best efforts
37268 have been made to try to ensure that the code agrees with the theory, but an
37269 absence of bugs can never be guaranteed. Any that are reported will get fixed
37270 as soon as possible.
37271
37272
37273 .section "Building a more &""hardened""& Exim" "SECID286"
37274 .cindex "security" "build-time features"
37275 There are a number of build-time options that can be set in &_Local/Makefile_&
37276 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37277 Exim administrator who does not have the root password, or by someone who has
37278 penetrated the Exim (but not the root) account. These options are as follows:
37279
37280 .ilist
37281 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37282 start of any file names used with the &%-C%& option. When it is set, these file
37283 names are also not allowed to contain the sequence &"/../"&. (However, if the
37284 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37285 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37286 default setting for &%ALT_CONFIG_PREFIX%&.
37287
37288 If the permitted configuration files are confined to a directory to
37289 which only root has access, this guards against someone who has broken
37290 into the Exim account from running a privileged Exim with an arbitrary
37291 configuration file, and using it to break into other accounts.
37292 .next
37293
37294 If a non-trusted configuration file (i.e. not the default configuration file
37295 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37296 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37297 the next item), then root privilege is retained only if the caller of Exim is
37298 root. This locks out the possibility of testing a configuration using &%-C%&
37299 right through message reception and delivery, even if the caller is root. The
37300 reception works, but by that time, Exim is running as the Exim user, so when
37301 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37302 privilege to be lost. However, root can test reception and delivery using two
37303 separate commands.
37304
37305 .next
37306 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37307 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37308 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37309 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37310 the restrictive side.  Requiring build-time selection of safe macros is onerous
37311 but this option is intended solely as a transition mechanism to permit
37312 previously-working configurations to continue to work after release 4.73.
37313 .next
37314 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37315 is disabled.
37316 .next
37317 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37318 never to be used for any deliveries. This is like the &%never_users%& runtime
37319 option, but it cannot be overridden; the runtime option adds additional users
37320 to the list. The default setting is &"root"&; this prevents a non-root user who
37321 is permitted to modify the runtime file from using Exim as a way to get root.
37322 .endlist
37323
37324
37325
37326 .section "Root privilege" "SECID270"
37327 .cindex "setuid"
37328 .cindex "root privilege"
37329 The Exim binary is normally setuid to root, which means that it gains root
37330 privilege (runs as root) when it starts execution. In some special cases (for
37331 example, when the daemon is not in use and there are no local deliveries), it
37332 may be possible to run Exim setuid to some user other than root. This is
37333 discussed in the next section. However, in most installations, root privilege
37334 is required for two things:
37335
37336 .ilist
37337 To set up a socket connected to the standard SMTP port (25) when initialising
37338 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37339 not required.
37340 .next
37341 To be able to change uid and gid in order to read users' &_.forward_& files and
37342 perform local deliveries as the receiving user or as specified in the
37343 configuration.
37344 .endlist
37345
37346 It is not necessary to be root to do any of the other things Exim does, such as
37347 receiving messages and delivering them externally over SMTP, and it is
37348 obviously more secure if Exim does not run as root except when necessary.
37349 For this reason, a user and group for Exim to use must be defined in
37350 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37351 group"&. Their values can be changed by the run time configuration, though this
37352 is not recommended. Often a user called &'exim'& is used, but some sites use
37353 &'mail'& or another user name altogether.
37354
37355 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37356 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37357 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37358
37359 After a new Exim process has interpreted its command line options, it changes
37360 uid and gid in the following cases:
37361
37362 .ilist
37363 .oindex "&%-C%&"
37364 .oindex "&%-D%&"
37365 If the &%-C%& option is used to specify an alternate configuration file, or if
37366 the &%-D%& option is used to define macro values for the configuration, and the
37367 calling process is not running as root, the uid and gid are changed to those of
37368 the calling process.
37369 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37370 option may not be used at all.
37371 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37372 can be supplied if the calling process is running as root, the Exim run-time
37373 user or CONFIGURE_OWNER, if defined.
37374 .next
37375 .oindex "&%-be%&"
37376 .oindex "&%-bf%&"
37377 .oindex "&%-bF%&"
37378 If the expansion test option (&%-be%&) or one of the filter testing options
37379 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37380 calling process.
37381 .next
37382 If the process is not a daemon process or a queue runner process or a delivery
37383 process or a process for testing address routing (started with &%-bt%&), the
37384 uid and gid are changed to the Exim user and group. This means that Exim always
37385 runs under its own uid and gid when receiving messages. This also applies when
37386 testing address verification
37387 .oindex "&%-bv%&"
37388 .oindex "&%-bh%&"
37389 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37390 option).
37391 .next
37392 For a daemon, queue runner, delivery, or address testing process, the uid
37393 remains as root at this stage, but the gid is changed to the Exim group.
37394 .endlist
37395
37396 The processes that initially retain root privilege behave as follows:
37397
37398 .ilist
37399 A daemon process changes the gid to the Exim group and the uid to the Exim
37400 user after setting up one or more listening sockets. The &[initgroups()]&
37401 function is called, so that if the Exim user is in any additional groups, they
37402 will be used during message reception.
37403 .next
37404 A queue runner process retains root privilege throughout its execution. Its
37405 job is to fork a controlled sequence of delivery processes.
37406 .next
37407 A delivery process retains root privilege throughout most of its execution,
37408 but any actual deliveries (that is, the transports themselves) are run in
37409 subprocesses which always change to a non-root uid and gid. For local
37410 deliveries this is typically the uid and gid of the owner of the mailbox; for
37411 remote deliveries, the Exim uid and gid are used. Once all the delivery
37412 subprocesses have been run, a delivery process changes to the Exim uid and gid
37413 while doing post-delivery tidying up such as updating the retry database and
37414 generating bounce and warning messages.
37415
37416 While the recipient addresses in a message are being routed, the delivery
37417 process runs as root. However, if a user's filter file has to be processed,
37418 this is done in a subprocess that runs under the individual user's uid and
37419 gid. A system filter is run as root unless &%system_filter_user%& is set.
37420 .next
37421 A process that is testing addresses (the &%-bt%& option) runs as root so that
37422 the routing is done in the same environment as a message delivery.
37423 .endlist
37424
37425
37426
37427
37428 .section "Running Exim without privilege" "SECTrunexiwitpri"
37429 .cindex "privilege, running without"
37430 .cindex "unprivileged running"
37431 .cindex "root privilege" "running without"
37432 Some installations like to run Exim in an unprivileged state for more of its
37433 operation, for added security. Support for this mode of operation is provided
37434 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37435 gid are changed to the Exim user and group at the start of a delivery process
37436 (and also queue runner and address testing processes). This means that address
37437 routing is no longer run as root, and the deliveries themselves cannot change
37438 to any other uid.
37439
37440 .cindex SIGHUP
37441 .cindex "daemon" "restarting"
37442 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37443 that the daemon can still be started in the usual way, and it can respond
37444 correctly to SIGHUP because the re-invocation regains root privilege.
37445
37446 An alternative approach is to make Exim setuid to the Exim user and also setgid
37447 to the Exim group. If you do this, the daemon must be started from a root
37448 process. (Calling Exim from a root process makes it behave in the way it does
37449 when it is setuid root.) However, the daemon cannot restart itself after a
37450 SIGHUP signal because it cannot regain privilege.
37451
37452 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37453 stops Exim from trying to re-invoke itself to do a delivery after a message has
37454 been received. Such a re-invocation is a waste of resources because it has no
37455 effect.
37456
37457 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37458 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37459 to the Exim user seems a clean approach, but there is one complication:
37460
37461 In this style of operation, Exim is running with the real uid and gid set to
37462 those of the calling process, and the effective uid/gid set to Exim's values.
37463 Ideally, any association with the calling process' uid/gid should be dropped,
37464 that is, the real uid/gid should be reset to the effective values so as to
37465 discard any privileges that the caller may have. While some operating systems
37466 have a function that permits this action for a non-root effective uid, quite a
37467 number of them do not. Because of this lack of standardization, Exim does not
37468 address this problem at this time.
37469
37470 For this reason, the recommended approach for &"mostly unprivileged"& running
37471 is to keep the Exim binary setuid to root, and to set
37472 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37473 be used in the most straightforward way.
37474
37475 If you configure Exim not to run delivery processes as root, there are a
37476 number of restrictions on what you can do:
37477
37478 .ilist
37479 You can deliver only as the Exim user/group. You should  explicitly use the
37480 &%user%& and &%group%& options to override routers or local transports that
37481 normally deliver as the recipient. This makes sure that configurations that
37482 work in this mode function the same way in normal mode. Any implicit or
37483 explicit specification of another user causes an error.
37484 .next
37485 Use of &_.forward_& files is severely restricted, such that it is usually
37486 not worthwhile to include them in the configuration.
37487 .next
37488 Users who wish to use &_.forward_& would have to make their home directory and
37489 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37490 and their equivalents in Exim filters, cannot be used. While they could be
37491 enabled in the Exim user's name, that would be insecure and not very useful.
37492 .next
37493 Unless the local user mailboxes are all owned by the Exim user (possible in
37494 some POP3 or IMAP-only environments):
37495
37496 .olist
37497 They must be owned by the Exim group and be writeable by that group. This
37498 implies you must set &%mode%& in the appendfile configuration, as well as the
37499 mode of the mailbox files themselves.
37500 .next
37501 You must set &%no_check_owner%&, since most or all of the files will not be
37502 owned by the Exim user.
37503 .next
37504 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37505 on a newly created mailbox when unprivileged. This also implies that new
37506 mailboxes need to be created manually.
37507 .endlist olist
37508 .endlist ilist
37509
37510
37511 These restrictions severely restrict what can be done in local deliveries.
37512 However, there are no restrictions on remote deliveries. If you are running a
37513 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37514 gives more security at essentially no cost.
37515
37516 If you are using the &%mua_wrapper%& facility (see chapter
37517 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37518
37519
37520
37521
37522 .section "Delivering to local files" "SECID271"
37523 Full details of the checks applied by &(appendfile)& before it writes to a file
37524 are given in chapter &<<CHAPappendfile>>&.
37525
37526
37527
37528 .section "Running local commands" "SECTsecconslocalcmds"
37529 .cindex "security" "local commands"
37530 .cindex "security" "command injection attacks"
37531 There are a number of ways in which an administrator can configure Exim to run
37532 commands based upon received, untrustworthy, data. Further, in some
37533 configurations a user who can control a &_.forward_& file can also arrange to
37534 run commands. Configuration to check includes, but is not limited to:
37535
37536 .ilist
37537 Use of &%use_shell%& in the pipe transport: various forms of shell command
37538 injection may be possible with this option present. It is dangerous and should
37539 be used only with considerable caution. Consider constraints which whitelist
37540 allowed characters in a variable which is to be used in a pipe transport that
37541 has &%use_shell%& enabled.
37542 .next
37543 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37544 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37545 &_.forward_& files in a redirect router. If Exim is running on a central mail
37546 hub to which ordinary users do not have shell access, but home directories are
37547 NFS mounted (for instance) then administrators should review the list of these
37548 forbid options available, and should bear in mind that the options that may
37549 need forbidding can change as new features are added between releases.
37550 .next
37551 The &%${run...}%& expansion item does not use a shell by default, but
37552 administrators can configure use of &_/bin/sh_& as part of the command.
37553 Such invocations should be viewed with prejudicial suspicion.
37554 .next
37555 Administrators who use embedded Perl are advised to explore how Perl's
37556 taint checking might apply to their usage.
37557 .next
37558 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37559 administrators are well advised to view its use with suspicion, in case (for
37560 instance) it allows a local-part to contain embedded Exim directives.
37561 .next
37562 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37563 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37564 each can reference arbitrary lists and files, rather than just being a list
37565 of opaque strings.
37566 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37567 real-world security vulnerabilities caused by its use with untrustworthy data
37568 injected in, for SQL injection attacks.
37569 Consider the use of the &%inlisti%& expansion condition instead.
37570 .endlist
37571
37572
37573
37574
37575 .section "Trust in configuration data" "SECTsecconfdata"
37576 .cindex "security" "data sources"
37577 .cindex "security" "regular expressions"
37578 .cindex "regular expressions" "security"
37579 .cindex "PCRE" "security"
37580 If configuration data for Exim can come from untrustworthy sources, there
37581 are some issues to be aware of:
37582
37583 .ilist
37584 Use of &%${expand...}%& may provide a path for shell injection attacks.
37585 .next
37586 Letting untrusted data provide a regular expression is unwise.
37587 .next
37588 Using &%${match...}%& to apply a fixed regular expression against untrusted
37589 data may result in pathological behaviour within PCRE.  Be aware of what
37590 "backtracking" means and consider options for being more strict with a regular
37591 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37592 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37593 possessive quantifiers or just not using regular expressions against untrusted
37594 data.
37595 .next
37596 It can be important to correctly use &%${quote:...}%&,
37597 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37598 items to ensure that data is correctly constructed.
37599 .next
37600 Some lookups might return multiple results, even though normal usage is only
37601 expected to yield one result.
37602 .endlist
37603
37604
37605
37606
37607 .section "IPv4 source routing" "SECID272"
37608 .cindex "source routing" "in IP packets"
37609 .cindex "IP source routing"
37610 Many operating systems suppress IP source-routed packets in the kernel, but
37611 some cannot be made to do this, so Exim does its own check. It logs incoming
37612 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37613 IPv6. No special checking is currently done.
37614
37615
37616
37617 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37618 Support for these SMTP commands is disabled by default. If required, they can
37619 be enabled by defining suitable ACLs.
37620
37621
37622
37623
37624 .section "Privileged users" "SECID274"
37625 .cindex "trusted users"
37626 .cindex "admin user"
37627 .cindex "privileged user"
37628 .cindex "user" "trusted"
37629 .cindex "user" "admin"
37630 Exim recognizes two sets of users with special privileges. Trusted users are
37631 able to submit new messages to Exim locally, but supply their own sender
37632 addresses and information about a sending host. For other users submitting
37633 local messages, Exim sets up the sender address from the uid, and doesn't
37634 permit a remote host to be specified.
37635
37636 .oindex "&%-f%&"
37637 However, an untrusted user is permitted to use the &%-f%& command line option
37638 in the special form &%-f <>%& to indicate that a delivery failure for the
37639 message should not cause an error report. This affects the message's envelope,
37640 but it does not affect the &'Sender:'& header. Untrusted users may also be
37641 permitted to use specific forms of address with the &%-f%& option by setting
37642 the &%untrusted_set_sender%& option.
37643
37644 Trusted users are used to run processes that receive mail messages from some
37645 other mail domain and pass them on to Exim for delivery either locally, or over
37646 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37647 as any user listed in the &%trusted_users%& configuration option, or under any
37648 group listed in the &%trusted_groups%& option.
37649
37650 Admin users are permitted to do things to the messages on Exim's queue. They
37651 can freeze or thaw messages, cause them to be returned to their senders, remove
37652 them entirely, or modify them in various ways. In addition, admin users can run
37653 the Exim monitor and see all the information it is capable of providing, which
37654 includes the contents of files on the spool.
37655
37656 .oindex "&%-M%&"
37657 .oindex "&%-q%&"
37658 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37659 delivery of messages on its queue is restricted to admin users. This
37660 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37661 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37662 queue is also restricted to admin users. This restriction can be relaxed by
37663 setting &%no_queue_list_requires_admin%&.
37664
37665 Exim recognizes an admin user if the calling process is running as root or as
37666 the Exim user or if any of the groups associated with the calling process is
37667 the Exim group. It is not necessary actually to be running under the Exim
37668 group. However, if admin users who are not root or the Exim user are to access
37669 the contents of files on the spool via the Exim monitor (which runs
37670 unprivileged), Exim must be built to allow group read access to its spool
37671 files.
37672
37673
37674
37675 .section "Spool files" "SECID275"
37676 .cindex "spool directory" "files"
37677 Exim's spool directory and everything it contains is owned by the Exim user and
37678 set to the Exim group. The mode for spool files is defined in the
37679 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37680 any user who is a member of the Exim group can access these files.
37681
37682
37683
37684 .section "Use of argv[0]" "SECID276"
37685 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37686 of specific strings, Exim assumes certain options. For example, calling Exim
37687 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37688 to calling it with the option &%-bS%&. There are no security implications in
37689 this.
37690
37691
37692
37693 .section "Use of %f formatting" "SECID277"
37694 The only use made of &"%f"& by Exim is in formatting load average values. These
37695 are actually stored in integer variables as 1000 times the load average.
37696 Consequently, their range is limited and so therefore is the length of the
37697 converted output.
37698
37699
37700
37701 .section "Embedded Exim path" "SECID278"
37702 Exim uses its own path name, which is embedded in the code, only when it needs
37703 to re-exec in order to regain root privilege. Therefore, it is not root when it
37704 does so. If some bug allowed the path to get overwritten, it would lead to an
37705 arbitrary program's being run as exim, not as root.
37706
37707
37708
37709 .section "Dynamic module directory" "SECTdynmoddir"
37710 Any dynamically loadable modules must be installed into the directory
37711 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37712 loading it.
37713
37714
37715 .section "Use of sprintf()" "SECID279"
37716 .cindex "&[sprintf()]&"
37717 A large number of occurrences of &"sprintf"& in the code are actually calls to
37718 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37719 The intermediate formatting is done into a large fixed buffer by a function
37720 that runs through the format string itself, and checks the length of each
37721 conversion before performing it, thus preventing buffer overruns.
37722
37723 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37724 the output buffer is known to be sufficiently long to contain the converted
37725 string.
37726
37727
37728
37729 .section "Use of debug_printf() and log_write()" "SECID280"
37730 Arbitrary strings are passed to both these functions, but they do their
37731 formatting by calling the function &'string_vformat()'&, which runs through
37732 the format string itself, and checks the length of each conversion.
37733
37734
37735
37736 .section "Use of strcat() and strcpy()" "SECID281"
37737 These are used only in cases where the output buffer is known to be large
37738 enough to hold the result.
37739 .ecindex IIDsecurcon
37740
37741
37742
37743
37744 . ////////////////////////////////////////////////////////////////////////////
37745 . ////////////////////////////////////////////////////////////////////////////
37746
37747 .chapter "Format of spool files" "CHAPspool"
37748 .scindex IIDforspo1 "format" "spool files"
37749 .scindex IIDforspo2 "spool directory" "format of files"
37750 .scindex IIDforspo3 "spool files" "format of"
37751 .cindex "spool files" "editing"
37752 A message on Exim's queue consists of two files, whose names are the message id
37753 followed by -D and -H, respectively. The data portion of the message is kept in
37754 the -D file on its own. The message's envelope, status, and headers are all
37755 kept in the -H file, whose format is described in this chapter. Each of these
37756 two files contains the final component of its own name as its first line. This
37757 is insurance against disk crashes where the directory is lost but the files
37758 themselves are recoverable.
37759
37760 Some people are tempted into editing -D files in order to modify messages. You
37761 need to be extremely careful if you do this; it is not recommended and you are
37762 on your own if you do it. Here are some of the pitfalls:
37763
37764 .ilist
37765 You must ensure that Exim does not try to deliver the message while you are
37766 fiddling with it. The safest way is to take out a write lock on the -D file,
37767 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37768 place, the lock will be retained. If you write a new file and rename it, the
37769 lock will be lost at the instant of rename.
37770 .next
37771 .vindex "&$body_linecount$&"
37772 If you change the number of lines in the file, the value of
37773 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37774 present, this value is not used by Exim, but there is no guarantee that this
37775 will always be the case.
37776 .next
37777 If the message is in MIME format, you must take care not to break it.
37778 .next
37779 If the message is cryptographically signed, any change will invalidate the
37780 signature.
37781 .endlist
37782 All in all, modifying -D files is fraught with danger.
37783
37784 Files whose names end with -J may also be seen in the &_input_& directory (or
37785 its subdirectories when &%split_spool_directory%& is set). These are journal
37786 files, used to record addresses to which the message has been delivered during
37787 the course of a delivery attempt. If there are still undelivered recipients at
37788 the end, the -H file is updated, and the -J file is deleted. If, however, there
37789 is some kind of crash (for example, a power outage) before this happens, the -J
37790 file remains in existence. When Exim next processes the message, it notices the
37791 -J file and uses it to update the -H file before starting the next delivery
37792 attempt.
37793
37794 .section "Format of the -H file" "SECID282"
37795 .cindex "uid (user id)" "in spool file"
37796 .cindex "gid (group id)" "in spool file"
37797 The second line of the -H file contains the login name for the uid of the
37798 process that called Exim to read the message, followed by the numerical uid and
37799 gid. For a locally generated message, this is normally the user who sent the
37800 message. For a message received over TCP/IP via the daemon, it is
37801 normally the Exim user.
37802
37803 The third line of the file contains the address of the message's sender as
37804 transmitted in the envelope, contained in angle brackets. The sender address is
37805 empty for bounce messages. For incoming SMTP mail, the sender address is given
37806 in the MAIL command. For locally generated mail, the sender address is
37807 created by Exim from the login name of the current user and the configured
37808 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37809 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37810 &"<>"& or an address that matches &%untrusted_set_senders%&.
37811
37812 The fourth line contains two numbers. The first is the time that the message
37813 was received, in the conventional Unix form &-- the number of seconds since the
37814 start of the epoch. The second number is a count of the number of messages
37815 warning of delayed delivery that have been sent to the sender.
37816
37817 There follow a number of lines starting with a hyphen. These can appear in any
37818 order, and are omitted when not relevant:
37819
37820 .vlist
37821 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37822 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37823 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37824 recognized, to provide backward compatibility. In the old format, a line of
37825 this form is present for every ACL variable that is not empty. The number
37826 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37827 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37828 the data string for the variable. The string itself starts at the beginning of
37829 the next line, and is followed by a newline character. It may contain internal
37830 newlines.
37831
37832 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37833 A line of this form is present for every ACL connection variable that is
37834 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37835 The length is the length of the data string for the variable. The string itself
37836 starts at the beginning of the next line, and is followed by a newline
37837 character. It may contain internal newlines.
37838
37839 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37840 A line of this form is present for every ACL message variable that is defined.
37841 Note that there is a space between &%-aclm%& and the rest of the name. The
37842 length is the length of the data string for the variable. The string itself
37843 starts at the beginning of the next line, and is followed by a newline
37844 character. It may contain internal newlines.
37845
37846 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37847 This is present if, when the message was received over SMTP, the value of
37848 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37849
37850 .vitem &%-allow_unqualified_recipient%&
37851 This is present if unqualified recipient addresses are permitted in header
37852 lines (to stop such addresses from being qualified if rewriting occurs at
37853 transport time). Local messages that were input using &%-bnq%& and remote
37854 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37855
37856 .vitem &%-allow_unqualified_sender%&
37857 This is present if unqualified sender addresses are permitted in header lines
37858 (to stop such addresses from being qualified if rewriting occurs at transport
37859 time). Local messages that were input using &%-bnq%& and remote messages from
37860 hosts that match &%sender_unqualified_hosts%& set this flag.
37861
37862 .vitem "&%-auth_id%&&~<&'text'&>"
37863 The id information for a message received on an authenticated SMTP connection
37864 &-- the value of the &$authenticated_id$& variable.
37865
37866 .vitem "&%-auth_sender%&&~<&'address'&>"
37867 The address of an authenticated sender &-- the value of the
37868 &$authenticated_sender$& variable.
37869
37870 .vitem "&%-body_linecount%&&~<&'number'&>"
37871 This records the number of lines in the body of the message, and is always
37872 present.
37873
37874 .vitem "&%-body_zerocount%&&~<&'number'&>"
37875 This records the number of binary zero bytes in the body of the message, and is
37876 present if the number is greater than zero.
37877
37878 .vitem &%-deliver_firsttime%&
37879 This is written when a new message is first added to the spool. When the spool
37880 file is updated after a deferral, it is omitted.
37881
37882 .vitem "&%-frozen%&&~<&'time'&>"
37883 .cindex "frozen messages" "spool data"
37884 The message is frozen, and the freezing happened at <&'time'&>.
37885
37886 .vitem "&%-helo_name%&&~<&'text'&>"
37887 This records the host name as specified by a remote host in a HELO or EHLO
37888 command.
37889
37890 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37891 This records the IP address of the host from which the message was received and
37892 the remote port number that was used. It is omitted for locally generated
37893 messages.
37894
37895 .vitem "&%-host_auth%&&~<&'text'&>"
37896 If the message was received on an authenticated SMTP connection, this records
37897 the name of the authenticator &-- the value of the
37898 &$sender_host_authenticated$& variable.
37899
37900 .vitem &%-host_lookup_failed%&
37901 This is present if an attempt to look up the sending host's name from its IP
37902 address failed. It corresponds to the &$host_lookup_failed$& variable.
37903
37904 .vitem "&%-host_name%&&~<&'text'&>"
37905 .cindex "reverse DNS lookup"
37906 .cindex "DNS" "reverse lookup"
37907 This records the name of the remote host from which the message was received,
37908 if the host name was looked up from the IP address when the message was being
37909 received. It is not present if no reverse lookup was done.
37910
37911 .vitem "&%-ident%&&~<&'text'&>"
37912 For locally submitted messages, this records the login of the originating user,
37913 unless it was a trusted user and the &%-oMt%& option was used to specify an
37914 ident value. For messages received over TCP/IP, this records the ident string
37915 supplied by the remote host, if any.
37916
37917 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37918 This records the IP address of the local interface and the port number through
37919 which a message was received from a remote host. It is omitted for locally
37920 generated messages.
37921
37922 .vitem &%-local%&
37923 The message is from a local sender.
37924
37925 .vitem &%-localerror%&
37926 The message is a locally-generated bounce message.
37927
37928 .vitem "&%-local_scan%&&~<&'string'&>"
37929 This records the data string that was returned by the &[local_scan()]& function
37930 when the message was received &-- the value of the &$local_scan_data$&
37931 variable. It is omitted if no data was returned.
37932
37933 .vitem &%-manual_thaw%&
37934 The message was frozen but has been thawed manually, that is, by an explicit
37935 Exim command rather than via the auto-thaw process.
37936
37937 .vitem &%-N%&
37938 A testing delivery process was started using the &%-N%& option to suppress any
37939 actual deliveries, but delivery was deferred. At any further delivery attempts,
37940 &%-N%& is assumed.
37941
37942 .vitem &%-received_protocol%&
37943 This records the value of the &$received_protocol$& variable, which contains
37944 the name of the protocol by which the message was received.
37945
37946 .vitem &%-sender_set_untrusted%&
37947 The envelope sender of this message was set by an untrusted local caller (used
37948 to ensure that the caller is displayed in queue listings).
37949
37950 .vitem "&%-spam_score_int%&&~<&'number'&>"
37951 If a message was scanned by SpamAssassin, this is present. It records the value
37952 of &$spam_score_int$&.
37953
37954 .vitem &%-tls_certificate_verified%&
37955 A TLS certificate was received from the client that sent this message, and the
37956 certificate was verified by the server.
37957
37958 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37959 When the message was received over an encrypted connection, this records the
37960 name of the cipher suite that was used.
37961
37962 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37963 When the message was received over an encrypted connection, and a certificate
37964 was received from the client, this records the Distinguished Name from that
37965 certificate.
37966 .endlist
37967
37968 Following the options there is a list of those addresses to which the message
37969 is not to be delivered. This set of addresses is initialized from the command
37970 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37971 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37972 the address is added to this set. The addresses are kept internally as a
37973 balanced binary tree, and it is a representation of that tree which is written
37974 to the spool file. If an address is expanded via an alias or forward file, the
37975 original address is added to the tree when deliveries to all its child
37976 addresses are complete.
37977
37978 If the tree is empty, there is a single line in the spool file containing just
37979 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37980 Y or N, followed by an address. The address is the value for the node of the
37981 tree, and the letters indicate whether the node has a left branch and/or a
37982 right branch attached to it, respectively. If branches exist, they immediately
37983 follow. Here is an example of a three-node tree:
37984 .code
37985 YY darcy@austen.fict.example
37986 NN alice@wonderland.fict.example
37987 NN editor@thesaurus.ref.example
37988 .endd
37989 After the non-recipients tree, there is a list of the message's recipients.
37990 This is a simple list, preceded by a count. It includes all the original
37991 recipients of the message, including those to whom the message has already been
37992 delivered. In the simplest case, the list contains one address per line. For
37993 example:
37994 .code
37995 4
37996 editor@thesaurus.ref.example
37997 darcy@austen.fict.example
37998 rdo@foundation
37999 alice@wonderland.fict.example
38000 .endd
38001 However, when a child address has been added to the top-level addresses as a
38002 result of the use of the &%one_time%& option on a &(redirect)& router, each
38003 line is of the following form:
38004 .display
38005 <&'top-level address'&> <&'errors_to address'&> &&&
38006   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38007 .endd
38008 The 01 flag bit indicates the presence of the three other fields that follow
38009 the top-level address. Other bits may be used in future to support additional
38010 fields. The <&'parent number'&> is the offset in the recipients list of the
38011 original parent of the &"one time"& address. The first two fields are the
38012 envelope sender that is associated with this address and its length. If the
38013 length is zero, there is no special envelope sender (there are then two space
38014 characters in the line). A non-empty field can arise from a &(redirect)& router
38015 that has an &%errors_to%& setting.
38016
38017
38018 A blank line separates the envelope and status information from the headers
38019 which follow. A header may occupy several lines of the file, and to save effort
38020 when reading it in, each header is preceded by a number and an identifying
38021 character. The number is the number of characters in the header, including any
38022 embedded newlines and the terminating newline. The character is one of the
38023 following:
38024
38025 .table2 50pt
38026 .row <&'blank'&>         "header in which Exim has no special interest"
38027 .row &`B`&               "&'Bcc:'& header"
38028 .row &`C`&               "&'Cc:'& header"
38029 .row &`F`&               "&'From:'& header"
38030 .row &`I`&               "&'Message-id:'& header"
38031 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38032 .row &`R`&               "&'Reply-To:'& header"
38033 .row &`S`&               "&'Sender:'& header"
38034 .row &`T`&               "&'To:'& header"
38035 .row &`*`&               "replaced or deleted header"
38036 .endtable
38037
38038 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38039 purposes. They are not transmitted when the message is delivered. Here is a
38040 typical set of headers:
38041 .code
38042 111P Received: by hobbit.fict.example with local (Exim 4.00)
38043 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38044 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38045 038* X-rewrote-sender: bb@hobbit.fict.example
38046 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38047 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38048 099* To: alice@wonderland.fict.example, rdo@foundation,
38049 darcy@austen.fict.example, editor@thesaurus.ref.example
38050 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38051 darcy@austen.fict.example, editor@thesaurus.ref.example
38052 038  Date: Fri, 11 May 2001 10:28:59 +0100
38053 .endd
38054 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38055 &'To:'& header have been rewritten, the last one because routing expanded the
38056 unqualified domain &'foundation'&.
38057 .ecindex IIDforspo1
38058 .ecindex IIDforspo2
38059 .ecindex IIDforspo3
38060
38061 . ////////////////////////////////////////////////////////////////////////////
38062 . ////////////////////////////////////////////////////////////////////////////
38063
38064 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38065          "DKIM Support"
38066 .cindex "DKIM"
38067
38068 DKIM is a mechanism by which messages sent by some entity can be provably
38069 linked to a domain which that entity controls.  It permits reputation to
38070 be tracked on a per-domain basis, rather than merely upon source IP address.
38071 DKIM is documented in RFC 4871.
38072
38073 .new
38074 DKIM support is compiled into Exim by default if TLS support is present.
38075 .wen
38076 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38077
38078 Exim's DKIM implementation allows to
38079 .olist
38080 Sign outgoing messages: This function is implemented in the SMTP transport.
38081 It can co-exist with all other Exim features
38082 (including transport filters)
38083 except cutthrough delivery.
38084 .next
38085 Verify signatures in incoming messages: This is implemented by an additional
38086 ACL (acl_smtp_dkim), which can be called several times per message, with
38087 different signature contexts.
38088 .endlist
38089
38090 In typical Exim style, the verification implementation does not include any
38091 default "policy". Instead it enables you to build your own policy using
38092 Exim's standard controls.
38093
38094 Please note that verification of DKIM signatures in incoming mail is turned
38095 on by default for logging purposes. For each signature in incoming email,
38096 exim will log a line displaying the most important signature details, and the
38097 signature status. Here is an example (with line-breaks added for clarity):
38098 .code
38099 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38100     d=facebookmail.com s=q1-2009b
38101     c=relaxed/relaxed a=rsa-sha1
38102     i=@facebookmail.com t=1252484542 [verification succeeded]
38103 .endd
38104 You might want to turn off DKIM verification processing entirely for internal
38105 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38106 control modifier. This should typically be done in the RCPT ACL, at points
38107 where you accept mail from relay sources (internal hosts or authenticated
38108 senders).
38109
38110
38111 .section "Signing outgoing messages" "SECDKIMSIGN"
38112 .cindex "DKIM" "signing"
38113
38114 Signing is implemented by setting private options on the SMTP transport.
38115 These options take (expandable) strings as arguments.
38116
38117 .option dkim_domain smtp string&!! unset
38118 MANDATORY:
38119 The domain you want to sign with. The result of this expanded
38120 option is put into the &%$dkim_domain%& expansion variable.
38121
38122 .option dkim_selector smtp string&!! unset
38123 MANDATORY:
38124 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38125 variable to look up a matching selector. The result is put in the expansion
38126 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38127 option along with &%$dkim_domain%&.
38128
38129 .option dkim_private_key smtp string&!! unset
38130 MANDATORY:
38131 This sets the private key to use. You can use the &%$dkim_domain%& and
38132 &%$dkim_selector%& expansion variables to determine the private key to use.
38133 The result can either
38134 .ilist
38135 be a valid RSA private key in ASCII armor, including line breaks.
38136 .next
38137 start with a slash, in which case it is treated as a file that contains
38138 the private key.
38139 .next
38140 be "0", "false" or the empty string, in which case the message will not
38141 be signed. This case will not result in an error, even if &%dkim_strict%&
38142 is set.
38143 .endlist
38144
38145 .option dkim_canon smtp string&!! unset
38146 OPTIONAL:
38147 This option sets the canonicalization method used when signing a message.
38148 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38149 The option defaults to "relaxed" when unset. Note: the current implementation
38150 only supports using the same canonicalization method for both headers and body.
38151
38152 .option dkim_strict smtp string&!! unset
38153 OPTIONAL:
38154 This  option  defines  how  Exim  behaves  when  signing a message that
38155 should be signed fails for some reason.  When the expansion evaluates to
38156 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38157 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38158 variables here.
38159
38160 .option dkim_sign_headers smtp string&!! unset
38161 OPTIONAL:
38162 When set, this option must expand to (or be specified as) a colon-separated
38163 list of header names. Headers with these names will be included in the message
38164 signature. When unspecified, the header names recommended in RFC4871 will be
38165 used.
38166
38167
38168 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38169 .cindex "DKIM" "verification"
38170
38171 Verification of DKIM signatures in incoming email is implemented via the
38172 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38173 syntactically(!) correct signature in the incoming message.
38174 A missing ACL definition defaults to accept.
38175 If any ACL call does not accept, the message is not accepted.
38176 If a cutthrough delivery was in progress for the message it is
38177 summarily dropped (having wasted the transmission effort).
38178
38179 To evaluate the signature in the ACL a large number of expansion variables
38180 containing the signature status and its details are set up during the
38181 runtime of the ACL.
38182
38183 Calling the ACL only for existing signatures is not sufficient to build
38184 more advanced policies. For that reason, the global option
38185 &%dkim_verify_signers%&, and a global expansion variable
38186 &%$dkim_signers%& exist.
38187
38188 The global option &%dkim_verify_signers%& can be set to a colon-separated
38189 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38190 called. It is expanded when the message has been received. At this point,
38191 the expansion variable &%$dkim_signers%& already contains a colon-separated
38192 list of signer domains and identities for the message. When
38193 &%dkim_verify_signers%& is not specified in the main configuration,
38194 it defaults as:
38195 .code
38196 dkim_verify_signers = $dkim_signers
38197 .endd
38198 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38199 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38200 call the ACL for known domains or identities. This would be achieved as follows:
38201 .code
38202 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38203 .endd
38204 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38205 and "ebay.com", plus all domains and identities that have signatures in the message.
38206 You can also be more creative in constructing your policy. For example:
38207 .code
38208 dkim_verify_signers = $sender_address_domain:$dkim_signers
38209 .endd
38210
38211 If a domain or identity is listed several times in the (expanded) value of
38212 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38213
38214
38215 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38216 available (from most to least important):
38217
38218
38219 .vlist
38220 .vitem &%$dkim_cur_signer%&
38221 The signer that is being evaluated in this ACL run. This can be a domain or
38222 an identity. This is one of the list items from the expanded main option
38223 &%dkim_verify_signers%& (see above).
38224 .vitem &%$dkim_verify_status%&
38225 A string describing the general status of the signature. One of
38226 .ilist
38227 &%none%&: There is no signature in the message for the current domain or
38228 identity (as reflected by &%$dkim_cur_signer%&).
38229 .next
38230 &%invalid%&: The signature could not be verified due to a processing error.
38231 More detail is available in &%$dkim_verify_reason%&.
38232 .next
38233 &%fail%&: Verification of the signature failed.  More detail is
38234 available in &%$dkim_verify_reason%&.
38235 .next
38236 &%pass%&: The signature passed verification. It is valid.
38237 .endlist
38238 .vitem &%$dkim_verify_reason%&
38239 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38240 "fail" or "invalid". One of
38241 .ilist
38242 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38243 key for the domain could not be retrieved. This may be a temporary problem.
38244 .next
38245 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38246 record for the domain is syntactically invalid.
38247 .next
38248 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38249 body hash does not match the one specified in the signature header. This
38250 means that the message body was modified in transit.
38251 .next
38252 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38253 could not be verified. This may mean that headers were modified,
38254 re-written or otherwise changed in a way which is incompatible with
38255 DKIM verification. It may of course also mean that the signature is forged.
38256 .endlist
38257 .vitem &%$dkim_domain%&
38258 The signing domain. IMPORTANT: This variable is only populated if there is
38259 an actual signature in the message for the current domain or identity (as
38260 reflected by &%$dkim_cur_signer%&).
38261 .vitem &%$dkim_identity%&
38262 The signing identity, if present. IMPORTANT: This variable is only populated
38263 if there is an actual signature in the message for the current domain or
38264 identity (as reflected by &%$dkim_cur_signer%&).
38265 .vitem &%$dkim_selector%&
38266 The key record selector string.
38267 .vitem &%$dkim_algo%&
38268 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38269 .vitem &%$dkim_canon_body%&
38270 The body canonicalization method. One of 'relaxed' or 'simple'.
38271 .vitem &%dkim_canon_headers%&
38272 The header canonicalization method. One of 'relaxed' or 'simple'.
38273 .vitem &%$dkim_copiedheaders%&
38274 A transcript of headers and their values which are included in the signature
38275 (copied from the 'z=' tag of the signature).
38276 .vitem &%$dkim_bodylength%&
38277 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38278 limit was set by the signer, "9999999999999" is returned. This makes sure
38279 that this variable always expands to an integer value.
38280 .vitem &%$dkim_created%&
38281 UNIX timestamp reflecting the date and time when the signature was created.
38282 When this was not specified by the signer, "0" is returned.
38283 .vitem &%$dkim_expires%&
38284 UNIX timestamp reflecting the date and time when the signer wants the
38285 signature to be treated as "expired". When this was not specified by the
38286 signer, "9999999999999" is returned. This makes it possible to do useful
38287 integer size comparisons against this value.
38288 .vitem &%$dkim_headernames%&
38289 A colon-separated list of names of headers included in the signature.
38290 .vitem &%$dkim_key_testing%&
38291 "1" if the key record has the "testing" flag set, "0" if not.
38292 .vitem &%$dkim_key_nosubdomains%&
38293 "1" if the key record forbids subdomaining, "0" otherwise.
38294 .vitem &%$dkim_key_srvtype%&
38295 Service type (tag s=) from the key record. Defaults to "*" if not specified
38296 in the key record.
38297 .vitem &%$dkim_key_granularity%&
38298 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38299 in the key record.
38300 .vitem &%$dkim_key_notes%&
38301 Notes from the key record (tag n=).
38302 .vitem &%$dkim_key_length%&
38303 Number of bits in the key.
38304 .endlist
38305
38306 In addition, two ACL conditions are provided:
38307
38308 .vlist
38309 .vitem &%dkim_signers%&
38310 ACL condition that checks a colon-separated list of domains or identities
38311 for a match against the domain or identity that the ACL is currently verifying
38312 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38313 verb to a group of domains or identities. For example:
38314
38315 .code
38316 # Warn when Mail purportedly from GMail has no signature at all
38317 warn log_message = GMail sender without DKIM signature
38318      sender_domains = gmail.com
38319      dkim_signers = gmail.com
38320      dkim_status = none
38321 .endd
38322
38323 .vitem &%dkim_status%&
38324 ACL condition that checks a colon-separated list of possible DKIM verification
38325 results against the actual result of verification. This is typically used
38326 to restrict an ACL verb to a list of verification outcomes, for example:
38327
38328 .code
38329 deny message = Mail from Paypal with invalid/missing signature
38330      sender_domains = paypal.com:paypal.de
38331      dkim_signers = paypal.com:paypal.de
38332      dkim_status = none:invalid:fail
38333 .endd
38334
38335 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38336 see the documentation of the &%$dkim_verify_status%& expansion variable above
38337 for more information of what they mean.
38338 .endlist
38339
38340 . ////////////////////////////////////////////////////////////////////////////
38341 . ////////////////////////////////////////////////////////////////////////////
38342
38343 .chapter "Proxies" "CHAPproxies" &&&
38344          "Proxy support"
38345 .cindex "proxy support"
38346 .cindex "proxy" "access via"
38347
38348 .new
38349 A proxy is an intermediate system through which communication is passed.
38350 Proxies may provide a security, availability or load-distribution function.
38351
38352
38353 .section "Inbound proxies" SECTproxyInbound
38354 .cindex proxy inbound
38355 .cindex proxy "server side"
38356 .cindex proxy "Proxy protocol"
38357 .cindex "Proxy protocol" proxy
38358
38359 Exim has support for receiving inbound SMTP connections via a proxy
38360 that uses &"Proxy Protocol"& to speak to it.
38361 To include this support, include &"SUPPORT_PROXY=yes"&
38362 in Local/Makefile.
38363
38364 It was built on specifications from:
38365 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38366 That URL was revised in May 2014 to version 2 spec:
38367 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38368
38369 The purpose of this facility is so that an application load balancer,
38370 such as HAProxy, can sit in front of several Exim servers
38371 to distribute load.
38372 Exim uses the local protocol communication with the proxy to obtain
38373 the remote SMTP system IP address and port information.
38374 There is no logging if a host passes or
38375 fails Proxy Protocol negotiation, but it can easily be determined and
38376 recorded in an ACL (example is below).
38377
38378 Use of a proxy is enabled by setting the &%hosts_proxy%&
38379 main configuration option to a hostlist; connections from these
38380 hosts will use Proxy Protocol.
38381
38382 The following expansion variables are usable
38383 (&"internal"& and &"external"& here refer to the interfaces
38384 of the proxy):
38385 .display
38386 &'proxy_host_address   '& internal IP address of the proxy
38387 &'proxy_host_port      '& internal TCP port of the proxy
38388 &'proxy_target_address '& external IP address of the proxy
38389 &'proxy_target_port    '& external TCP port of the proxy
38390 &'proxy_session        '& boolean: SMTP connection via proxy
38391 .endd
38392 If &$proxy_session$& is set but &$proxy_host_address$& is empty
38393 there was a protocol error.
38394
38395 Since the real connections are all coming from the proxy, and the
38396 per host connection tracking is done before Proxy Protocol is
38397 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38398 handle all of the parallel volume you expect per inbound proxy.
38399 With the option set so high, you lose the ability
38400 to protect your server from many connections from one IP.
38401 In order to prevent your server from overload, you
38402 need to add a per connection ratelimit to your connect ACL.
38403 A possible solution is:
38404 .display
38405   # Set max number of connections per host
38406   LIMIT   = 5
38407   # Or do some kind of IP lookup in a flat file or database
38408   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38409
38410   defer   message        = Too many connections from this IP right now
38411           ratelimit      = LIMIT / 5s / per_conn / strict
38412 .endd
38413
38414
38415
38416 .section "Outbound proxies" SECTproxySOCKS
38417 .cindex proxy outbound
38418 .cindex proxy "client side"
38419 .cindex proxy SOCKS
38420 .cindex SOCKS proxy
38421 Exim has support for sending outbound SMTP via a proxy
38422 using a protocol called SOCKS5 (defined by RFC1928).
38423 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38424 Local/Makefile.
38425
38426 Use of a proxy is enabled by setting the &%socks_proxy%& option
38427 on an smtp transport.
38428 The option value is expanded and should then be a list
38429 (colon-separated by default) of proxy specifiers.
38430 Each proxy specifier is a list
38431 (space-separated by default) where the initial element
38432 is an IP address and any subsequent elements are options.
38433
38434 Options are a string <name>=<value>. 
38435 The list of options is in the following table:
38436 .display
38437 &'auth   '& authentication method
38438 &'name   '& authentication username
38439 &'pass   '& authentication password
38440 &'port   '& tcp port
38441 &'tmo    '& connection timeout
38442 &'pri    '& priority
38443 &'weight '& selection bias
38444 .endd
38445
38446 More details on each of these options follows:
38447
38448 .ilist
38449 .cindex authentication "to proxy"
38450 .cindex proxy authentication
38451 &%auth%&: Either &"none"& (default) or &"name"&.
38452 Using &"name"& selects username/password authentication per RFC 1929
38453 for access to the proxy.
38454 Default is &"none"&.
38455 .next
38456 &%name%&: sets the username for the &"name"& authentication method.
38457 Default is empty.
38458 .next
38459 &%pass%&: sets the password for the &"name"& authentication method.
38460 Default is empty.
38461 .next
38462 &%port%&: the TCP port number to use for the connection to the proxy.
38463 Default is 1080.
38464 .next
38465 &%tmo%&: sets a connection timeout in seconds for this proxy.
38466 Default is 5.
38467 .next
38468 &%pri%&: specifies a priority for the proxy within the list,
38469 higher values being tried first.
38470 The default priority is 1.
38471 .next
38472 &%weight%&: specifies a selection bias.
38473 Within a priority set servers are queried in a random fashion,
38474 weighted by this value.
38475 The default value for selection bias is 1.
38476 .endlist
38477
38478 Proxies from the list are tried according to their priority
38479 and weight settings until one responds.  The timeout for the
38480 overall connection applies to the set of proxied attempts.
38481
38482 .section Logging SECTproxyLog
38483 To log the (local) IP of a proxy in the incoming or delivery logline,
38484 add &"+proxy"& to the &%log_selector%& option.
38485 This will add a component tagged with &"PRX="& to the line.
38486 .wen
38487
38488 . ////////////////////////////////////////////////////////////////////////////
38489 . ////////////////////////////////////////////////////////////////////////////
38490
38491 .chapter "Internationalisation" "CHAPi18n" &&&
38492          "Internationalisation""
38493 .cindex internationalisation "email address"
38494 .cindex EAI
38495 .cindex i18n
38496 .cindex UTF-8 "mail name handling"
38497
38498 .new
38499 Exim has support for Internationalised mail names.
38500 To include this it must be built with SUPPORT_I18N and the libidn library.
38501 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38502
38503 .section "MTA operations" SECTi18nMTA
38504 .cindex SMTPUTF8 "ESMTP option"
38505 The main configuration option &%smtputf8_advertise_hosts%& specifies
38506 a host list.  If this matches the sending host and
38507 accept_8bitmime is true (the default) then the ESMTP option
38508 SMTPUTF8 will be advertised.
38509
38510 If the sender specifies the SMTPUTF8 option on a MAIL command
38511 international handling for the message is enabled and
38512 the expansion variable &$message_smtputf8$& will have value TRUE.
38513
38514 The option &%allow_utf8_domains%& is set to true for this
38515 message. All DNS lookups are converted to a-label form
38516 whatever the setting of &%allow_utf8_domains%&
38517 when Exim is built with SUPPORT_I18N.
38518
38519 Both localparts and domain are maintained as the original
38520 UTF-8 form internally; any comparison or regular-expression use will
38521 require appropriate care.  Filenames created, eg. by
38522 the appendfile transport, will have UTF-8 names.
38523
38524 HELO names sent by the smtp transport will have any UTF-8
38525 components expanded to a-label form,
38526 and any certificate name checks will be done using the a-label
38527 form of the name.
38528
38529 .cindex log protocol
38530 .cindex SMTPUTF8 logging
38531 Log lines and Received-by: header lines will acquire a "utf8"
38532 prefix on the protocol element, eg. utf8esmtp.
38533
38534 The following expansion operator can be used:
38535 .code
38536 ${utf8_domain_to_alabel:str}
38537 ${utf8_domain_from_alabel:str}
38538 ${utf8_localpart_to_alabel:str}
38539 ${utf8_localpart_from_alabel:str}
38540 .endd
38541
38542 ACLs may use the following modifier:
38543 .display
38544 control = utf8_downconvert
38545 control = utf8_downconvert/<value>
38546 .endd
38547 This sets a flag requiring that addresses are converted to
38548 a-label form before smtp delivery, for use in a
38549 Message Submission Agent context.
38550 If a value is appended it may be:
38551 .display
38552 &`1  `& (default) mandatory downconversion
38553 &`0  `& no downconversion
38554 &`-1 `& if SMTPUTF8 not supported by destination host
38555 .endd
38556
38557 If mua_wrapper is set, the utf8_downconvert control
38558 is initially set to -1.
38559
38560
38561 There is no explicit support for VRFY and EXPN.
38562 Configurations supporting these should inspect
38563 &$smtp_command_argument$& for an SMTPUTF8 argument.
38564
38565 There is no support for LMTP on Unix sockets.
38566 Using the "lmtp" protocol option on an smtp transport,
38567 for LMTP over TCP, should work as expected.
38568
38569 There is no support for DSN unitext handling,
38570 and no provision for converting logging from or to UTF-8.
38571
38572
38573
38574 .section "MDA operations" SECTi18nMDA
38575 To aid in constructing names suitable for IMAP folders
38576 the following expansion operator can be used:
38577 .code
38578 ${imapfolder {<string>} {<sep>} {<specials>}}
38579 .endd
38580
38581 The string is converted from the charset specified by
38582 the "headers charset" command (in a filter file)
38583 or &%headers_charset%& main configuration option (otherwise),
38584 to the
38585 modified UTF-7 encoding specified by RFC 2060,
38586 with the following exception: All occurences of <sep>
38587 (which has to be a single character)
38588 are replaced with periods ("."), and all periods and slashes that are not
38589 <sep> and are not in the <specials> string are BASE64 encoded.
38590
38591 The third argument can be omitted, defaulting to an empty string.
38592 The second argument can be omitted, defaulting to "/".
38593
38594 This is the encoding used by Courier for Maildir names on disk, and followed
38595 by many other IMAP servers.
38596
38597 Examples:
38598 .display
38599 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38600 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38601 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38602 .endd
38603
38604 Note that the source charset setting is vital, and also that characters
38605 must be representable in UTF-16.
38606
38607 .wen
38608
38609 . ////////////////////////////////////////////////////////////////////////////
38610 . ////////////////////////////////////////////////////////////////////////////
38611
38612 .chapter "Events" "CHAPevents" &&&
38613          "Events"
38614 .cindex events
38615
38616 .new
38617 The events mechanism in Exim can be used to intercept processing at a number
38618 of points.  It was originally invented to giave a way to do customised logging
38619 actions (for example, to a database) but can also be used to modify some
38620 processing actions.
38621
38622 Most installations will never need to use Events.
38623 The support can be left out of a build by defining DISABLE_EVENT=yes
38624 in &_Local/Makefile_&.
38625
38626 There are two major classes of events: main and transport.
38627 The main configuration option &%event_action%& controls reception events;
38628 a transport option &%event_action%& controls delivery events.
38629
38630 Both options are a string which is expanded when the event fires.
38631 An example might look like:
38632 .cindex logging custom
38633 .code
38634 event_action = ${if eq {msg:delivery}{$event_name} \
38635 {${lookup pgsql {SELECT * FROM record_Delivery( \
38636     '${quote_pgsql:$sender_address_domain}',\
38637     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38638     '${quote_pgsql:$domain}', \
38639     '${quote_pgsql:${lc:$local_part}}', \
38640     '${quote_pgsql:$host_address}', \
38641     '${quote_pgsql:${lc:$host}}', \
38642     '${quote_pgsql:$message_exim_id}')}} \
38643 } {}}
38644 .endd
38645
38646 Events have names which correspond to the point in process at which they fire.
38647 The name is placed in the variable &$event_name$& and the event action
38648 expansion must check this, as it will be called for every possible event type.
38649
38650 The current list of events is:
38651 .display
38652 &`msg:complete           after    main       `& per message
38653 &`msg:delivery           after    transport  `& per recipient
38654 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38655 &`msg:rcpt:defer         after    transport  `& per recipient
38656 &`msg:host:defer         after    transport  `& per attempt
38657 &`msg:fail:delivery      after    main       `& per recipient
38658 &`msg:fail:internal      after    main       `& per recipient
38659 &`tcp:connect            before   transport  `& per connection
38660 &`tcp:close              after    transport  `& per connection
38661 &`tls:cert               before   both       `& per certificate in verification chain
38662 &`smtp:connect           after    transport  `& per connection
38663 .endd
38664 New event types may be added in future.
38665
38666 The event name is a colon-separated list, defining the type of
38667 event in a tree of possibilities.  It may be used as a list
38668 or just matched on as a whole.  There will be no spaces in the name.
38669
38670 The second column in the table above describes whether the event fires
38671 before or after the action is associates with.  Those which fire before
38672 can be used to affect that action (more on this below).
38673
38674 An additional variable, &$event_data$&, is filled with information varying
38675 with the event type:
38676 .display
38677 &`msg:delivery         `& smtp confirmation mssage
38678 &`msg:rcpt:host:defer  `& error string
38679 &`msg:rcpt:defer       `& error string
38680 &`msg:host:defer       `& error string
38681 &`tls:cert             `& verification chain depth
38682 &`smtp:connect         `& smtp banner
38683 .endd
38684
38685 The :defer events populate one extra variable: &$event_defer_errno$&.
38686
38687 For complex operations an ACL expansion can be used in &%event_action%&
38688 however due to the multiple contextx that Exim operates in during
38689 the course of its processing:
38690 .ilist
38691 variables set in transport events will not be visible outside that
38692 transport call
38693 .next
38694 acl_m variables in a server context are lost on a new connection,
38695 and after smtp helo/ehlo/mail/starttls/rset commands
38696 .endlist
38697 Using an ACL expansion with the logwrite modifier can be
38698 a useful way of writing to the main log.
38699
38700 The expansion of the event_action option should normally
38701 return an empty string.  Should it return anything else the
38702 following will be forced:
38703 .display
38704 &`msg:delivery     `&  (ignored)
38705 &`msg:host:defer   `&  (ignored)
38706 &`msg:fail:delivery`&  (ignored)
38707 &`tcp:connect      `&  do not connect
38708 &`tcp:close        `&  (ignored)
38709 &`tls:cert         `&  refuse verification
38710 &`smtp:connect     `&  close connection
38711 .endd
38712 No other use is made of the result string.
38713
38714 For a tcp:connect event, if the connection is being made to a proxy
38715 then the address and port variables will be that of the proxy and not
38716 the target system.
38717
38718 For tls:cert events, if GnuTLS is in use this will trigger only per
38719 chain element received on the connection.
38720 For OpenSSL it will trigger for every chain element including those
38721 loaded locally.
38722 .wen
38723
38724 . ////////////////////////////////////////////////////////////////////////////
38725 . ////////////////////////////////////////////////////////////////////////////
38726
38727 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38728          "Adding drivers or lookups"
38729 .cindex "adding drivers"
38730 .cindex "new drivers, adding"
38731 .cindex "drivers" "adding new"
38732 The following actions have to be taken in order to add a new router, transport,
38733 authenticator, or lookup type to Exim:
38734
38735 .olist
38736 Choose a name for the driver or lookup type that does not conflict with any
38737 existing name; I will use &"newdriver"& in what follows.
38738 .next
38739 Add to &_src/EDITME_& the line:
38740 .display
38741 <&'type'&>&`_NEWDRIVER=yes`&
38742 .endd
38743 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38744 code is not to be included in the binary by default, comment this line out. You
38745 should also add any relevant comments about the driver or lookup type.
38746 .next
38747 Add to &_src/config.h.defaults_& the line:
38748 .code
38749 #define <type>_NEWDRIVER
38750 .endd
38751 .next
38752 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38753 and create a table entry as is done for all the other drivers and lookup types.
38754 .next
38755 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38756 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38757 Add your &`NEWDRIVER`& to that list.
38758 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38759 simple form that most lookups have.
38760 .next
38761 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38762 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38763 driver or lookup type and add it to the definition of OBJ.
38764 .next
38765 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38766 &_src_&.
38767 .next
38768 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38769 as for other drivers and lookups.
38770 .endlist
38771
38772 Then all you need to do is write the code! A good way to start is to make a
38773 proforma by copying an existing module of the same type, globally changing all
38774 occurrences of the name, and cutting out most of the code. Note that any
38775 options you create must be listed in alphabetical order, because the tables are
38776 searched using a binary chop procedure.
38777
38778 There is a &_README_& file in each of the sub-directories of &_src_& describing
38779 the interface that is expected.
38780
38781
38782
38783
38784 . ////////////////////////////////////////////////////////////////////////////
38785 . ////////////////////////////////////////////////////////////////////////////
38786
38787 . /////////////////////////////////////////////////////////////////////////////
38788 . These lines are processing instructions for the Simple DocBook Processor that
38789 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38790 . PDFs than using xmlto and fop. They will be ignored by all other XML
38791 . processors.
38792 . /////////////////////////////////////////////////////////////////////////////
38793
38794 .literal xml
38795 <?sdop
38796   format="newpage"
38797   foot_right_recto="&chaptertitle;"
38798   foot_right_verso="&chaptertitle;"
38799 ?>
38800 .literal off
38801
38802 .makeindex "Options index"   "option"
38803 .makeindex "Variables index" "variable"
38804 .makeindex "Concept index"   "concept"
38805
38806
38807 . /////////////////////////////////////////////////////////////////////////////
38808 . /////////////////////////////////////////////////////////////////////////////